Request Payment
Use this endpoint to request payments to be made by the client.
Request a payment from the client
Request parameters
{
"externalCaseRef": "ABC123-1",
"title": "Payment on Account",
"description": "Payment on Account",
"reference": "ABC123-1/PAY001",
"amount": 123.45,
"currency": "GBP",
"credentialsId": 123,
"tagIdentifier": "Welcome Pack",
"tagRecipients": "case_handler@example.com, welcomepackteam@example.com"
}
Responses
{
"id": 91,
"externalCaseRef": "example",
"reference": "example",
"title": "example",
"description": "example",
"status": "example",
"amount": 87,
"currency": "example"
}
02 July 2026