Reverse a payment initiation

POST /api/payments/v3/payment-initiations/{paymentInitiationID}/reverse

Try it

Reverse a payment initiation

cURL

curl --request POST \
  --url http://localhost/api/payments/v3/payment-initiations/{paymentInitiationID}/reverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "<string>",
  "description": "<string>",
  "amount": 123,
  "asset": "<string>",
  "metadata": {}
}
'

202

{
  "data": {
    "taskID": "<string>",
    "paymentInitiationReversalID": "<string>"
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

paymentInitiationID · string · required

The payment initiation ID

Body

application/json

reference · string · required

Required string length: 3 - 1000

description · string · required

Maximum string length: 10000

amount · integer<bigint> · required

asset · string · required

metadata · object

Show child attributes

metadata. {key} · string

Response

202

application/json

Accepted

data · object · required

Show child attributes

data. taskID · string

Since this call is asynchronous, the response will contain the ID of the task that was created to reverse the payment initiation. You can use the task API to check the status of the task and get the resulting payment ID.

data. paymentInitiationReversalID · string

Related payment initiation reversal object ID created.