4.6 Create a Payment

POST {{url}}/payments

Creates a new payment object.

This fails with a mandateisinactive error if the linked mandate is cancelled or has failed. Payments can be created against mandates with status of: pendingcustomerapproval, pending_submission, submitted, and active.

Create a Payment API Docs

HEADERS

KeyDatatypeRequiredDescription
Idempotency-Keystring

RESPONSES

status: Created

{"payments":{"id":"PM009N4WCTQKXB","created_at":"2024-03-22T21:47:25.043Z","charge_date":"2024-12-31","amount":55149,"description":"Internal payment description","currency":"GBP","status":"pending_submission","amount_refunded":0,"reference":null,"metadata":{},"fx":{"fx_currency":null,"fx_amount":null,"exchange_rate":null,"estimated_exchange_rate":null},"links":{"mandate":"MD000ZS5QMFZ2K","creditor":"CR00007SRS79RW"},"retry_if_possible":true}}