Estimate amount recipient receives

post

https://api.dev.payouts.com/api/v1/transfers/recipient-receives-estimate

Returns how much the end recipient will actually receive for a given redemption amount and payment method, including fees when the fee is paid by the recipient. Use to show end users the net amount they will receive.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

paymentMethod

string

enum

required

The payment method to estimate. Determines which fee logic is applied.

amount

number

required

≥ 0.01

Redemption or transfer amount (e.g. the amount the user selects, in source currency).

currency

string

enum

required

Currency of the amount (ISO 4217).

Allowed:

feePaidBy

string

enum

Defaults to BENEFICIARY

Who pays the fee: PAYER (client pays, recipient gets full amount) or BENEFICIARY (recipient pays, recipient gets amount minus fee).

Allowed:

country

string

Required for WIRE. Country code (ISO 3166-1 alpha-2).

paymentChannel

string

enum

For WIRE: SWIFT or LOCAL. Default: LOCAL.

Allowed:

commissionType

string

enum

For WIRE when paymentChannel is SWIFT: OUR or SHA.

Allowed:

clearingSystem

string

For WIRE (LOCAL), e.g. SEPA.

cryptoCurrency

string

For CRYPTO: crypto asset code (e.g. BTC, USDT). Default: USDT.

prepaidProduct

string

For GIFT_CARD and PREPAID: product code (e.g. 1800FL-US, VISA-US). Currency must be USD or CAD.

recipientReference

string

For reloadable PREPAID/GIFT_CARD products: required for correct fee (create vs reload).

action

string

enum

For RELOADABLE: ADD_FUNDS (add to existing card) or CREATE_CARD (issue new card).

Allowed:

paypalProvider

string

enum

Defaults to INTERNAL

For PAYPAL: INTERNAL or EXTERNAL. When INTERNAL, currency must be USD.

Allowed:

Responses

400

Bad Request – Invalid body (missing required field for paymentMethod, invalid enum, amount < 0.01, or unsupported currency for the method)

401

Unauthorized – Invalid or missing API key/signature

404

Not Found – No commission or product found for the given parameters

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Estimated requested amount, fee, and amount the recipient will receive