These are error codes you will generally be returned on a bad request to our API. This table gives more detail about these more meaningful response codes to help you troubleshoot issues.
| Status Code | Error_code | Description |
|---|---|---|
|
400 |
Bad Request |
The request was invalid. General errors when fulfilling the request would cause an invalid state such as spelling mistakes, erors in field/domain names, missing data etc. |
|
401 |
Unauthorized |
The request did not include an authentication token or the authentication token was expired. Your credentials are correct, however the authorization token is no longer valid. |
|
403 |
Forbidden |
You did not have permission to access the requested resource. This means that your account, or the user trying to use the API may not be approved. It is also worthwhile checking you are accessing the correct domain (sandbox or live). |
|
404 |
Not Found |
The requested resource was not found. You may be using the wrong URL endpoint. |
|
422 |
Processing Error |
The request and syntax is correct, however cannot be processed due to the wrong data or a logic error in the information being passed. Make sure that the parameters being passed for each attribute are matched correctly. |
|
429 |
Too Many Requests |
You have sent too many requests to the server and exceed our rate limits. You can read more about our rate limits in the Getting Started section of our API documentation. |
|
500 |
Internal Server Error |
This indicates an unexpected error has occurred on our server. Wait a short period and check if the action completed. If the call relates to a credit card charge you should re-query the charge to see if it completed or contact our support with details of the request and we will look into what went wrong. |
List of values accepted by the parameter ReceiptEmail. This parameter is mostly used when posting credit card charges.
| ReceiptEmail String Array |
|---|
| Controls wether an email receipt will be sent to a customer after a successful payment.
default value
On a successful payment, will perform the default email actions based on your Pay Advantage customer settings that have can be set through our portal interface. See how to change these settings here.
force_do_not_send value
Over-ride the defaults so that on a successful payment for this charge, a payment receipt will not be sent.
force_send value
Over-ride the defaults so that on a successful payment for this charge, a payment receipt will be sent.
|
List of values used by parameter FailCode. This parameter is used when viewing or searching payment records.
| FailCode String Array |
|---|
| Indicates reason for payment failure. See attached description for appropriate actions to take if this code is appended to a payment record.
invalid_bsb Bank Account Payment
Industry Code: 1
payment_stopped Bank Account Payment
Request correct BSB number from the customer. Industry Code: 2
account_closed Bank Account Payment
Customer must tell their bank to allow debits on their account from Pay Advantage (ABN 38 749 739 150, User Id 378093). Industry Code: 3
customer_deceased Bank Account Payment
Contact customer for new account details. Industry Code: 4
bad_account Bank Account Payment
Industry Code: 5
refer_to_customer Bank Account Payment
Contact customer for correct account details. Industry Code: 6
deleted Bank Account Payment
Typically insufficient funds. Contact customer and try again later. Industry Code: 7
invalid_userid Bank Account Payment
Contact customer for new account details. Industry Code: 8
techincally_invalid Bank Account Payment
Contact support. Industry Code: 9
bpay_made_in_error BPAY Payment
Customers bank account does not allow debits. Change the payment account being user. Contact support.
bpay_unauthorised BPAY Payment
Contact support.
undetermined Card Payment
Will attempt to resolve automatically.
declined Card Payment
Charge declined. Confirm card details are correct and retry. If declined error persists, they will need to contact their card-issuing bank for more details.
insufficient_funds Card Payment
Advise customer to check correct funds are in the account and try again later, otherwise can use a different card/account.
processing_error Card Payment
Charge failed due to network issue. Re-attempt the payment or try again later. If problem persists contact support.
suspected_fraud Card Payment
Card may be lost or stolen. Advise customer of error and try another card/account to process payment.
expired Card Payment
Contact customer for new card details.
refunded All
See details attached to refund payment record.
invalid_authority Chargeback
Please contact support.
cancelled_authority Chargeback
Please contact support.
unauthorised Chargeback
Please contact support.
|
List of values used by the parameter PaymentType. This parameter is used when viewing or searching payment records and card charges.
| PaymentType String Array |
|---|
| The payment method that was used to process a payment.
bpay_bank_account
BPAY payment made from a bank account.
bpay_credit_card
BPAY payment made from a credit/debit card.
direct_debit_bank_account
Direct debit payment made from a bank account.
direct_debit_credit_card
Direct debit payment made from a credit/debit card.
debit_instruction_bank_account
A batch debit payment made from a bank account.
debit_instruction_credit_card
A batch debit payment made from a credit/debit card.
realtime_credit_card
Realtime payment made by a credit/debit card.
|
List of ISO string values accepted by the parameter CountryISO, and ID integers used in the parameters PhoneCountryID, HomePhoneCountryID and MobileCountryID. These parameters are used in customer creating, updating customer details, and viewing/filtering customer records.
| Country Name | Dialling Code | CountryISO | CountryID |
|---|---|---|---|
|
Australia |
+61 |
AU |
1 |
|
New Zealand |
+64 |
NZ |
2 |
|
Afghanistan |
+93 |
AF |
3 |
|
Albania |
+355 |
AL |
4 |
|
Algeria |
+213 |
DZ |
5 |
|
American Samoa |
+1684 |
AS |
6 |
|
Andorra |
+376 |
AD |
7 |
|
Angola |
+244 |
AO |
8 |
|
Anguilla |
+1264 |
AI |
9 |
|
Antigua and Barbuda |
+1268 |
AG |
10 |
|
Antilles, Netherlands |
null |
AN |
11 |
|
Arabia, Saudi |
null |
SA |
12 |
|
Argentina |
+54 |
AR |
13 |
|
Armenia |
+374 |
AM |
14 |
|
Aruba |
+297 |
AW |
15 |
|
Austria |
+43 |
AT |
16 |
|
Azerbaijan |
+994 |
AZ |
17 |
|
Bahamas |
+1242 |
BS |
18 |
|
Bahrain |
+973 |
BH |
19 |
|
Bangladesh |
+880 |
BD |
20 |
|
Barbados |
+1246 |
BB |
21 |
|
Belarus |
+375 |
BY |
22 |
|
Belgium |
+32 |
BE |
23 |
|
Belize |
+501 |
BZ |
24 |
|
Benin |
+229 |
BJ |
25 |
|
Bermuda |
+1441 |
BM |
26 |
|
Bhutan |
+975 |
BT |
27 |
|
Bolivia |
+591 |
BO |
28 |
|
Bosnia and Herzegovina |
+387 |
BA |
29 |
|
Botswana |
+267 |
BW |
30 |
|
Bouvet Island |
null |
BV |
31 |
|
Brazil |
+55 |
BR |
32 |
|
British Virgin Islands |
+1284 |
VG |
33 |
|
Brunei Darussalam |
+673 |
BN |
34 |
|
Bulgaria |
+359 |
BG |
35 |
|
Burkina Faso |
+226 |
BF |
36 |
|
Burundi |
+257 |
BI |
37 |
|
Cambodia |
+855 |
KH |
38 |
|
Cameroon |
+237 |
CM |
39 |
|
Canada |
+1 |
CA |
40 |
|
Cape Verde |
+238 |
CV |
41 |
|
Cayman Islands |
+1345 |
KY |
42 |
|
Central African Republic |
+236 |
CF |
43 |
|
Chad |
+235 |
TD |
44 |
|
Chile |
+56 |
CL |
45 |
|
China |
+86 |
CN |
46 |
|
Christmas Island |
+61 |
CX |
47 |
|
Cocos (Keeling) Islands |
+61 |
CC |
48 |
|
Colombia |
+57 |
CO |
49 |
|
Comoros |
+269 |
KM |
50 |
|
Congo |
+242 |
CG |
51 |
|
Democratic Republic of the Congo |
+243 |
CD |
52 |
|
Cook Islands |
+682 |
CK |
53 |
|
Costa Rica |
+506 |
CR |
54 |
|
Cote D'Ivoire |
null |
CI |
55 |
|
Croatia |
+385 |
HR |
56 |
|
Cuba |
+53 |
CU |
57 |
|
Cyprus |
+357 |
CY |
58 |
|
Czech Republic |
+420 |
CZ |
59 |
|
Denmark |
+45 |
DK |
60 |
|
Djibouti |
+253 |
DJ |
61 |
|
Dominica |
+1767 |
DM |
62 |
|
Dominican Republic |
+1809 |
DO |
63 |
|
East Timor (Timor-Leste) |
null |
TP |
64 |
|
Ecuador |
+593 |
EC |
65 |
|
Egypt |
+20 |
EG |
66 |
|
El Salvador |
+503 |
SV |
67 |
|
Eritrea |
+291 |
ER |
68 |
|
Estonia |
+372 |
EE |
69 |
|
Ethiopia |
+251 |
ET |
70 |
|
European Union |
null |
EU |
71 |
|
Falkland Islands (Malvinas) |
+500 |
FK |
72 |
|
Faroe Islands |
+298 |
FO |
73 |
|
Fiji |
+679 |
FJ |
74 |
|
Finland |
+358 |
FI |
75 |
|
France |
+33 |
FR |
76 |
|
French Guiana |
null |
GF |
77 |
|
French Polynesia |
+689 |
PF |
78 |
|
Gabon |
+241 |
GA |
79 |
|
Gambia |
+220 |
GM |
80 |
|
Georgia |
+995 |
GE |
81 |
|
Germany |
+49 |
DE |
82 |
|
Ghana |
+233 |
GH |
83 |
|
Gibraltar |
+350 |
GI |
84 |
|
Greece |
+30 |
GR |
85 |
|
Greenland |
+299 |
GL |
86 |
|
Grenada |
+1473 |
GD |
87 |
|
Guadeloupe |
null |
GP |
88 |
|
Guam |
+1671 |
GU |
89 |
|
Guatemala |
+502 |
GT |
90 |
|
Guernsey and Alderney |
null |
GG |
91 |
|
Guinea |
+224 |
GN |
92 |
|
Guyana |
+592 |
GY |
93 |
|
Haiti |
+509 |
HT |
94 |
|
Honduras |
+504 |
HN |
95 |
|
Hong Kong |
+852 |
HK |
96 |
|
Hungary |
+36 |
HU |
97 |
|
Iceland |
+354 |
IS |
98 |
|
India |
+91 |
IN |
99 |
|
Indonesia |
+62 |
ID |
100 |
|
Iran |
+98 |
IR |
101 |
|
Iraq |
+964 |
IQ |
102 |
|
Ireland |
+353 |
IE |
103 |
|
Israel |
+972 |
IL |
104 |
|
Italy |
+39 |
IT |
105 |
|
Ivory Coast (Cote d'Ivoire) |
+225 |
CI |
106 |
|
Jamaica |
+1876 |
JM |
107 |
|
Japan |
+81 |
JP |
108 |
|
Jersey |
null |
JE |
109 |
|
Jordan |
+962 |
JO |
110 |
|
Kazakhstan |
+7 |
KZ |
111 |
|
Kenya |
+254 |
KE |
112 |
|
Kiribati |
+686 |
KI |
113 |
|
North Korea |
+850 |
KP |
114 |
|
South Korea |
+82 |
KR |
115 |
|
Kosovo |
+381 |
KV |
116 |
|
Kuwait |
+965 |
KW |
117 |
|
Kyrgyzstan |
+996 |
KG |
118 |
|
Laos |
+856 |
LA |
119 |
|
Latvia |
+371 |
LV |
120 |
|
Lebanon |
+961 |
LB |
121 |
|
Lesotho |
+266 |
LS |
122 |
|
Liberia |
+231 |
LR |
123 |
|
Libya |
+218 |
LY |
124 |
|
Liechtenstein |
+423 |
LI |
125 |
|
Lithuania |
+370 |
LT |
126 |
|
Luxembourg |
+352 |
LU |
127 |
|
Macau |
+853 |
MO |
128 |
|
Macedonia |
+389 |
MK |
129 |
|
Madagascar |
+261 |
MG |
130 |
|
Malawi |
+265 |
MW |
131 |
|
Malaysia |
+60 |
MY |
132 |
|
Maldives |
+960 |
MV |
133 |
|
Mali |
+223 |
ML |
134 |
|
Malta |
+356 |
MT |
135 |
|
Isle of Man |
+44 |
IM |
136 |
|
Marshall Islands |
+692 |
MH |
137 |
|
Martinique (FR) |
null |
MQ |
138 |
|
Mauritania |
+222 |
MR |
139 |
|
Mauritius |
+230 |
MU |
140 |
|
Mayotte |
+262 |
YT |
141 |
|
Mexico |
+52 |
MX |
142 |
|
Micronesia |
+691 |
FM |
143 |
|
Moldova |
+373 |
MD |
144 |
|
Monaco |
+377 |
MC |
145 |
|
Mongolia |
+976 |
MN |
146 |
|
Montenegro |
+382 |
CS |
147 |
|
Montserrat |
+1664 |
MS |
148 |
|
Morocco |
+212 |
MA |
149 |
|
Mozambique |
+258 |
MZ |
150 |
|
Myanmar (Burma) |
+95 |
MM |
151 |
|
Namibia |
+264 |
NA |
152 |
|
Nauru |
+674 |
NR |
153 |
|
Nepal |
+977 |
NP |
154 |
|
Netherlands |
+31 |
NL |
155 |
|
Netherlands Antilles |
+599 |
AN |
156 |
|
New Caledonia |
+687 |
NC |
157 |
|
Nicaragua |
+505 |
NI |
158 |
|
Niger |
+227 |
NE |
159 |
|
Nigeria |
+234 |
NG |
160 |
|
Niue |
+683 |
NU |
161 |
|
Norfolk Island |
+672 |
NF |
162 |
|
Northern Mariana Islands |
+1670 |
MP |
163 |
|
Norway |
+47 |
NO |
164 |
|
Oman |
+968 |
OM |
165 |
|
Pakistan |
+92 |
PK |
166 |
|
Palau |
+680 |
PW |
167 |
|
Palestinian Territory |
null |
PS |
168 |
|
Panama |
+507 |
PA |
169 |
|
Papua New Guinea |
+675 |
PG |
170 |
|
Paraguay |
+595 |
PY |
171 |
|
Peru |
+51 |
PE |
172 |
|
Philippines |
+63 |
PH |
173 |
|
Pitcairn Islands |
+870 |
PN |
174 |
|
Poland |
+48 |
PL |
175 |
|
Portugal |
+351 |
PT |
176 |
|
Puerto Rico |
+1 |
PR |
177 |
|
Qatar |
+974 |
QA |
178 |
|
Reunion (FR) |
null |
RE |
179 |
|
Romania |
+40 |
RO |
180 |
|
Russia |
+7 |
RU |
181 |
|
Rwanda |
+250 |
RW |
182 |
|
Sahara, Western |
null |
EH |
183 |
|
Saint Barthelemy |
+590 |
BL |
184 |
|
Saint Helena |
+290 |
SH |
185 |
|
Saint Kitts and Nevis |
+1869 |
KN |
186 |
|
Saint Lucia |
+1758 |
LC |
187 |
|
Saint Martin |
+1599 |
MF |
188 |
|
Samoa |
+685 |
WS |
189 |
|
San Marino |
+378 |
SM |
190 |
|
Sao Tome and Principe |
+239 |
ST |
191 |
|
Saudi Arabia |
+966 |
SA |
192 |
|
Senegal |
+221 |
SN |
193 |
|
Serbia |
+381 |
RS |
194 |
|
Seychelles |
+248 |
SC |
195 |
|
Sierra Leone |
+232 |
SL |
196 |
|
Singapore |
+65 |
SG |
197 |
|
Slovakia |
+421 |
SK |
198 |
|
Slovenia |
+386 |
SI |
199 |
|
Solomon Islands |
+677 |
SB |
200 |
|
Somalia |
+252 |
SO |
201 |
|
South Africa |
+27 |
ZA |
202 |
|
South Sudan |
null |
SS |
203 |
|
Spain |
+34 |
ES |
204 |
|
Sri Lanka |
+94 |
LK |
205 |
|
Sudan |
+249 |
SD |
206 |
|
Suriname |
+597 |
SR |
207 |
|
Svalbard & Jan Mayen Is. |
null |
SJ |
208 |
|
Swaziland |
+268 |
SZ |
209 |
|
Sweden |
+46 |
SE |
210 |
|
Switzerland |
+41 |
CH |
211 |
|
Syria |
+963 |
SY |
212 |
|
Taiwan |
+886 |
TW |
213 |
|
Tajikistan |
+992 |
TJ |
214 |
|
Tanzania |
+255 |
TZ |
215 |
|
Thailand |
+66 |
TH |
216 |
|
Timor-Leste (East Timor) |
+670 |
TL |
217 |
|
Togo |
+228 |
TG |
218 |
|
Tokelau |
+690 |
TK |
219 |
|
Tonga |
+676 |
TO |
220 |
|
Trinidad and Tobago |
+1868 |
TT |
221 |
|
Tunisia |
+216 |
TN |
222 |
|
Turkey |
+90 |
TR |
223 |
|
Turkmenistan |
+993 |
TM |
224 |
|
Turks and Caicos Islands |
+1649 |
TC |
225 |
|
Tuvalu |
+688 |
TV |
226 |
|
Uganda |
+256 |
UG |
227 |
|
Ukraine |
+380 |
UA |
228 |
|
United Arab Emirates |
+971 |
AE |
229 |
|
United Kingdom |
+44 |
GB |
230 |
|
United States |
+1 |
US |
231 |
|
Uruguay |
+598 |
UY |
232 |
|
Uzbekistan |
+998 |
UZ |
233 |
|
Vanuatu |
+678 |
VU |
234 |
|
Vatican City (Holy See) |
+39 |
VA |
235 |
|
Venezuela |
+58 |
VE |
236 |
|
Vietnam |
+84 |
VN |
237 |
|
Virgin Islands, British |
null |
VG |
238 |
|
Virgin Islands, U.S. |
+1340 |
VI |
239 |
|
Wallis and Futuna |
+681 |
WF |
240 |
|
Western Sahara |
null |
EH |
241 |
|
Yemen |
+967 |
YE |
242 |
|
Zambia |
+260 |
ZM |
243 |
|
Zimbabwe |
+263 |
ZW |
244 |
|
Antarctica |
+672 |
AQ |
245 |
|
British Indian Ocean Territory |
null |
IO |
246 |
|
Equatorial Guinea |
+240 |
GQ |
247 |
|
Guinea-Bissau |
+245 |
GW |
248 |
|
Saint Pierre and Miquelon |
+508 |
PM |
249 |
|
Saint Vincent and the Grenadines |
+1784 |
VC |
250 |
Comments
0 comments
Please sign in to leave a comment.