curl --request POST \
--url https://gateway.paybyrd.com/api/v2/payment \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"type": "POS",
"isoAmount": 700,
"currency": "EUR",
"orderRef": "AMZ1962",
"terminalSerialNumber": "EMULATOR30X4X5X0",
"isPreAuth": false
}
'{
"type": "Card",
"isoAmount": 815,
"amount": "8.15",
"brand": "MASTER",
"card": {
"number": "538613******7954",
"expiration": "03/29",
"cvv": "***",
"holder": "Peter Parker"
},
"currency": "EUR",
"code": "BYRD207",
"description": "Pending redirect",
"expiresIn": 48,
"isPreAuth": true,
"orderRef": "AMZ1962",
"redirectUrl": "https://your-url.com/payment-finished",
"shopperFirstName": "Peter",
"shopperIp": "82.141.10.5",
"shopperLastName": "Parker",
"shopper": {
"firstName": "Peter",
"lastName": "Parker",
"phoneCountryCode": 351,
"phoneNumber": "935556731",
"billingAddress": "Avenida Dom João II 40",
"billingPostalCode": "1990-094",
"billingCity": "Lisboa",
"billingCountry": "PRT"
},
"terminalSerialNumber": "EMULATOR0X040506",
"transactionId": "e901d7fa-a41a-4c93-bc53-7a08cd72aff4",
"action": {
"type": "redirect",
"url": "https://link-s.paybyrd.com/3ds_om8OCbsVG"
}
}Create Payment
curl --request POST \
--url https://gateway.paybyrd.com/api/v2/payment \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"type": "POS",
"isoAmount": 700,
"currency": "EUR",
"orderRef": "AMZ1962",
"terminalSerialNumber": "EMULATOR30X4X5X0",
"isPreAuth": false
}
'{
"type": "Card",
"isoAmount": 815,
"amount": "8.15",
"brand": "MASTER",
"card": {
"number": "538613******7954",
"expiration": "03/29",
"cvv": "***",
"holder": "Peter Parker"
},
"currency": "EUR",
"code": "BYRD207",
"description": "Pending redirect",
"expiresIn": 48,
"isPreAuth": true,
"orderRef": "AMZ1962",
"redirectUrl": "https://your-url.com/payment-finished",
"shopperFirstName": "Peter",
"shopperIp": "82.141.10.5",
"shopperLastName": "Parker",
"shopper": {
"firstName": "Peter",
"lastName": "Parker",
"phoneCountryCode": 351,
"phoneNumber": "935556731",
"billingAddress": "Avenida Dom João II 40",
"billingPostalCode": "1990-094",
"billingCity": "Lisboa",
"billingCountry": "PRT"
},
"terminalSerialNumber": "EMULATOR0X040506",
"transactionId": "e901d7fa-a41a-4c93-bc53-7a08cd72aff4",
"action": {
"type": "redirect",
"url": "https://link-s.paybyrd.com/3ds_om8OCbsVG"
}
}Body
"transactionMode" is used for tokenization and tokenized payments. The value "initialUnescheduled" tokenizes details for future one-time, unscheduled payments. The value "initialRecurring' tokenizes details for the first in a series of scheduled payments. The value "cardHolderInitiatedUnescheduled" is for subsequent unscheduled payment initiated by the cardholder. The value "merchantInitiatedUnescheduled" is for unscheduled payment initiated by the merchant. The value "merchantInitiatedRecurring" is for subsequent scheduled payment initiated by the merchant.
initialUnescheduled, initialRecurring, cardHolderInitiatedUnescheduled, merchantInitiatedUnescheduled, merchantInitiatedRecurring Response
201
Represents the Paybyrd code of the web request. To see more details check in Return Codes [blocked] page.
BYRD010, BYRD200, BYRD201, BYRD203, BYRD205, BYRD206, BYRD207, BYRD208, BYRD230, BYRD231, BYRD240, BYRD290, BYRD291, BYRD292, BYRD294, BYRD299, BYRD401, BYRD403, BYRD900, BYRD901, BYRD999 "BYRD200"
Represents a textually the description of the Paybyrd code of the web request. To see more details check in Return Codes [blocked] page
Request accepted, Operation successfully completed, Payment being processed. Waiting for shopper, An error occurred while processing the payment. Please query the transaction to confirm its status, Operation rejected, Operation blocked by velocity, Pending redirect, Payment canceled by the shopper, Payment already refunded, The refund amount exceeds the remaining balance of the original payment, Token is expired, An error occurred while pre processing the transaction. Please review your request and try again, An error occurred during while preparing transaction for acquiring. Please review your request and try again, No payment methods available for this operation. Please contact Paybyrd's support, Transaction could not be updated. Please review your request and try again, Operation could not be completed. Please review your request and try again, Resource access is forbidden, Resource access unauthorized, Invalid input, Resource not found, Operation failed "Operation successfully completed"

