Post
/v5/direct-debit/payment/{paymentId}/recall
Security
HTTP
Type bearer
Path parameters
paymentId
stringRequired
Unique identification as assigned by the Payments Hub to uniquely identify the payment submission resource.
Body parameters
object
originator
string Required
Valid values[
"BANK",
"CUST"
]
reason
string Required
Valid values[
"AM05",
"MS02",
"MS03",
"AGNT",
"CURR",
"CUST",
"CUTA",
"DUPL",
"UPAY"
]
Min length4
Max length4
ExampleMS02
recallId
string
Max length35
Responses
200
OK
object
paymentRecallId
string
payment hub ID of the recall operation
Example7e3e1fe8-f57d-348c-aa72-c6e119c7e7dd
400
{
"errors": [
{
"code": "400",
"message": "Bad Request",
"level": "error",
"description": "Error details"
}
]
}401
{
"errors": [
{
"code": "401",
"message": "Unauthorized",
"level": "error",
"description": "Error details"
}
]
}403
{
"errors": [
{
"code": "403",
"message": "Forbidden",
"level": "error",
"description": "Error details"
}
]
}404
Not Found
{
"errors": [
{
"code": "404",
"message": "Not found",
"level": "error",
"description": "Payment message ID not found"
}
]
}405
Method Not Allowed
object
500
{
"errors": [
{
"code": "500",
"message": "Internal Server Error",
"level": "error",
"description": "Error details"
}
]
}503
Service Unavailable
{
"errors": [
{
"code": "503",
"message": "Service unavailable",
"level": "error",
"description": "Service unavailable"
}
]
}