Create Hosted Pay-in (US)

post

https://api.sandbox.us.yaspa.com/v2/payins/hosted-payin/generate-link

See the Guaranteed Payments integration guide for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

US (ACH) hosted pay-in request.

customerIdentifier

string

required

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

paymentGiro

string

enum

required

Payment rail. Must be ACH for the US Product Suite.

Allowed:

amount

string

required

Payment amount to two decimal places.

currency

string

enum

required

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

Allowed:

reference

string

required

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

journeyType

string

enum

required

Hosted journey configuration. Must be INTELLIGENT_PAYMENT for the US Product Suite.

Allowed:

supportedCountries

array of strings

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

supportedCountries

successRedirectUrl

string

Where the user is redirected after a successful pay-in.

failureRedirectUrl

string

Where the user is redirected after an unsuccessful pay-in.

customerDetails

object

required

promoCode

string

Optional tag for tracing payments to promotional codes for analytics, for example Welcome200.

language

string

Defaults to en

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

searchableText

string

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

payload

string

Optional additional metadata object, echoed in webhooks.

Headers

AuthorizationCitizen

string

required

Your merchant private api key

Response

308A link for a Hosted Pay-In