Skip to main content

Create a bank account

POST 
/payment-methods/bank-accounts

Creates a bank-account payment method. By default the bank account is owned by the authenticated account. Optionally pass account_id to create the bank account on behalf of an account you onboarded (e.g. a player your platform created); authorization is the onboarding relationship.

Request​

Body

required

    oneOf

    id uuid

    Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    Optional client-supplied id for the new payment method.

    account_id uuid

    Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    Optional. Create the bank account on behalf of an account you onboarded (e.g. a player). Defaults to the authenticated account. Authorized via the onboarding relationship.

    customer_id uuid

    Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    Optional customer to own the payment method (instead of the account).

    bank_account_holder_type stringrequired

    Possible values: [individual, business]

    Whether the account holder is a natural person or a business.

    account_holder_name stringrequired

    Full legal name on the bank account.

    bank_account_type stringrequired

    Possible values: [cash, checking, general_ledger, loan, non_resident, other, overdraft, savings]

    Bank account type. checking and savings are typical; other is the catch-all.

    bank_name stringrequired

    Name of the bank.

    currency stringrequired

    Possible values: Value must match regular expression ^[A-Z]{3}$

    ISO 4217 currency code.

    bank_country stringrequired

    Possible values: Value must match regular expression ^[A-Z]{2}$

    ISO 3166-1 alpha-2 country code.

    account_number stringrequired

    Local bank account number (e.g. US ACH). Provide this OR iban.

    iban string

    IBAN for EU/international accounts. Provide this OR account_number.

    routing_number stringnullable

    US ABA routing number (used with account_number).

    sort_code stringnullable

    UK sort code (used with account_number).

    swift_bic stringnullable

    SWIFT/BIC (used with iban for international transfers).

    same_day_credit booleannullable

    Request same-day credit (only valid for credit-capable accounts).

    billing_details

    object

    Optional holder details. The address is stored as the payment method's billing details and forwarded to providers that validate a beneficiary address (e.g. Bridge).

    address

    object

    country stringrequired

    Possible values: Value must match regular expression ^[A-Z]{2}$

    ISO 3166-1 alpha-2.

    line1 stringrequired
    line2 string
    city string
    state string
    zip string

Responses​

Bank account creation accepted. Returns the standard success envelope with no resource body.

Schema

    status string

    Possible values: [success]

    code integer

    Possible values: [200]

    message string

    Possible values: [Successful request]

Loading...