Release

The release operation allows you to release a reserved amount previously done through a pre authorization.

By default if you don't release or capture a pre authorization, the amount reserved will be released after 30 days.

📘
Info
You can only release an authorization or pre authorization that was not captured.

Release a payment

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

curl --request POST \
  --url https://gateway.paybyrd.com/api/v2/release/transactionId/4faa13cd-f6ff-414e-b5bd-b61d1e72e418 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"amount":"10.00"}'

{
  "sourceTransaction": {
    "releasedAmount": "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

Release a payment

📘
Info