GET
/
MoneyOut
/
capture
/
{referenceId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/MoneyOut/capture/{referenceId} \
  --header 'requestToken: <api-key>'
{
  "isSuccess": true,
  "responseText": "",
  "pageIdentifier": null,
  "responseData": {
    "ReferenceId": "45-erre-324",
    "ResultCode": 1,
    "ResultText": "Captured",
    "CustomerId": 123
  }
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Headers

idempotencyKey
string

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Example:

"6B29FC40-CA47-1067-B31D-00DD010662DA"

Path Parameters

referenceId
string
required

The ID for the payout transaction.

Example:

"B492B998-DE39-4680-BBC1-B8674C5C7A63"

Response

200
application/json
Success
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

responseData
object | null

The object containing the response data.