Payment Method

Private Payment Method API endpoints

Endpoints

GET/payment_methods/{payment_method_id}

Get payment method by ID

GET /payment_methods/{payment_method_id}

A detailed description of the payment method.

Path parameters

payment_method_idRequiredinteger

Payment method ID

Format: integer.

ReturnsPaymentMethod

Payment method object response

curl https://api.subbly.co/private/v1/payment_methods/{payment_method_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 567,
  "type": "card",
  "identifier": "4242",
  "currencies": [
    "USD",
    "EUR"
  ],
  "card": {
    "last_four": "4242",
    "expiry_month": "2",
    "expiry_year": "2099",
    "type": "credit",
    "brand": "visa"
  },
  "ideal": {
    "bank": "ING",
    "bic": "INGBNL2A",
    "email": "test@subbly.co",
    "name": "John Doe"
  },
  "bancontact": {
    "email": "test@subbly.co",
    "name": "John Doe"
  },
  "acss_debit": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "bank_name": "Royal Bank of Canada",
    "transit_number": "12345",
    "institution_number": "123",
    "last_four": "6789"
  },
  "us_bank_account": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "bank_name": "US Bank",
    "last_four": "6789",
    "routing_number": "123456789",
    "account_type": "checking",
    "account_holder_type": "individual"
  },
  "sepa_debit": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "iban_last4": "6789",
    "bank_code": "123456",
    "country": "DE",
    "branch_code": "12345"
  },
  "sofort": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "country": "DE"
  },
  "link": {
    "email": "test@subbly.co",
    "name": "John Doe"
  },
  "cashapp": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "buyer_id": "cashapp:123456789",
    "cash_tag": "$subbly"
  },
  "created_at": "2022-04-01 00:00:00"
}

Payment Method

Private Payment Method API endpoints

Endpoints

GET/payment_methods/{payment_method_id}

Get payment method by ID

GET /payment_methods/{payment_method_id}

A detailed description of the payment method.

Path parameters

payment_method_idRequiredinteger

Payment method ID

Format: integer.

ReturnsPaymentMethod

Payment method object response

idinteger

typestring

Possible values: paypal, card, ideal, sofort, bancontact, sepa_debit, acss_debit, us_bank_account, link, cashapp, amazon_pay.

identifierstring | null

currenciesstring[]

Codes of the currencies the payment method can be charged in — the shop currencies attached to its gateway. A subscription created with this payment method must bill in one of them.

cardobject | null

Only applicable for the card type

idealobject | null

Only applicable for the ideal type

bancontactobject | null

Only applicable for the bancontact type

acss_debitobject | null

Only applicable for the acss_debit type

us_bank_accountobject | null

Only applicable for the us_bank_account type

sepa_debitobject | null

Only applicable for the sepa_debit type

sofortobject | null

Only applicable for the sofort type

linkobject | null

Only applicable for the link type

cashappobject | null

Only applicable for the cashapp type

created_atstring | null

Format: date-time.

curl https://api.subbly.co/private/v1/payment_methods/{payment_method_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 567,
  "type": "card",
  "identifier": "4242",
  "currencies": [
    "USD",
    "EUR"
  ],
  "card": {
    "last_four": "4242",
    "expiry_month": "2",
    "expiry_year": "2099",
    "type": "credit",
    "brand": "visa"
  },
  "ideal": {
    "bank": "ING",
    "bic": "INGBNL2A",
    "email": "test@subbly.co",
    "name": "John Doe"
  },
  "bancontact": {
    "email": "test@subbly.co",
    "name": "John Doe"
  },
  "acss_debit": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "bank_name": "Royal Bank of Canada",
    "transit_number": "12345",
    "institution_number": "123",
    "last_four": "6789"
  },
  "us_bank_account": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "bank_name": "US Bank",
    "last_four": "6789",
    "routing_number": "123456789",
    "account_type": "checking",
    "account_holder_type": "individual"
  },
  "sepa_debit": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "iban_last4": "6789",
    "bank_code": "123456",
    "country": "DE",
    "branch_code": "12345"
  },
  "sofort": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "country": "DE"
  },
  "link": {
    "email": "test@subbly.co",
    "name": "John Doe"
  },
  "cashapp": {
    "email": "test@subbly.co",
    "name": "John Doe",
    "buyer_id": "cashapp:123456789",
    "cash_tag": "$subbly"
  },
  "created_at": "2022-04-01 00:00:00"
}