API

Create Hosted Payout (US)

post
https://api.sandbox.us.yaspa.com/v2/payouts/hosted-payout/generate-link

Hosted Payouts require a signed request. You must generate an RSA 2048-bit keypair, register the public key in the Admin Dashboard, and sign requests with the private key.

US API keys are specific to each environment. Use your sandbox key with the US Sandbox server and your production key with the US Production server.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

US hosted payout request.

string
required

Merchant-assigned identifier for the user, tied to saved accounts. Must be unique to the user.

string
enum
required

Payment rail. Use INSTANT for RTP/FedNow or ACH for Same Day ACH.

Allowed:
string
required

Payment amount to two decimal places.

string
enum
required

Payment currency. Must be USD for the US Product Suite.

Allowed:
string
required

Merchant-assigned identifier for the payment. Alphanumeric, 15 characters maximum. Must be unique.

supportedCountries
array of strings

ISO 3166 country codes from which the user may select a bank. Include US.

supportedCountries
string

Where the user is redirected after a successful payout.

string

Where the user is redirected after an unsuccessful payout.

customerDetails
object
required
boolean

true enforces closed loop: only accounts previously used for pay-ins are available. false allows open loop, where new accounts may be added.

boolean

If true, the payout is queued for merchant approval before it is submitted to the bank.

string
Defaults to en

Two-character ISO 639-1 language code for the hosted journey. If unsupported or omitted, the browser language is used.

string

Optional additional metadata, echoed in webhooks and displayed in the Admin Dashboard.

string

Optional additional metadata object, echoed in webhooks.

Headers
Response

Updated about 13 hours ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain

Updated about 13 hours ago

Did this page help you?