Approve Payment Requests and Pay

Approves payment requests and creates their payments in a batch, in one call.

Use it to pay requests that are PENDING_APPROVAL or already APPROVED. The requests move to APPROVED and stay there;
each request's payment appears in payments on the request.

Requires the Payment Requests permission (see List Received Payment Requests). Creating the payments needs no
other permission.

One payment per payee. All the requests in the call from the same payee are added up into one payment, so several
rows can share a paymentId. createdCount counts requests and createdPaymentCount counts payments. Requests from one
payee must share a currency (MIXED_CURRENCY_FOR_PAYEE) unless you send amountOverride.

What 200 means. The payments named by paymentId exist. A row with reservedPaymentId instead is still being
created after the response (see queuedReason); read the request later to see the payment or paymentFailure. A refused
row carries an errorCode. The payments are created in the state Create Payment leaves them: submit them yourself, or
send sendImmediately: true.

Retries are safe. Repeating the call with the same requests and batch lands on the same payments and never pays
twice. A request whose payment failed can be approved again once you fix the cause.

If the call fails as a whole (4xx), no payment was created for any request.

Errors

  • 400 INVALID_REQUEST_IDS: requestIds is missing, empty, over 50, holds a value that is not a string, or repeats an ID
  • 400 INVALID_LEDGER_ACCOUNT: ledgerAccount is missing or blank
  • 400 INVALID_BATCH: batch is missing, names both an existing batch and a new one, or is missing name or
    defaultPaymentCategory for a new batch
  • 400 INVALID_AMOUNT_OVERRIDE: amountOverride is not a number
  • 400 INVALID_FUNDING_CURRENCY: amountOverride is sent without a three-letter fundingCurrencyCode
  • 400 AMOUNT_OVERRIDE_AMBIGUOUS: amountOverride is sent for requests from more than one payee. Approve one payee at a time
  • 400 INVALID_PAYOR_MEMO, 400 INVALID_PAYEE_MEMO: the memo is not a string
  • 400 INVALID_SEND_IMMEDIATELY: sendImmediately is not a boolean
  • 400 BATCH_CREATION_FAILED: the new batch could not be created
  • 404 NOT_FOUND: batch.batchId is not one of your batches
  • 423 NOT_EDITABLE: the batch is archived
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The payment requests to approve and pay, and how to pay them.

requestIds
array of strings
required

The requests to approve: 1–50 request IDs, no duplicates. To approve one request, send one ID.

requestIds*
object
required

The batch for the payments: { "batchId": ... } for an existing batch, or the fields to create one. Not both.

string
required

ID of the ledger account the money is paid from: the same value you send as ledgerAccount on Create Payment. Its
currency must match the payment's currency.

boolean
Defaults to false

true submits each payment as soon as it is created: at once if the payee can be paid, otherwise as soon as they can.
false (default) leaves the payments in the batch for you to submit.

number

The amount to pay, as a decimal in fundingCurrencyCode (95.4 is 95.40). Use it when the requests are in a currency
your ledger account does not hold: you state what leaves the account. Requires fundingCurrencyCode, and every request
in the call must be from the same payee.

string

ISO 4217 code of amountOverride, which must be the currency of ledgerAccount. Required with amountOverride; ignored
without it. No conversion is made: a currency that does not match the ledger account is refused.

string

Your internal note on the payments. An empty or blank value is ignored.

string

The note the payee sees on the payment. When absent, empty or blank, it is taken from the request's memo or title, or
the batch name for a payment that pays several requests.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json