ALalfredpay
Linked Accounts

List payout destinations

Changed on

Returns the customer's registered destinations. Filter on status: a destination that isn't VERIFIED will be refused at payout.

get/v1/customers/{customerId}/linked_accounts

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/customers/{customerId}/linked_accounts
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Query parameters

destinationType'BANK_ACCOUNT' | 'WALLET'

What kind of thing the money lands in. Kept separate from the rail (how it gets there) and from the provider (who carries it).

country'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY'

ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound country value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → 422 validation_error.

rail'ACH' | 'WIRE' | 'SPEI' | 'PIX' | 'COELSA' | 'FPS' | 'CHATS' | 'WALLET'

The scheme family a payment moves on. Never a country, provider or account identifier. ACH is any domestic batch bank transfer (US ACH, and the local clearing houses of COL, CHL, PER, BOL, PRY, DOM, CHN); WIRE is RTGS/SWIFT/Fedwire; SPEI, PIX, COELSA, FPS and CHATS are named instant schemes with their own semantics (COELSA is Argentina's instant transfer, deliberately not folded into ACH); WALLET is a stablecoin destination. Cash pickup is not in this release and has no rail value yet. Which rails a destination supports is derived by Alfred and returned as supportedRails[]; which (country, currency, rail) combinations are live is published by GET /v1/countries/{country}.

Destinations that support this rail.

status'PENDING' | 'VERIFIED' | 'REJECTED' | 'EXPIRED' | 'REVOKED'
limitinteger
cursorstring

Opaque. Pass next_cursor from the previous page.

Response

OK

has_moreboolean
next_cursorstring nullable

Changes