Response Codes

In addition to standard HTTP Status Codes, all responses from the BR-DGE REST API will contain a top-level code field containing a BR-DGE Response Code to give you additional insight into what happened.

E.g.

{
  "code": 1000,
  "message": "Approved",
  "id": "4fad8e2e06a15656",
  "paymentId": "22669f90-5bf0-45df-ba8c-ea6d4235a5da"
}

HTTP Status Code: 200 OK

1006

Order completed.

1007

Order in progress.

1008

Order lapsed.

1009

Order cancelled - no future actions possible with this order.

HTTP Status Code: 201 Created

1000

Approved.

Payment or payment modification (refund, capture, void etc) was accepted by a Payment Service Provider (PSP), and will be processed in due course.

1001

Capture failed.

1003

Approved with potential risk.

1005

Order created.

HTTP Status Code: 202 Accepted

1002

Capture pending.

2001

3DS action required.

E.g.

{
  "code": 2001,
  "message": "3DS action required",
  "id": "4fad8e2e06a15656",
  "paymentId": "22669f90-5bf0-45df-ba8c-ea6d4235a5da",
  "actionRequired": true,
  "action": {
    "type": "3D_SECURE",
    "paymentId": "22669f90-5bf0-45df-ba8c-ea6d4235a5da",
    "data": {
      "clientToken": "aaabbb",
      "verifyCardPayload": "payload"
    }
  },
  "threeDSecureAction": {
    "clientToken": "aaabbb",
    "verifyCardPayload": "payload"
  }
}

Please refer to post-response actions for more information.

2002

3DS additional payment with nonce required.

2101

Pending. If an action is in the response, please see post-response actions, otherwise see callbacks.

HTTP Status Code: 400 Bad Request

2003

3DS failed.

2005

3DS not supported with card type on PSP.

2006

3DS cardholder not enrolled.

2009

3D Secure: Authentication has expired.

2010

3D Secure: Authentication was cancelled by the customer.

4000

Invalid request. You may also see Validation Errors in the response.

{
  "code": 4000,
  "message": "Request Error - The request is invalid",
  "id": "4fad8e2e06a15656",
  "validationErrors": {
    "paymentInstrument.pan": [
      "4030203 - The value entered for Pan is incorrect. It is not a valid card PAN."
    ]
  }
}

4002

3DS data missing.

4003

3DS data invalid.

4004

Payment instrument error on PSP.

4100

Merchant Account Error.

4101

Invalid merchant keys.

4102

Merchant account config error on payment processor.

4103

PayPal config error.

4104

Set up error.

4105

3DS not supported with card type.

4200

Transaction Error.

4201

Cardholder should contact issuer.

4202

Insufficient funds.

4203

Withdrawal limit exceeded.

4204

Activity limit exceeded.

4205

Expired or inactive card.

4206

Invalid credit card number.

4207

Invalid expiration date.

4208

Card not on record with PSP.

4209

No such card issuer.

4210

Invalid CVV.

4211

Voice authorisation required.

4212

Card reported as lost or stolen.

4214

Possible fraud detected.

4215

Duplicate transaction.

4216

Customer stopped billing.

4217

Card does not support this type of transaction.

4220

Surcharge not permitted.

4228

Cardholder approval needed - contact issuer.

4231

Retain card.

4232

Invalid amount.

4233

Invalid credit plan.

4234

Credit card number does not match method of payment.

4236

Refund amount error.

4239

Restriction on card.

4240

AVS failure.

4241

AVS and CVV failure.

4242

Invalid transaction data.

4243

Invalid tax amount.

4245

Processor unknown bank account.

4246

CVV required by processor.

4247

Prohibited card.

4248

Unsupported operation.

4249

Card not supported by PSP.

4250

Invalid payment details.

4251

Processor decline.

4252

Maximum retries reached.

4253

Token not recognised.

4254

Unknown or expired payment nonce.

4255

Name on card required.

4256

Merchant should contact PSP.

4257

Merchant should contact acquirer.

4258

Invalid transaction data by PSP.

4259

CVV required by PSP.

4260

High risk.

4261

On Deny list of PSP.

4262

Processor transaction status not known.

4263

Payment nonce has already been used.

4264

Currency not supported by PSP.

4265

Payment nonce not supported for merchant account on PSP.

4266

Cannot find successful transaction for operation.

4267

Transaction cannot be voided.

4268

Transaction cannot be captured.

4269

Capture amount too large.

4270

Transaction cancelled.

4271

PIN error.

4272

Allowable PIN tries exceeded.

4273

Subscription cancelled.

4274

Online PIN required.

4275

No checking account.

4276

No savings account.

4277

Declined due to PSP rules.

4278

Customer authentication required.

4279

Card not yet unblocked.

4280

Newly issued card should be used.

4281

Transaction Error: Unknown transaction failure.

4282

Card type not enabled on processor.

4283

Transaction Error: Authorization expired.

4284

Unknown decline.

4285

Do not honor.

4286

Resubmit transaction.

4287

Request Error: The limit of Card-on-File that can be associated with a single customerID has been exceeded.

4300

PayPal Error.

4301

PayPal Error: PayPal authorization error.

4302

PayPal Error: PayPal blocking duplicate order IDs.

4303

PayPal Error: PayPal buyer revoked future payment authorization.

4304

PayPal Error: PayPal payee account invalid or does not have a confirmed email.

4305

PayPal Error: Payer account is locked or closed.

4306

PayPal Error: Payer cannot pay for this transaction with PayPal.

4307

PayPal Error: Transaction refused due to PayPal risk model.

4308

PayPal Error: PayPal domestic transaction required.

4309

PayPal Error: PayPal phone number required.

4310

PayPal Error: PayPal tax info required.

4311

PayPal Error: PayPal payee blocked transaction.

4312

PayPal Error: PayPal transaction limit exceeded.

4313

PayPal Error: Currency of this transaction must match currency of your PayPal account.

4314

PayPal Error: Attempt to use an invalid email for PayPal account.

4315

PayPal Error: PayPal transaction cannot be validated - check payment details are correct.

4316

PayPal Error: Transaction failed due to configuration of PayPal business account.

4317

PayPal Error: Payee account is invalid. Verify the payee account information and try the request again.

4318

PayPal Error: Transaction could not complete because payee account is locked or closed.

4319

PayPal Error: Payee account is restricted.

4320

PayPal Error: The user account could not be validated.

4400

Invalid refund request.

4401

Cannot refund a transaction unless it is settled.

4402

Transaction already refunded in full.

4403

Refund amount too large.

4404

Refund time limit exceeded.

4405

Cannot find successful transaction for refund.

4500

Payment error. For more information query the order status endpoint

For more information on why payments can't be processed for this order, query the v1/orders/{orderId}/status endpoint.

4601

Sanctions screening rejected payout.

4619

Payout error.

4620

Payout not supported for this currency.

4621

Payouts not supported for this card type.

4622

Card not eligible for payout.

4623

Pay in reference not found.

HTTP Status Code: 403 Forbidden

4001

Access denied.

4030

Request Error: Forbidden to perform requested action on this entity.

4031

Request Error: This functionality is not enabled for the client.

5002

Incorrect auth information for PSP.

HTTP Status Code: 404 Not Found

4040

Entity not found.

HTTP Status Code: 500 Internal Server Error

5000

Server error.

5001

Unexpected error.

5004

PSP config error.

5005

No PSP strategy config for client.

5006

PSP keys config error.

5007

Not implemented.

5008

Unexpected server error.

5300

Network error.

5302

Network error all PSPs unavailable.

HTTP Status Code: 502 Bad Gateway

2004

3DS processing error.

2007

3DS cardholder enrollment error.

2008

3DS unavailable or bypassed

5003

Server error on processor.

5009

Server error on PSP.

5301

Network error on processor.

5304

Network error on PSP.

HTTP Status Code: 504 Gateway Timeout

5303

Network error on acquirer.

5305

Unknown outcome due to read timeout, please contact your processor.

Callback Response Codes

These response codes are provided while sending callbacks. They are not attributed to a HTTP Status code.

9000

Notification: Network Token has been activated.

9001

Notification: Network Token has been disabled.

9002

Notification: Network Token has been deleted.

9003

Notification: Network Token card art has been updated.

9004

Notification: Network Token metadata has been updated.

9006

Notification: Network Token provisioning has failed.