collectPayment
Attempt to collect a one-off payment. If an instruction type is provided and there is an existing payment instruction, the payment can be collected immediately. A request to collect a payment at a future date can also be made, in which case the instruction input type is not necessary, but an instruction must exist at the specified collection date for the payment to be collected successfully.
Arguments
Input fields for collecting a payment.
Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
mutation CollectPayment($input: CollectPaymentInput!) {
collectPayment(input: $input) {
payment {
...AccountPaymentTypeFragment
}
}
}
Variables
{
"input": CollectPaymentInput
}
Response
{
"data": {
"collectPayment": {
"payment": AccountPaymentType
}
}
}