API Reference v3.0
- auth.v1
- API Reference
- ledger.v1
- ledger.v2
- payments.v1
- GETGet server info
- GETList payments
- POSTCreate a payment
- GETGet a payment
- PATCHUpdate metadata
- GETList Transfer Initiations
- POSTCreate a TransferInitiation
- GETGet a transfer initiation
- DELDelete a transfer initiation
- POSTUpdate the status of a transfer initiation
- POSTReverse a transfer initiation
- POSTRetry a failed transfer initiation
- GETList Pools
- POSTCreate a Pool
- GETGet a Pool
- DELDelete a Pool
- POSTAdd an account to a pool
- DELRemove an account from a pool
- GETGet historical pool balances at a particular point in time
- GETGet latest pool balances
- GETList accounts
- POSTCreate an account
- GETGet an account
- GETGet account balances
- GETList bank accounts created by user on Formance
- POSTCreate a BankAccount in Payments and on the PSP
- GETGet a bank account created by user on Formance
- POSTForward a bank account to a connector
- PATCHUpdate metadata of a bank account
- GETList all installed connectors
- GETList the configs of each available connector
- POSTInstall a connector
- DELUninstall a connectordeprecated
- DELUninstall a connector
- GETRead the config of a connectordeprecated
- GETRead the config of a connector
- POSTUpdate the config of a connector
- POSTReset a connectordeprecated
- POSTReset a connector
- GETList tasks from a connectordeprecated
- GETList tasks from a connector
- GETRead a specific task of the connectordeprecated
- GETRead a specific task of the connector
- POSTTransfer funds between Connector accounts
- GET
- payments.v3
- search.v1
- webhooks.v1
- wallets.v1
- orchestration.v1
- orchestration.v2
- reconciliation.v1
payments.v1
Get a payment
GET
/
api
/
payments
/
payments
/
{paymentId}
Copy
Ask AI
curl --request GET \
--url http://localhost:55001/api/payments/payments/{paymentId} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"data": {
"id": "XXX",
"reference": "<string>",
"sourceAccountID": "<string>",
"destinationAccountID": "<string>",
"connectorID": "<string>",
"provider": "STRIPE",
"type": "PAY-IN",
"status": "PENDING",
"initialAmount": 100,
"amount": 100,
"scheme": "unknown",
"asset": "USD",
"createdAt": "2023-11-07T05:31:56Z",
"raw": {},
"adjustments": [
{
"reference": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"status": "PENDING",
"amount": 100,
"raw": {}
}
],
"metadata": {}
}
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The payment ID.
Response
200
application/json
OK
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url http://localhost:55001/api/payments/payments/{paymentId} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"data": {
"id": "XXX",
"reference": "<string>",
"sourceAccountID": "<string>",
"destinationAccountID": "<string>",
"connectorID": "<string>",
"provider": "STRIPE",
"type": "PAY-IN",
"status": "PENDING",
"initialAmount": 100,
"amount": 100,
"scheme": "unknown",
"asset": "USD",
"createdAt": "2023-11-07T05:31:56Z",
"raw": {},
"adjustments": [
{
"reference": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"status": "PENDING",
"amount": 100,
"raw": {}
}
],
"metadata": {}
}
}
Assistant
Responses are generated using AI and may contain mistakes.