Overview

​

Create

{
  "data": {
    "attributes": {
      "amount": 25000,
      "externalPartyAccountId": "epa_019cd1798d8e5a2f8ceb96020cc3991a",
      "description": "Invoice 1042 payout"
    }
  }
}

• description is delivered to the recipient’s bank. It must be 1–140 characters from the ISO 20022 character set: letters, digits, spaces, and / - ? : ( ) . , ' +.
• Not every bank account can receive realtime credits. The external party account’s supportedRails is an advisory hint refreshed from the network. The authoritative check runs when you create the payment, and unreachable accounts are rejected there.
• A network rejection usually arrives within seconds and is terminal: the payment moves to FAILED with the network code in failure.code. Natural does not retry over another rail. To reach the account anyway, create an ACH payment.
• To send on behalf of a customer, pass customerPartyId. See Move money for a customer.

​

Lifecycle