Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The payment ID
Body
application/json
Response
No Content
API Reference v3.0
- auth.v1
- API Reference
- ledger.v1
- ledger.v2
- payments.v1
- payments.v3
- GETList all accounts
- POSTCreate a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.
- GETGet an account by ID
- GETGet account balances
- GETList all bank accounts
- POSTCreate a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.
- GETGet a Bank Account by ID
- PATCHUpdate a bank account's metadata
- POSTForward a Bank Account to a PSP for creation
- GETList all connectors
- POSTInstall a connector
- GETList all connector configurations
- DELUninstall a connector
- GETGet a connector configuration by ID
- PATCHUpdate the config of a connector
- POSTReset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.
- GETList all connector schedules
- GETGet a connector schedule by ID
- GETList all connector schedule instances
- GETList all payments
- POSTCreate a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.
- GETGet a payment by ID
- PATCHUpdate a payment's metadata
- GETList all payment initiations
- POSTInitiate a payment
- GETGet a payment initiation by ID
- DELDelete a payment initiation by ID
- POSTRetry a payment initiation
- POSTApprove a payment initiation
- POSTReject a payment initiation
- POSTReverse a payment initiation
- GETList all payment initiation adjustments
- GETList all payments related to a payment initiation
- GETList all payment service users
- POSTCreate a formance payment service user object
- GETGet a payment service user by ID
- POSTAdd a bank account to a payment service user
- POSTForward a payment service user's bank account to a connector
- GETList all pools
- POSTCreate a formance pool object
- GETGet a pool by ID
- DELDelete a pool by ID
- GETGet historical pool balances from a particular point in time
- GETGet latest pool balances
- POSTAdd an account to a pool
- DELRemove an account from a pool
- GETGet a task and its result by ID
- GET
- search.v1
- webhooks.v1
- wallets.v1
- orchestration.v1
- orchestration.v2
- reconciliation.v1
Update a payment's metadata
Copy
Ask AI
curl --request PATCH \
--url http://localhost:55001/api/payments/v3/payments/{paymentID}/metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"metadata": {}
}'Copy
Ask AI
This response does not have an example.payments.v3
Update a payment's metadata
PATCH
/
api
/
payments
/
v3
/
payments
/
{paymentID}
/
metadata
Update a payment's metadata
Copy
Ask AI
curl --request PATCH \
--url http://localhost:55001/api/payments/v3/payments/{paymentID}/metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"metadata": {}
}'Copy
Ask AI
This response does not have an example.Assistant
Responses are generated using AI and may contain mistakes.