Payment
Since all money is stored in MonetaryAccounts, every transaction—whether sending or receiving—flows through them. The Payment object represents these transactions, and includes both incoming and outgoing payments. When you list a user’s payments, you’ll get the full history of both.
While you can’t control incoming payments (surprise deposits are always welcome, right?), you can create outgoing payments in a few different ways using the API:
🚀 Types of Outgoing Payments
All outgoing payments are based on the core Payment object but are handled through different endpoints depending on the type:
Single Payment A standard payment to one counterparty.
POST /user/{userId}/monetary-account/{monetaryAccountId}/paymentPayment Batch A list of payments to be sent in one go.
POST /user/{userId}/monetary-account/{monetaryAccountId}/payment-batchDraft Payment A payment that needs to be reviewed and accepted by the user.
POST /user/{userId}/monetary-account/{monetaryAccountId}/draft-paymentScheduled Payment A payment set to be sent in the future.
POST /user/{userId}/monetary-account/{monetaryAccountId}/schedule-paymentScheduled Payment Batch Multiple scheduled payments bundled together.
POST /user/{userId}/monetary-account/{monetaryAccountId}/schedule-payment-batch
🧾 What You Need to Create a Payment
To make any outgoing payment, you’ll need two things:
The amount to send
The receiver (which we call
counterparty_alias)
You can identify the receiver using one of the following pointer types:
EMAILPHONE_NUMBERIBAN
Last updated
Was this helpful?