Send pending payment
API Refs
- Staging: Send pending payment
This endpoint triggers a pending payment notification to be sent to a recipient. The recipient will receive an email with a link to choose their preferred payout method.
Branding rules:
- If the sender has no branding profiles, omit
brandingProfileId. The payment branding will benull. - If the sender has at least one branding profile,
brandingProfileIdis required. - When
brandingProfileIdis provided, it must belong to the sender and be linked to the selectedsenderBankId.
Request body
| Name | Type | Description | Required |
|---|---|---|---|
| file | binary | A file to be attached to the payment | no |
| recipientEmail | string | The email address of the recipient | yes |
| amount | number | The payment amount | yes |
| memo | string | A short description for the payment | no |
| claimNumber | string | An optional claim reference (up to 255 characters). Shown alongside the payment in the dashboard, Transaction History, and exports. | no |
| senderBankId | string | The ID of the bank to send funds from | no |
| brandingProfileId | number | Required only when the sender has at least one branding profile. It must belong to the sender and be linked to senderBankId. Use /api/public/my-info/branding-profiles to retrieve values. Omit it when the sender has no branding profiles. | conditional |
| approversEmails | array | A list of email addresses for approval | no |
Response
A successful request returns a 201 Created status code with no response body.
Updated 13 days ago
Did this page help you?