Skip to main content
POST
/
api
/
payments
/
v3
/
payment-initiations
/
{paymentInitiationID}
/
reverse
Reverse a payment initiation
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": {}
}
'
{
  "data": {
    "taskID": "<string>",
    "paymentInitiationReversalID": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

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
Pattern: ^[a-zA-Z]{3}\/[0-9]$
metadata
object

Response

Accepted

data
object
required