| Anchor | ||||
|---|---|---|---|---|
|
HTTP Response Codes
Name | Description |
|---|---|
200 OK | Everything worked as expected. |
400 Bad Request | Often due to missing a required parameter. |
401 Unauthorized | No valid API key provided. |
402 Request failed | The parameters were valid but the request failed. |
403 Forbidden | The API key doesn't have permissions to perform the request. |
404 Not Found | The requested resource doesn't exist. |
409 - Conflict | Conflicts with another request (perhaps using the same key). |
429 - Too Many Requests | Too many requests hit the API too quickly. |
500 | Something went wrong |
| Anchor | ||||
|---|---|---|---|---|
|
Generic Messages
Code | Title | Message | Notes |
201 | Success | Success | Access token is created |
201 | Success | Success | Payment Intent is created |
400 | Validation error | Api key is required | If API key is not present, the create token request will return this status |
400 | Validation error | Secret key is required | If secret key is not present, create token request will return this status |
400 | Validation error | Amount is required | If proper amount is not present, create intent request will return this status |
400 | Validation error | Return url is required | If return url is not present, create intent request will return this status |
400 | Validation error | Notification url is required | If notification url is not present, create intent request will return this status |
400 | Validation error | Payment type is required | If payment type is not present, create intent request will return this status |
400 | Validation error | Currency is required | If currency is not present, then create intent request will return this status. |
400 | Validation error | Payment Intent is required | If payment intent is not present, this status will be returned |
401 | Authorisation error | Payment Intent has expired | If the payment intent is created before 30 minutes or it has been used for one payment type already, then this status will be returned |
401 | Authorisation error | Unauthorised request | If the passed access_token in header, is invalid , then this status will be returned |
401 | Authorisation error | Access Token expired | If the access_token is created before 30 minutes, then this status will be returned |
403 | Authorisation error | Forbidden request | If Blink API status is not active in merchant account, then this status will be returned |
| Anchor | ||||
|---|---|---|---|---|
|
Credit Cards
Code | Title | Message | Notes |
200 | Captured | Payment successful | If payment is successfully processed through credit card, then this status will be returned |
200 | Accepted | Payment successful and accepted | If payment is captured and received , then this status will be returned |
400 | Validation error | Payment Token is required | If payment token is not present , creditcards request will return this status |
400 | Validation error | Device timezone is required | If 3DS authentication is enabled, device timezone is needed for Credit Cards request |
400 | Validation error | Device capabilities is required | If 3DS authentication is enabled, device capabilities is needed for Credit Cards request |
400 | Validation error | Device screen resolution is required | If 3DS authentication is enabled, device screen resolution is needed for Credit Cards request |
400 | Validation error | Device accept language is required | If 3DS authentication is enabled, device accept language is needed for Credit Cards request |
400 | Validation error | Remote address is required | If 3DS authentication is enabled, remote address is needed for Credit Cards request |
400 | Validation error | Customer name is required | If customer name is not present, this status will be returned |
400 | Validation error | Customer email is required | If customer email is not present, this status will be returned |
500 | 3DS authentication required | 3DS authentication required | If any of the 3DS related details are missing, then this status will be returned |
500 | Finished | Missing Cardcvv | If CVV details is not provided during card payment, then this status will be returned |
500 | Finished | Authentication Rejected By Issuer - Cardholder Not Enrolled In Service | If 3DS authentication is rejected , then this status will be returned |
500 | Finished | 3DS declined | If 3DS is declined while authenticating, then this status will be returned |
500 | Rejected | Payment rejected | if after capturing the payment if it’s rejected due to any issue, then this status will be returned |
| Anchor | ||||
|---|---|---|---|---|
|
Open Banking
Code | Title | Message | Notes |
200 | Success | Success | If payment is successful, then this status will be returned |
400 | Validation error | Customer name is required | If customer name is not present, this status will be returned |
400 | Validation error | Customer email is required | If customer email is not present, this status will be returned |
500 | Failed | Failed | If payment is not successful, then this status will be returned |
| Anchor | ||||
|---|---|---|---|---|
|
Direct Debit
Code | Title | Message | Notes |
200 | Pending Submission | Pending Submission | If payment is successful, then this status will be returned |
400 | Validation error | Given name is required if company name is not present | If given name is not present in the absence of company name, Direct Debits request will return this status |
400 | Validation error | Family name is required if company name is not present | Family name and given name, both are required in the absence of company name in Direct Debits request |
400 | Validation error | Company name is required if given name and family name are not present | If company name is not present along with given name and first name, Direct Debits request will return this status |
400 | Validation error | Email address is required | If email is not present, Direct Debits request will return this status |
400 | Validation error | Account holder name is required | If account holder name is not present, Direct Debits request will return this status |
400 | Validation error | Branch code is required | If branch code is not present, Direct Debits request will return this status |
400 | Validation error | Account number is required | If account number is not present, Direct Debits request will return this status |
401 | Authorisation error | Direct debit is not enabled to this merchant account | If merchant’s Gocardless account is not connected with their blink account, then this status will be returned |