Submit Payment Dry Run

Quotes a payment without sending it: the transaction fees you and the payee pay, the exchange rate, tax withholdings, and the
amount the payee receives.

Use it before Submit Payment to show or check the cost. Send the same feeCap and fxDifferenceCoverage you intend to submit
with. Nothing is written and nothing is reserved. The quote is not binding: the rate and fees are fixed when the payment is
sent, and change if the payee changes their payout method.

Requires the Read permission.

Errors

  • 404 NOT_FOUND: the payment does not exist in your account.
  • 422 NO_VALID_PAYMENT_METHOD: the payee has no usable payout method yet, so the payment cannot be priced. Ask the payee to add one.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the batch, as returned by Create Batch.

string
required

ID of the payment, as returned by Create Payment.

Body Params
string

The most you pay in transaction fees for each payment, as a decimal string in the payment's currency ("2.50"). Fees above the
cap are deducted from what the payee receives. Omit it to use the fee cap configured for the payout method or for your account.

string
enum

Who covers the difference when a RETURNED payment is sent again and the amount that came back is lower than the original
amount (because of exchange rates or return fees). payor: the payee receives the original amount again and you fund the
difference. payee: the amount that came back is sent. Ignored for payments that were never returned. Omit it to use your
account's setting for the payment category.

Allowed:
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