Paybyrd API

Hosted forms integration guide

  • BaseURL
    https://gateway.paybyrd.com/
  • Sample sandbox Api Key

    2970984F-6234-4D59-A340-24A6B0360334

  • Minimum TLS version accepted

    1.2

  • Sample live Api Key

    2970984F-6234-4D59-A340-24A6B0360334

Create Payment

The first step is calling the below endpoint from your server. That action will create a payment and you will get a result of that transactionId

Authorization header:

  • X-Api-Key - The Api Key that was given to you by a paybyrd representative or generated through Paybyrd's portal
*Parameters are only mandatory if Multibanco payment method is activated

Parameters explanation:

  • type - The type of transactions which in this case is "HostedForm"
  • amount - Total amount to be charged to your shopper
  • currency - Valid ISO-4217 alpha code e.g EUR
  • orderRef - Your internal reference of the order
  • *shopperIp - The IP address of your customer/shopper
  • *shopperFirstName - The first name of your customer/shopper
  • *shopperLastName - The last name of your customer/shopper
*Parameters are only mandatory if Multibanco payment method is activated

Response explanation:

  • transactionId - This is the paybyrd payment identifier. You need to keep it so you can use it later
  • type - “HostedForm”
  • amount - The total amount sent
  • currency - The currency sent
  • orderRef - The order sent
  • code - Return code from paybyrd API
  • description - Return message from paybyrd AP

POST api/v2/createPayment

  • Request Headers
  • Content-Type: text/json

Example request:


curl --location --request POST 'https://gateway.paybyrd.com/api/v2/createPayment' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: 52970984F-6234-4D59-A340-24A6B0360334' \
--data-raw '{
    "data": {
        "type": "HostedForm",
        "amount": "100.50",
        "currency": "EUR",
        "orderRef": "ABC123",
        "shopperIp": "82.141.10.5",
        "shopperFirstName": "Jane",
        "shopperLastName": "Jones"
    }
}

Example response:


{
  "data": {
    "type": "HostedForm",
    "currency": "EUR",
    "orderRef": "ABC123",
    "transactionId": "21c1b6cd-2c4d-4067-ab7f-bf7b4e66e089",
    "amount": "100.50",
    "shopperIp": "82.141.10.5",
    "shopperFirstName": "Jane",
    "shopperLastName": "Jones"
  },
  "code": "BYRD200",
  "description": "Operation successfully completed"
}

Create Payment

The first step is calling the below endpoint from your server. That action will create a payment and you will get a result of that paymentId

Parameters explanation:

  • APIKey - The Api Key that was given to you by a paybyrd representative
  • amount - Total amount to be charged to your shopper
  • currency - Valid ISO-4217 alpha code e.g EUR
  • orderRef - Your internal reference of the order
  • *shopperIp - The IP address of your customer/shopper
  • *shopperFirstName - The first name of your customer/shopper
  • *shopperLastName - The last name of your customer/shopper
*Parameters are only mandatory if Multibanco payment method is activated

Response explanation:

  • paymentId - This is the paybyrd payment identifier. You need to keep it so you can use it later
  • apiKey - The Api Key sent
  • type - “HostedForm”
  • amount - The total amount sent
  • currency - The currency sent
  • orderRef - The order sent
  • code - Return code from paybyrd API
  • description - Return message from paybyrd AP

POST api/v1/createPayment

  • Request Headers
  • Content-Type: text/json

Parameters explanation:

{
  "apiKey": "2970984F-6234-4D59-A340-24A6B0360334",
  "payment": {
     "type": "HostedForm",
     "amount": "100.50",
     "currency": "EUR",
     "orderRef": "ABC123",
     "shopperIp": "82.141.10.5",
     "shopperFirstName": "Jane",
     "shopperLastName": "Jones",
  }
}

Response sample:

{
  "apiKey": "2970984F-6234-4D59-A340-24A6B0360334",
  "payment": {
     "paymentId": "0da33326-1793-4e44-8b35-185ca79ba33b",
     "type": "HostedForm",
     "amount": "100.50",
     "currency": "EUR",
     "orderRef": "ABC123",
     "shopperIp": "82.141.10.5",
     "shopperFirstName": "Jane",
     "shopperLastName": "Jones",
  },
  "code": "BYRD200",
  "description": "Operation successfully completed"
}

Create Payment

The first step is calling the below endpoint from your server. That action will create a payment and you will get a result of that paymentId

Parameters explanation:

  • APIKey - The Api Key that was given to you by a paybyrd representative
  • amount - Total amount to be charged to your shopper
  • currency - Valid ISO-4217 alpha code e.g EUR
  • orderRef - Your internal reference of the order
  • *shopperIp - The IP address of your customer/shopper
  • *shopperFirstName - The first name of your customer/shopper
  • *shopperLastName - The last name of your customer/shopper
*Parameters are only mandatory if Multibanco payment method is activated

Response explanation:

  • paymentId - This is the paybyrd payment identifier. You need to keep it so you can use it later
  • apiKey - The Api Key sent
  • type - “HostedForm”
  • amount - The total amount sent
  • currency - The currency sent
  • orderRef - The order sent
  • code - Return code from paybyrd API
  • description - Return message from paybyrd AP

POST api/v1/createPayment

  • Request Headers
  • Content-Type: text/json

Parameters explanation:

{
  "apiKey": "2970984F-6234-4D59-A340-24A6B0360334",
  "payment": {
     "type": "HostedForm",
     "amount": "100.50",
     "currency": "EUR",
     "orderRef": "ABC123",
     "shopperIp": "82.141.10.5",
     "shopperFirstName": "Jane",
     "shopperLastName": "Jones",
  }
}

Response sample:

{
  "apiKey": "2970984F-6234-4D59-A340-24A6B0360334",
  "payment": {
     "paymentId": "0da33326-1793-4e44-8b35-185ca79ba33b",
     "type": "HostedForm",
     "amount": "100.50",
     "currency": "EUR",
     "orderRef": "ABC123",
     "shopperIp": "82.141.10.5",
     "shopperFirstName": "Jane",
     "shopperLastName": "Jones",
  },
  "code": "BYRD200",
  "description": "Operation successfully completed"
}

Create Payment

The first step is calling the below endpoint from your server. That action will create a payment and you will get a result of that paymentId

Parameters explanation:

  • APIKey - The Api Key that was given to you by a paybyrd representative
  • amount - Total amount to be charged to your shopper
  • currency - Valid ISO-4217 alpha code e.g EUR
  • orderRef - Your internal reference of the order
  • *shopperIp - The IP address of your customer/shopper
  • *shopperFirstName - The first name of your customer/shopper
  • *shopperLastName - The last name of your customer/shopper
*Parameters are only mandatory if Multibanco payment method is activated

Response explanation:

  • paymentId - This is the paybyrd payment identifier. You need to keep it so you can use it later
  • apiKey - The Api Key sent
  • type - “HostedForm”
  • amount - The total amount sent
  • currency - The currency sent
  • orderRef - The order sent
  • code - Return code from paybyrd API
  • description - Return message from paybyrd AP

POST api/v1/createPayment

  • Request Headers
  • Content-Type: text/json

Parameters explanation:

{
  "apiKey": "2970984F-6234-4D59-A340-24A6B0360334",
  "payment": {
     "type": "HostedForm",
     "amount": "100.50",
     "currency": "EUR",
     "orderRef": "ABC123",
     "shopperIp": "82.141.10.5",
     "shopperFirstName": "Jane",
     "shopperLastName": "Jones",
  }
}

Response sample:

{
  "apiKey": "2970984F-6234-4D59-A340-24A6B0360334",
  "payment": {
     "paymentId": "0da33326-1793-4e44-8b35-185ca79ba33b",
     "type": "HostedForm",
     "amount": "100.50",
     "currency": "EUR",
     "orderRef": "ABC123",
     "shopperIp": "82.141.10.5",
     "shopperFirstName": "Jane",
     "shopperLastName": "Jones",
  },
  "code": "BYRD200",
  "description": "Operation successfully completed"
}