Refund

If you want to return the funds to your shopper, you need to refund the payment.

You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.

Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as cards, iDEAL, or Klarna.

📘
Info
You can only refund a payment after it has already been captured.

Refund a payment

You can find below an example of how to refund a transaction and the generated response:

curl --request POST \
  --url https://gateway.paybyrd.com/api/v2/refund/4faa13cd-f6ff-414e-b5bd-b61d1e72e418 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: 5E37D19C-F99C-445F-8B77-1463EFC66C7B' \
  --data '{"amount":"10.00"}'

{
  "sourceTransaction": {
    "refundedAmount": "10.00",
    "remainingAmount": "0.00",
    "transactionId": "4faa13cd-f6ff-414e-b5bd-b61d1e72e418",
    "amount": "10.00"
  },
  "code": "BYRD200",
  "description": "Operation successfully completed",
  "transactionId": "c16ce479-319d-4e7b-a966-7735c34b2cc5",
  "amount": "10.00"
}

See the full API reference here.

📘Info

Refund a payment

📘
Info