Get customer's payment methods

cURL

curl -X GET \
 /customers/{customerId}/payment-methods \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "<string>",
      "customer": "https://example.com/",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "referenceId": "<string>",
      "default": true,
      "status": "active",
      "source": "api",
      "enabled": true,
      "name": "<string>",
      "data": [
        "<string>"
      ],
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "sepaMandate": {
        "id": "ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a",
        "status": "active",
        "creditorIdentifier": "<string>",
        "mandateReference": "MNDT-2021-0001",
        "bankAccount": {
          "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
          "iban": "DE12500105170648489890",
          "bic": "PBNKDEFFXXX",
          "accountHolder": "Max Mustermann",
          "bankName": "Commerzbank"
        },
        "sequenceType": "FRST",
        "sepaType": "core"
      },
      "card": {
        "brand": "Visa",
        "last4": "4242",
        "expMonth": 12,
        "expYear": 2022,
        "cardHolder": "Max Mustermann"
      },
      "sepaDebit": {
        "iban": "DE8937*********3232",
        "bic": "COBADEFFXXX",
        "mandateReference": "MNDT-2021-123456",
        "signingDate": "2021-01-01T00:00:00+00:00"
      },
      "paypal": {
        "email": "[email protected]",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      },
      "expirationInDays": 123
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

GET

customers

{customerId}

payment-methods

cURL

curl -X GET \
 /customers/{customerId}/payment-methods \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "<string>",
      "customer": "https://example.com/",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "referenceId": "<string>",
      "default": true,
      "status": "active",
      "source": "api",
      "enabled": true,
      "name": "<string>",
      "data": [
        "<string>"
      ],
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "sepaMandate": {
        "id": "ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a",
        "status": "active",
        "creditorIdentifier": "<string>",
        "mandateReference": "MNDT-2021-0001",
        "bankAccount": {
          "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
          "iban": "DE12500105170648489890",
          "bic": "PBNKDEFFXXX",
          "accountHolder": "Max Mustermann",
          "bankName": "Commerzbank"
        },
        "sequenceType": "FRST",
        "sepaType": "core"
      },
      "card": {
        "brand": "Visa",
        "last4": "4242",
        "expMonth": 12,
        "expYear": 2022,
        "cardHolder": "Max Mustermann"
      },
      "sepaDebit": {
        "iban": "DE8937*********3232",
        "bic": "COBADEFFXXX",
        "mandateReference": "MNDT-2021-123456",
        "signingDate": "2021-01-01T00:00:00+00:00"
      },
      "paypal": {
        "email": "[email protected]",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      },
      "expirationInDays": 123
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

customerId

string

required

PaymentMethod identifier

Query Parameters

page

integer

default:1

The collection page number

limit

integer

default:30

The number of items per page

Required range: 0 <= x <= 100

gatewayName

string

gatewayName[]

string[]

type

string

type[]

string[]

status

string

status[]

string[]

enabled

boolean

default

boolean

Response

PaymentMethod collection

data

object[]

Show child attributes

data.id

string

data.customer

string<iri-reference>

Example:

"https://example.com/"

data.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

data.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider,

data.referenceId

string | null

data.default

boolean

data.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

data.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

data.enabled

boolean

data.name

string | null

data.data

string[]

data.creationDate

string<date-time>

data.expirationDate

string<date-time> | null

data.sepaMandate

object

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

Show child attributes

data.sepaMandate.id

string

Example:

"ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a"

data.sepaMandate.status

enum<string>

The status of the mandate

Possible values:

active: The mandate is active and can be used for payments
revoked: The customer has revoked the mandate or a payment was rejected by the bank. The mandate can not be used for payments anymore

Available options:

active,

revoked

Example:

"active"

data.sepaMandate.creditorIdentifier

string

data.sepaMandate.mandateReference

string

The reference of the mandate

Example:

"MNDT-2021-0001"

data.sepaMandate.bankAccount

object

The bank account of the mandate

Show child attributes

data.sepaMandate.bankAccount.id

string

Example:

"ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c"

data.sepaMandate.bankAccount.iban

string

Example:

"DE12500105170648489890"

data.sepaMandate.bankAccount.bic

string

Example:

"PBNKDEFFXXX"

data.sepaMandate.bankAccount.accountHolder

string

Example:

"Max Mustermann"

data.sepaMandate.bankAccount.bankName

string

Example:

"Commerzbank"

data.sepaMandate.sequenceType

enum<string>

The sequence type of the mandate

Possible values:

FRST: The sepa mandate is used for the first time for a recurring payment
RCUR: The sepa mandate was already used the first time and is now used for recurring payments
FNAL: The sepa mandate is used for the last time for a recurring payment
OOFF: The sepa mandate is only allowed to be used for one payment

Available options:

FRST,

RCUR,

FNAL,

OOFF

Example:

"FRST"

data.sepaMandate.sepaType

enum<string>

The type of the mandate

Possible values:

CORE: The core scheme is used for payments between consumers and companies
B2B: The B2B scheme is used for payments between companies. No refund is possible
COR1: The COR1 scheme is used for payments between consumers and companies. The payment is processed faster than with the core scheme

Available options:

CORE,

B2B,

COR1

Example:

"core"

data.card

object

The card data of the payment method, if the type is "card"

Show child attributes

data.card.brand

string

The brand of the card

Example:

"Visa"

data.card.last4

string

The last 4 digits of the card

Example:

"4242"

data.card.expMonth

integer

The expiration month of the card

Example:

12

data.card.expYear

integer

The expiration year of the card

Example:

2022

data.card.cardHolder

string

The card holder name

Example:

"Max Mustermann"

data.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

Show child attributes

data.sepaDebit.iban

string

The iban of the sepa mandate

Example:

"DE8937*********3232"

data.sepaDebit.bic

string

The bic of the sepa mandate

Example:

"COBADEFFXXX"

data.sepaDebit.mandateReference

string

The mandate reference of the sepa mandate

Example:

"MNDT-2021-123456"

data.sepaDebit.signingDate

string

The signing date of the sepa mandate

Example:

"2021-01-01T00:00:00+00:00"

data.paypal

object

The paypal data of the payment method, if the type is "paypal"

Show child attributes

data.paypal.email

string

The email of the paypal account

Example:

"[email protected]"

data.paypal.billingAgreementId

string

The billing agreement id of the paypal account

Example:

"I-1J5gqz2eZvKYlo2C2X2X2X2X"

data.expirationInDays

integer | null

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get customer's payment methods

Authorizations

Path Parameters

Query Parameters

Response