Adding US to an existing integration

Yaspa's US Product Suite uses the same underlying framework as the UK/EU product suite, so existing merchants will find that much of their work already done can be extended to the US integration. The sections below list the key considerations for merchants adding the US Product Suite to an existing integration. See the rest of the US documentation for details and requirements.

Configuration

  • The base URL, Admin Dashboard, API keys and identifiers are all specific to the country and the environment. Configure your US integration to handle these attributes accordingly.
  • Static values for the pay-in API in the US:
    • "paymentGiro": "ACH"
    • "currency": "USD"
    • "supportedCountries": ["US"]
    • "journeyType": "INTELLIGENT_PAYMENT"
  • Static values for the payout API in the US:
    • "paymentGiro": "ACH" or "INSTANT"
    • "currency": "USD"
    • "supportedCountries": ["US"]

Material differences

  • The customerDetails object is mandatory for pay-ins and payouts, and is more substantial.
  • The pay-in status model and its business logic differ, because ACH is a batch process subject to returns (chargebacks).
    • New statuses:
      • FUNDS_RECEIVED (optional)
      • SETTLED (mandatory)
      • RETURNED (mandatory)
      • GUARANTEED (mandatory)
    • Handling requirements:
      • Release funds and fulfill the order on ACCEPTED.
      • Note that SETTLED is not terminal.
      • Incorporate ACH return (chargeback) data into your risk controls.
  • Payout statuses and handling are largely unchanged from the UK/EU integration, but note that payouts can be returned.
  • Yaspa provides US-specific error handling guidance for both pay-ins and payouts. See the Failure handling sections of Guaranteed Payments and Payouts.
  • Secure container requirements apply to native mobile app implementations. See the OAuth section of User Experience.
  • Migrating to webhook version 3 is strongly recommended. See Webhook Structure.

Did this page help you?