InitiateHostedStandalonePaymentInput
Input fields for initiating a hosted standalone payment.
The amount should always be provided in the minor unit of currency (e.g., pence not pounds, cents not dollars, etc.).
A standalone payment can be made against a specific ledger (e.g., a debt ledger) by providing the ledger number (or ledger id, please see deprecated fields).
Input fields
The account number.
The amount to be collected in the minor unit of currency.
The method by which the payment is being collected.
A description of the purpose of the payment.
The id of the specific ledger against which this payment should be applied.
Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'
- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
The number of the specific ledger against which this payment should be applied.
The URL to redirect the user to after the action was cancelled.
The URL to redirect the user to after the action resulted in an error.
The URL to redirect the user to if the url is not longer valid.
The URL to redirect the user to after the action resulted in a failure.
The URL to redirect the user to after the action was completed but the payment is still being processed.
The URL to redirect the user to after the action was completed successfuly.
Example
{
"accountNumber": "A-F8303209",
"amount": 82,
"collectionMethod": "CARD",
"description": "rule-draw-manager-long-different",
"ledgerNumber": "include-night-trade-truth-every",
"returnUrlCancel": "position-answer-author-memory-theory",
"returnUrlError": "city-she-third-find-realize",
"returnUrlExpired": "support-he-red-say-organization",
"returnUrlFailure": "task-to-whether-number-computer",
"returnUrlPending": "economy-design-now-serious-appear",
"returnUrlSuccess": "race-response-girl-middle-close"
}