Skip to main content
POST
Release the payments for a confirmed Balance Transfer session. Method creates one Payment per allocated account, from the source account to that liability account, for the allocated amount.
This endpoint requires your secret API key. Requests authenticated with an Opal token are rejected. Sessions that do not belong to your team return 404.

Behavior

  • The session must have a bt.payout_status of pending_release. Calling this endpoint before the user confirms returns BT_NO_ALLOCATIONS.
  • Method re-checks the allocations, the source account, and every destination account before any money moves. If a check fails, the request returns an error, the session stays in pending_release, and you can retry after resolving the issue.
  • Releasing is idempotent. Calling this endpoint on a released session returns the session unchanged and creates no new payments.
  • Each payment is created independently. If Method cannot create the payment for one account, that account’s entry in bt.payment_ids is null and the other payments still go out. A released session cannot be released again, so handle any null entry separately.
  • Payments use the description configured for your team. The description cannot be set in the request. Contact your CSM to set or change it.

Path Parameters

Body

Returns

Returns the updated Opal session. See Retrieve Session for the full list of fields. After a successful release, bt.payout_status is released and bt.payment_ids maps each allocated account to its Payment ID.

Errors

Errors use the INVALID_REQUEST type with one of the following sub types. An invalid source account returns the same errors as Create a Payment.