Send pending payment

📘

API Refs

This endpoint triggers a pending payment notification to be sent to a recipient. The recipient is sent an email with a link to choose their preferred payout method. See the rules below.

Who gets the email. If no account exists yet for that email address, an invitation email is always sent. If an account exists, the email is sent only when payment emails are turned on for that insured. An insured you created through the API who has not yet signed up counts as having no account, so they get the invitation email too. You get a copy when your own payment emails are on, and a copy of an invitation is always sent. If you send approversEmails, the recipient gets their email only after every approver approves. See Which payments send emails for all the cases. See the Insured's preferences page for how to turn payment emails on or off.

Branding rules:

  • If the sender has no branding profiles, omit brandingProfileId. The payment branding will be null.
  • If the sender has at least one branding profile, brandingProfileId is required.
  • When brandingProfileId is provided, it must belong to the sender and be linked to the selected senderBankId.

Request body

NameTypeDescriptionRequired
filebinaryA file to be attached to the paymentno
recipientEmailstringThe email address of the recipientyes
amountnumberThe payment amountyes
memostringA short description for the paymentno
claimNumberstringAn optional claim reference (up to 255 characters). Shown alongside the payment in the dashboard, Transaction History, and exports.no
senderBankIdstringThe ID of the bank to send funds fromno
brandingProfileIdnumberRequired 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
approversEmailsarrayA list of email addresses for approvalno

Response

A successful request returns a 201 Created status code with no response body.


Did this page help you?