POST
/
MoneyOut
/
captureAll
curl --request POST \
  --url https://api-sandbox.payabli.com/api/MoneyOut/captureAll \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '[
  "2-29",
  "2-28",
  "2-27"
]'
{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": [
    {
      "isSuccess": true,
      "responseText": "Success",
      "responseCode": 1,
      "responseData": {
        "authCode": null,
        "referenceId": "10-2803",
        "resultCode": 1,
        "resultText": "Captured",
        "avsResponseText": null,
        "cvvResponseText": null,
        "customerId": 421,
        "methodReferenceId": null
      },
      "pageidentifier": null
    },
    {
      "isSuccess": true,
      "responseText": "Success",
      "responseCode": 1,
      "responseData": {
        "authCode": null,
        "referenceId": "10-2804",
        "resultCode": 1,
        "resultText": "Captured",
        "avsResponseText": null,
        "cvvResponseText": null,
        "customerId": 421,
        "methodReferenceId": null
      },
      "pageidentifier": null
    }
  ]
}

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"

Body

The body is an array of referenceId for transactions to capture.

Array of identifiers of payout transactions to capture.

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

​
responseCode
integer | null

Code for the response. Learn more in API Response Codes.

Example:

1

​
responseData
object[] | null

Array of objects describing the transactions.

Was this page helpful?