Payment orders API integration blueprint

Use payment orders to send payment instructions to your partner banks, CSMs, or Swift through Mambu Payments. Mambu Payments receives payment orders, formats them, batches them if applicable, and sends them to your partner banks, CSMs, or Swift. Mambu Payments retrieves and updates payment statuses. Payment status updates are sent to your webhooks as events.

Create a payment order

API endpoint: Create payment order.

Receive payment status updates

StatusesDescription
executedThe payment has been executed by your bank / CSM
rejectedThe payment has been rejected by your bank / CSM (or by the counterparty bank for direct debits)
pendingThe payment has been frozen by your bank / CSM
returnedThe payment has been executed then returned after clearing

End-to-end payment order flow

sequenceDiagram
participant Customer
participant Numeral as Mambu Payments
participant Partner bank as Partner bank (if applicable)
participant CSM
Customer->>Customer:Receive payment request from end customer
Customer->>Customer:Control and authorise payment request
Customer->>Numeral:Send POST /payment_orders/ API request
Numeral->>Numeral:Queue payment order
Numeral->>Customer:Send event payment_order.auto_approved to webhook
Numeral->>Numeral:Batch payment order into payment pacs file
Numeral->>Customer:Send file.created event to webhook
Numeral->>Customer:Send payment_order.processing event to webhook
Numeral->>Customer:Send file.auto_approved event to webhook
Numeral->>Numeral:Encrypt and sign payment pacs file
Numeral->>Partner bank:Send payment pacs file
Numeral->>Customer:Send file.sent event to webhook
Numeral->>Customer:Send payment_order.sent event to webhook
Partner bank->>Partner bank:Control payment pacs file
Partner bank->>CSM:Send payment pacs file
Partner bank->>Numeral:Send payment status report pacs file
Numeral->>Numeral:Parse payment status report pacs file
Numeral->>Numeral:Reconcile payment status report pacs file with corresponding payment order
Numeral->>Customer:Send payment_order.executed event to webhook
Customer->>Customer:Update payment request status and notify end customer