Response code reference

Return codes

The code and description fields are included in responses from all payment and transaction endpoints, including Create Payment, Capture, Refund, Release, and Query Transaction. For example:

{
  "code": "BYRD200",
  "description": "Operation successfully completed",
  "transactionId": "c16ce479-319d-4e7b-a966-7735c34b2cc5",
  "amount": "10.00"
}

Code	Description	Transaction status
BYRD010	Request accepted.	N/A
BYRD200	Operation successfully completed.	Success
BYRD201	Payment being processed. Waiting for shopper.	Processing
BYRD203	An error occurred while processing the payment. Please query the transaction to confirm its status.	TemporaryFailed
BYRD205	Operation rejected. This code is related to operation denial from the acquirer.	Denied
BYRD206	Operation blocked by velocity.	Denied
BYRD207	Pending redirect.	Processing
BYRD208	Payment canceled by the shopper.	Canceled
BYRD230	Payment already refunded.	Denied
BYRD231	The refund amount exceeds the remaining balance of the original payment.	Denied
BYRD240	Token is expired.	Error
BYRD290	An error occurred while pre-processing the transaction. Please review your request and try again.	Error
BYRD291	An error occurred while preparing the transaction for acquiring. Please review your request and try again.	Error
BYRD292	No payment methods available for this operation. Please contact Paybyrd support.	Error
BYRD294	Transaction could not be updated. Please review your request and try again.	Error
BYRD299	Operation could not be completed. Please review your request and try again.	Error
BYRD401	Resource access unauthorized.	Error
BYRD403	Resource access is forbidden.	Error
BYRD900	Invalid input.	Error
BYRD901	Resource not found.	Error
BYRD999	Operation failed. This code is related to unhandled errors.	Error

Transaction statuses

The status field at the transaction level is returned by the Create Payment endpoint (POST /api/v2/payment) and the Query Transaction endpoint (GET /api/v2/transactions/{transactionId}):

{
  "code": "BYRD200",
  "status": "Success",
  "operationType": "Payment",
  "brand": "VISA",
  "transactionId": "8cb922ee-01cd-453d-90b9-b377e4f1c3cb",
  "amount": "5.00"
}

Status	Description
Created	The transaction was created, but no payment method was selected.
Processing	Waiting for additional steps.
TemporaryFailed	An error occurred during the operation and it is not possible to confirm whether the transaction was completed.
Denied	The transaction was denied.
Success	The transaction was completed successfully.
Canceled	The transaction was canceled.
Error	An unexpected error occurred.

Order statuses

The order status field is returned by the Create Order endpoint (POST /api/v2/orders) and the Query Order endpoint (GET /api/v2/orders/{orderId}):

{
  "orderId": "e83aa1a1-152c-439e-af1e-fc4178520807",
  "status": "created",
  "code": "BYRD200",
  "description": "Operation successfully completed"
}

Status	Description
created	The order has no payments associated to it, or all payment attempts have failed.
pending	The order has a payment in progress that has not yet completed.
paid	The order has a successful payment.
canceled	The order was canceled — by the shopper, by a system routine, or via the cancel order endpoint.
expired	The order reached its expiration date without a completed payment.
refunded	The order’s payment was refunded.

Operation types

The operationType field is returned by the Query Transaction endpoint (GET /api/v2/transactions/{transactionId}):

{
  "operationType": "Payment",
  "status": "Success",
  "brand": "VISA",
  "transactionId": "8cb922ee-01cd-453d-90b9-b377e4f1c3cb",
  "amount": "5.00"
}

Operation type	Description
Payment	Regular payment.
PreAuth	Pre-authorization.
Capture	Capture of a pre-authorized amount.
Refund	Refund of a captured payment.
Chargeback	Chargeback.

Brands

The brand field is returned by the Create Payment endpoint (POST /api/v2/payment) and the Query Transaction endpoint (GET /api/v2/transactions/{transactionId}):

{
  "brand": "VISA",
  "operationType": "Payment",
  "status": "Success",
  "transactionId": "8cb922ee-01cd-453d-90b9-b377e4f1c3cb",
  "amount": "5.00"
}

Brand code
AMEX
DANKORT
DINERS
DISCOVER
ELO
FLOA1XD
FLOA3X
FLOA4X
IDEAL
JCB
MASTER
MBWAY
MULTICAIXA_REF
PAYPAL
SEPA
SIBS_MULTIBANCO
VISA
VPAY

API introduction

API reference

Response code reference

Return codes

Transaction statuses

Order statuses

Operation types

Brands

​Return codes

​Transaction statuses

​Order statuses

​Operation types

​Brands

Return codes

Transaction statuses

Order statuses

Operation types

Brands