GET
/
MoneyOut
/
cancel
/
{referenceId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/MoneyOut/cancel/{referenceId} \
  --header 'requestToken: <api-key>'
{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": {
    "responseText": "Success",
    "responseCode": 1,
    "responseData": {
      "authCode": null,
      "referenceId": "10-2806",
      "resultCode": 1,
      "resultText": "Cancelled",
      "avsResponseText": null,
      "cvvResponseText": null,
      "customerId": 3047,
      "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.

Path Parameters

​
referenceId
string
required

The ID for the payout transaction.

Example:

"B492B998-DE39-4680-BBC1-B8674C5C7A63"

Response

200
application/json
Success

The response for canceling a single payout transaction.

​
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"

​
responseData
object | null

The object containing the response data.

​
authCode
string | null

Authorization code for the transaction.

Example:

null

​
referenceId
string

The transaction identifier in Payabli.

Example:

"45-erre-324"

​
resultCode
integer

Result code for the operation. Value 1 indicates a successful operation, values 2 and 3 indicate errors. A value of 10 indicates that an operation has been initiated and is pending.

Example:

1

​
resultText
string

Text describing the result. If ResultCode = 1, will return 'Approved' or a general success message. If `ResultCode`` = 2 or 3, will contain the cause of the error or decline.

Example:

"Cancelled"

​
avsResponseText
string | null

Text code describing the result for address validation (applies only for card transactions).

​
cvvResponseText
string | null

Text code describing the result for CVV validation (applies only for card transactions).

​
customerId
integer | null

Payabli-generated unique ID of customer owner of transaction. Returns `0`` if the transaction was not assigned to an existing customer or no customer was created.

​
methodReferenceId
string | null

The stored method's identifier (sometimes referred to as 'token') in Payabli. When null, the method wasn't created, or doesn't exist, depending on the operation performed.

Example:

"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"

​
pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

Was this page helpful?