POST
/
MoneyIn
/
refund
/
{transId}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/MoneyIn/refund/{transId} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "source": "api",
  "orderId": "O-5140",
  "ipaddress": "255.255.255.255",
  "orderDescription": "Depost for materials for 123 Walnut St",
  "amount": 72.53,
  "refundDetails": {
    "categories": [
      {
        "label": "Deposit",
        "description": "Deposit for materials",
        "amount": 1000,
        "qty": 1
      }
    ],
    "splitRefunding": [
      {
        "originationEntryPoint": "41035afaa7",
        "accountId": "187-782",
        "description": "Refund for backordered product",
        "amount": 450.45
      }
    ]
  }
}'
{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": {
    "expectedSettlementDate": null,
    "authCode": "",
    "referenceId": "288-a1192b75-99e9-4d43-8af1-7ae9ab7da4f4",
    "resultCode": 1,
    "resultText": "CAPTURED",
    "avsResponseText": null,
    "cvvResponseText": null,
    "customerId": null,
    "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"

Path Parameters

​
transId
string
required

ReferenceId for the transaction (PaymentId).

Example:

"45-as456777hhhhhhhhhh77777777-324"

Body

​
source
string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100
Example:

"api"

​
orderId
string | null

Custom identifier for the transaction.

Maximum length: 250
Example:

"O-5140"

​
ipaddress
string

Recommended. The customer's IP address. This field is used to help prevent fraudulent transactions, and Payabli strongly recommends including this data.

Example:

"255.255.255.255"

​
orderDescription
string | null

Text description of the transaction.

Maximum length: 250
Example:

"Depost for materials for 123 Walnut St"

​
amount
number

Amount to refund from original transaction, minus any service fees charged on the original transaction.

The amount provided cannot be greater than the original total amount of the transaction, minus service fees. For example, if a transaction was $90 plus a $10 service fee, you can refund up to $90.

An amount equal to zero will refund the total amount authorized minus any service fee.

Example:

72.53

​
refundDetails
object

Object containing details about the refund, including line items and optional split instructions.

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"

​
responseCode
integer | null

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

Example:

1

​
pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

​
responseData
object

Was this page helpful?