Retrieve Payment Method

GET 
/payment-methods/:payment_method_id

Returns a single Payment Method.

Readable by the owner, an admin, or the account's onboarder (a merchant may read its individuals' payment methods; a partner its merchants'). This endpoint returns the full account number; the list endpoint exposes last4 only.

Request

Path Parameters

payment_method_id uuidrequired

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}$

Payment Method's ID

Responses

200

Payment Methods retrieved

application/json

Schema

Schema

status string

Possible values: [success]

data

object

anyOf

CardResponseFull

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}$

UUID v4

type string

Possible values: [card, bank-account, wallet, crypto-wallet]

billing_details

object

name stringnullable

Possible values: <= 255 characters

Name of the billing contact person

email emailnullable

Possible values: <= 255 characters

Email Address

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

nullable

Address of the billing contact

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

credit boolean

Specifies if the payment method can be used as a destination in charges/transfers

debit boolean

Specifies if the payment method can be used as a source in charges/transfers

business_id uuidnullable

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}$

UUID v4

customer_id uuidnullable

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}$

UUID v4

created_on Unix timestamp

Unix timestamp representing the date

card

object

expiration

object

month string

Possible values: >= 2 characters and <= 2 characters

2 digit expiration month

year string

Possible values: >= 4 characters and <= 4 characters

4 digit expiration year

brand string

last4 string

BankAccountResponseDetail

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}$

UUID v4

type string

Possible values: [card, bank-account, wallet, crypto-wallet]

billing_details

object

name stringnullable

Possible values: <= 255 characters

Name of the billing contact person

email emailnullable

Possible values: <= 255 characters

Email Address

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

nullable

Address of the billing contact

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

credit boolean

Specifies if the payment method can be used as a destination in charges/transfers

debit boolean

Specifies if the payment method can be used as a source in charges/transfers

business_id uuidnullable

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}$

UUID v4

customer_id uuidnullable

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}$

UUID v4

created_on Unix timestamp

Unix timestamp representing the date

bank-account

object

Bank instrument details. The list endpoint returns only the last 4 digits (last4) plus the routing_number. The single-resource detail endpoint (GET /payment-methods/{payment_method_id}) additionally returns the full account_number (see BankAccountResponseDetail). iban/sort_code/swift_bic sent at creation are never returned.

account_holder_name string

Full name on the bank account.

account_holder_type string

Whether the account holder is an individual or a business.

bank_country string

ISO 3166-1 alpha-2 country code of the bank.

account_type string

The bank account type (e.g. checking, savings).

bank_name string

routing_number string

US routing number, when applicable.

last4 string

Last 4 digits of the account number/IBAN. The full identifier is never returned.

same_day_credit boolean

Specifies is the bank account is a same day credit account

currency string

ISO 4217 currency code of the account.

account_number string

Full bank account number. Returned only by this single-resource detail endpoint; the list endpoint (GET /payment-methods) returns last4 only. For a virtual account this is the deposit account number to fund via ACH.

WalletResponseFull

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}$

UUID v4

type string

Possible values: [card, bank-account, wallet, crypto-wallet]

billing_details

object

name stringnullable

Possible values: <= 255 characters

Name of the billing contact person

email emailnullable

Possible values: <= 255 characters

Email Address

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

nullable

Address of the billing contact

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

credit boolean

Specifies if the payment method can be used as a destination in charges/transfers

debit boolean

Specifies if the payment method can be used as a source in charges/transfers

business_id uuidnullable

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}$

UUID v4

customer_id uuidnullable

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}$

UUID v4

created_on Unix timestamp

Unix timestamp representing the date

wallet

object

available_balance

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

CryptoWalletResponseFull

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}$

UUID v4

type string

Possible values: [card, bank-account, wallet, crypto-wallet]

billing_details

object

name stringnullable

Possible values: <= 255 characters

Name of the billing contact person

email emailnullable

Possible values: <= 255 characters

Email Address

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

nullable

Address of the billing contact

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

credit boolean

Specifies if the payment method can be used as a destination in charges/transfers

debit boolean

Specifies if the payment method can be used as a source in charges/transfers

business_id uuidnullable

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}$

UUID v4

customer_id uuidnullable

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}$

UUID v4

created_on Unix timestamp

Unix timestamp representing the date

crypto-wallet

object

currency string

Crypto currency code following the CHAIN-TOKEN convention (e.g. BASE-USDC).

on_chain_address stringnullable

On-chain deposit address assigned once the wallet is provisioned. null until provisioning completes.

source string

Possible values: [provisioned, external]

provisioned = platform-issued custodial wallet; external = customer-provided self-custodied address (sends to it are final).

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "data": {},
  "code": 200,
  "message": "Successful request"
}

401

Access token is missing or invalid

403

Access denied

404

Payment method not found

application/json

Schema

Schema

status string

Possible values: [not found]

code integer

Possible values: [404]

message string

Failure reason

Example (from schema)

{
  "status": "not found",
  "code": 404,
  "message": "Entity not found"
}

409

Payment Method not found

application/json

Schema

Schema

status string

Possible values: [fail]

code integer

Possible values: [409]

message string

Failure reason

Example (from schema)

{
  "status": "fail",
  "code": 409,
  "message": "Entity with Id already exists"
}

422

Request failed due to invalid data provided

application/json

Schema

Schema

status string

Possible values: [error]

data object
code integer

Possible values: [422]

message string

Example (from schema)

{
  "status": "error",
  "data": {
    "dob": {
      "day": "Value expected to be 'integer', 'string' given."
    }
  },
  "code": 422,
  "message": "cannot process the provided entity"
}

500

Server error

Loading...