Payment Method
Get customer's payment methods
API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Payment Method
Get customer's payment methods
Get customer’s payment methods.
Required permissions:payment-method:read, customer:payment-method:readGET
/
customers
/
{customerId}
/
payment-methods
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": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
},
"expirationInDays": 123
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Authorizations
Value for the Authorization header parameter.
Path Parameters
PaymentMethod identifier
Query Parameters
The collection page number
The number of items per page
Required range:
0 <= x <= 100Response
200
application/json
PaymentMethod collection
Example:
"https://example.com/"
Available options:
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing Available options:
sepa_debit, card, paypal, bank_transfer, wallet, fake_provider Available options:
active, action_required, expired, revoked, gateway_unconfigured Example:
"active"
Available options:
checkout, customerfront, api, add_link Example:
"api"
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
Example:
"ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a"
The status of the mandate
Possible values:
active: The mandate is active and can be used for paymentsrevoked: 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"
The reference of the mandate
Example:
"MNDT-2021-0001"
The bank account of the mandate
Example:
"ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c"
Example:
"DE12500105170648489890"
Example:
"PBNKDEFFXXX"
Example:
"Max Mustermann"
Example:
"Commerzbank"
The sequence type of the mandate
Possible values:
FRST: The sepa mandate is used for the first time for a recurring paymentRCUR: The sepa mandate was already used the first time and is now used for recurring paymentsFNAL: The sepa mandate is used for the last time for a recurring paymentOOFF: The sepa mandate is only allowed to be used for one payment
Available options:
FRST, RCUR, FNAL, OOFF Example:
"FRST"
The type of the mandate
Possible values:
CORE: The core scheme is used for payments between consumers and companiesB2B: The B2B scheme is used for payments between companies. No refund is possibleCOR1: 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"
The card data of the payment method, if the type is "card"
The brand of the card
Example:
"Visa"
The last 4 digits of the card
Example:
"4242"
The expiration month of the card
Example:
12
The expiration year of the card
Example:
2022
The card holder name
Example:
"Max Mustermann"
The sepa mandate data of the payment method, if the type is "sepa_debit"
The iban of the sepa mandate
Example:
"DE8937*********3232"
The bic of the sepa mandate
Example:
"COBADEFFXXX"
The mandate reference of the sepa mandate
Example:
"MNDT-2021-123456"
The signing date of the sepa mandate
Example:
"2021-01-01T00:00:00+00:00"
Was this page helpful?
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": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
},
"expirationInDays": 123
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}