Sign in

v1

latestOpenAPI 3.1.02026-07-2432337285.3 KB
Payins

Refund Payment

Create a refund for a payin. Only completed payins are eligible for refunds.

A refund may still fail after being initially marked as SUCCESS; in such cases, you'll receive a callback with status = FAILED.

To simulate a failed refund in the sandbox, create a payin with amount = 101 (see the Create Payment endpoint for details).

To refund a deposit, use the Create Refund endpoint from Accounts.

post/refund/

Headers

x-company-idinteger

ID of a child company for authentication. If not provided, the parent company will be authenticated.

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Request body

payment_idstring required

Payment ID to refund

idempotency_keystring

A unique key that ensures a request is processed only once. If the same key is sent with multiple requests, the server returns the original response instead of performing the action again.

descriptionstring

Description for the refund. If supported by the rail, this will be forwarded to the end user. Only alphanumeric characters are allowed.

callback_urlstring

Callback URL to receive the refund updates

Response

Successful Response

status'success'