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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Payment ID to refund

string
length ≤ 128

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.

string
length ≤ 64

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

string

Callback URL to receive the refund updates

Headers
integer

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

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json