Skip to main content

Add Payment Instrument

POST 

/v2/customers/:customerId/instruments

Add Payment Instrument. The instrument is in UNVERIFIED state and can not be used for withdrawals.

Request

Path Parameters

    customerId stringrequired

Body

    instrumentType

    string

    required

    Possible values: [CARD, SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT]

    Represents the type of the instrument.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    CCI_BANK_ACCOUNTCCI Bank account
    CARDCard

    any

    externallyVerified booleandeprecated

    Is the instrument externally verified. The property is not returned by the API anymore.

    status string

    Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

    The instrument status.

    creationTime date-time

    Represents RFC 3339, section 5.6 date-time.

Responses

OK

Schema

    id string

    The instrument id

    customerId string

    The customer to which this instrument belongs.

    instrumentType

    string

    required

    Possible values: [CARD, SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT]

    Represents the type of the instrument.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    CCI_BANK_ACCOUNTCCI Bank account
    CARDCard

    any

    externallyVerified booleandeprecated

    Is the instrument externally verified. The property is not returned by the API anymore.

    status string

    Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

    The instrument status.

    creationTime date-time

    Represents RFC 3339, section 5.6 date-time.

Loading...