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 successfully - payment succeeded.

1007

Order in progress - no successful payments yet made.

1008

Order elapsed - no successful payments made.

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) (PSP), and will be processed in due course.

1001

Authorization was approved but capture failed - please issue a subsequent capture request or void request for this payment ID.

1003

Authorization was approved but flagged as a potentially risky transaction.

1005

Order created - ready for payment.

HTTP Status Code: 202 Accepted

1002

Authorization was approved but capture outcome is pending.

2001

3D Secure: Further action is required to progress payment.

E.g.

{
  "code": 2001,
  "message": "3D Secure: Further action is required to progress payment",
  "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

3D Secure: Additional payment with nonce is required to complete payment.

2101

Pending: The operation has been accepted for processing and the outcome is not yet known. If an action is in the response, please see post-response actions, otherwise see callbacks.

HTTP Status Code: 400 Bad Request

2003

3D Secure: Authentication failed.

2005

3D Secure: Card type is not supported for 3D Secure by the configured Payment Service Provider (PSP).

2006

3D Secure: Cardholder is not enrolled with 3D Secure scheme supported by Payment Service Provider (PSP).

2009

3D Secure: Authentication has expired.

2010

3D Secure: Authentication was cancelled by the customer.

4000

Request Error: The request is invalid. 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

Request Error: Data required by Payment Service Provider (PSP) for 3D Secure is missing.

4003

Request Error: Data required by Payment Service Provider (PSP) for 3D Secure is invalid.

4004

Request Error: Request Error: Could not get Payment Service Provider (PSP) recommendation for the payment instrument type.

4100

Merchant Account Error.

4101

Merchant Account Error: Invalid merchant keys.

4102

Merchant Account Error: Merchant account is configured incorrectly on the Payment Service Provider (PSP).

4103

Merchant Account Error: PayPal merchant account configuration error.

4104

Merchant Account Error: Set up error.

4105

Merchant account Error: Merchant account does not support 3D Secure transactions for this card type.

4200

Transaction Error.

4201

Transaction Error: Transaction declined by payment processor - customer will need to contact their bank for more details.

4202

Transaction Error: Insufficient funds.

4203

Transaction Error: Withdrawal limit exceeded.

4204

Transaction Error: Activity limit exceeded.

4205

Transaction Error: Expired or inactive card.

4206

Transaction Error: Invalid credit card number.

4207

Transaction Error: Invalid expiration date.

4208

Transaction Error: Card not on record with payment processor.

4209

Transaction Error: No such card issuer.

4210

Transaction Error: Invalid card verification value (CVV).

4211

Transaction Error: Voice authorisation required.

4212

Transaction Error: Transaction declined by payment processor as card reported as lost or stolen.

4214

Transaction Error: Transaction declined by payment processor as possible fraud detected.

4215

Transaction Error: Duplicate transaction.

4216

Transaction Error: Customer stopped billing.

4217

Transaction Error: The card does not support this type of transaction.

4220

Transaction Error: Surcharge not permitted.

4228

Transaction Error: The card used for this transaction requires customer approval - they will need to contact their bank.

4231

Transaction Error: The merchant is requested to retain the card.

4232

Transaction Error: Invalid amount.

4233

Transaction Error: Invalid credit plan.

4234

Transaction Error: Credit card number does not match method of payment.

4236

Transaction Error: Either the refund amount is greater than the original transaction or the card-issuing bank does not allow partial refunds.

4239

Transaction Error: Issuer or Cardholder has put a restriction on the card.

4240

Transaction Error: Address Verification failed.

4241

Transaction Error: Both the address verification system (AVS) and card verification value (CVV) checks failed for this transaction (PayPal).

4242

Transaction Error: Invalid transaction data.

4243

Transaction Error: Invalid tax amount.

4245

Transaction Error: The processor is unable to provide a definitive answer about the customer's bank account.

4246

Transaction Error: card verification value (CVV) is required.

4247

Transaction Error: Credit card number is prohibited.

4248

Transaction Error: Unsupported operation.

4249

Transaction Error: Card is not supported by payment processor.

4250

Transaction Error: Invalid payment details.

4251

Transaction Error: Payment was rejected by payment processor.

4252

Transaction Error: Maximum number of attempts to process request reached.

4253

Transaction Error: Tokenized payment instrument not found.

4254

Transaction Error: Unknown or expired payment nonce.

4255

Transaction Error: Name on card is required.

4256

Transaction Error: Merchant should contact Payment Service Provider (PSP).

4257

Transaction Error: Merchant should contact acquiring bank.

4258

Transaction Error: Transaction data was rejected by configured Payment Service Provider (PSP) as invalid.

4259

Transaction Error: card verification value (CVV) is required by configured Payment Service Provider (PSP).

4260

Transaction error: Transaction refused due to payment processor risk model.

4261

Transaction error: Transaction refused due to payment processor blacklist flag.

4262

Transaction Error: Status could not be determined at this time and the merchant should check the status with the Payment Service Provider (PSP) later.

4263

Transaction Error: Payment nonce has already been used.

4264

Transaction Error: Currency code of payment request does not match any of the supported currency codes on Payment Service Provider (PSP).

4265

Transaction Error: Payment nonce not supported for merchant account on Payment Service Provider (PSP).

4266

Transaction Error: Cannot find successful transaction for operation.

4267

Transaction Error: Transaction is not in a state in which it can be voided.

4268

Transaction Error: Transaction is not in a state in which it can be captured.

4269

Transaction Error: Capture amount is too large for this transaction.

4270

Transaction Error: Transaction was cancelled or abandoned before it could be completed.

4271

Transaction Error: PIN is incorrect, invalid, or could not be validated.

4272

Transaction Error: Invalid PIN entered too many times.

4273

Transaction Error: Customer requested to stop subscription.

4274

Transaction Error: Online or mobile PIN required.

4275

Transaction Error: Customer must have a checking account to complete the purchase.

4276

Transaction Error: Customer must have a savings account to complete the purchase.

4277

Transaction Error: Transaction rejected due to configured Payment Service Provider (PSP) rules.

4278

Transaction Error: Transaction declined as customer authentication is required.

4279

Transaction Error: Customer is a new cardholder and the card is not yet unblocked.

4280

Transaction Error: Customer has been issued with a new card and that new card should be used.

4282

Transaction Error: Card type not enabled on configured Payment Service Provider (PSP).

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

Refund Error: Invalid refund request.

4401

Refund Error: Cannot refund a transaction unless it is settled.

4402

Refund Error: Transaction has already been refunded in full.

4403

Refund Error: Refund amount is too large for this transaction.

4404

Refund Error: Refund time limit exceeded.

4405

Refund Error: Cannot find successful transaction for refund.

4500

Order Payment Error: Payments cannot be processed for this order

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

4601

Payout Error: Sanctions screening rejected error.

4619

Payout Error: Unknown error occurred during processing.

4620

Payout Error: Payouts not supported for this currency.

4621

Payout Error: Payouts not supported for this card type.

4622

Payout Error: Card not eligible for desired payout.

4623

Transaction Error: Linked pay in not found.

HTTP Status Code: 403 Forbidden

4001

Request Error: Access denied - insufficient authorities for requested action.

4030

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

4031

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

5002

Server Error: Incorrectly configured authorization information for Payment Service Provider (PSP).

HTTP Status Code: 404 Not Found

4040

Request Error: Entity not found.

HTTP Status Code: 500 Internal Server Error

5000

Server Error.

5001

Server Error: An unexpected error occurred when processing the request.

5004

Server Error: Invalid or missing Payment Service Provider (PSP) rules configuration for client.

5005

Server Error: No Payment Service Provider (PSP) strategy configuration for client.

5006

Server Error: No Payment Service Provider (PSP) keys configuration for client.

5007

Server Error: Not Implemented.

5008

Server Error: Unknown server error.

5300

Network Error.

5302

Network Error: All configured Payment Service Provider (PSP)s currently unavailable.

HTTP Status Code: 502 Bad Gateway

2004

3D Secure: Exception occurred when processing request.

2007

3D Secure: Cardholder enrollment with 3D Secure scheme could not be determined.

2008

3D Secure: Authentication was unavailable or bypassed.

5003

Server Error: Error occurred on payment processor.

5009

Server Error: Error occurred on Payment Service Provider (PSP).

5301

Network Error: payment processor unavailable.

5304

Network Error: Error communicating with Payment Service Provider (PSP).

HTTP Status Code: 504 Gateway Timeout

5303

Network Error: Payment Service Provider (PSP) timed out awaiting response from the acquiring bank.