Skip to main content
GET
/
v1
/
c
/
customer
/
{customer_id}
/
payment
/
method
Return all payment methods of a customer, including
curl --request GET \
  --url http://127.0.0.1:8080/v1/c/customer/{customer_id}/payment/method \
  --header 'wb-key: <api-key>'
[
  {
    "created": "2023-11-07T05:31:56Z",
    "details": {
      "Card": {
        "brand": "<string>",
        "expiration": "<string>",
        "last_digits": "<string>"
      }
    },
    "holder_name": "<string>",
    "id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
    "method_type": "card",
    "preference": 123,
    "provider": "stripe",
    "status": "active"
  }
]

Authorizations

​
wb-key
string
header
required

Path Parameters

​
customer_id
string
required

Id of the customer

Response

200 - application/json

customer payment methods

​
created
string<date-time>
required

Date the payment method was configured

​
details
object
required

Details about the configured payment method

  • Card - credit card
  • SepaDebit - SEPA bank payments
  • Option 1
  • Option 2
  • Option 3
​
id
string
required

Unique identifier of an object. Consists of object class prefix and a UUID

Example:

"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"

​
method_type
enum<string>
required

Type of the Payment Method:

  • Card - Credit Card
  • SepaDebit - SEPA bank transfer
Available options:
card,
sepa_debit,
vban_bank_transfer_eu
​
provider
enum<string>
required

The payment providers known by the backend.

Those variants MUST be kept identical to the variants of the payment_provider enum of the postgres database

Available options:
authorize,
self_handled,
stripe
Example:

"stripe"

​
status
enum<string>
required

Payment Method Status:

  • Active - can be used
  • Inactive - disabled. Might be re-enabled
  • Detached - disabled, can not be re-activated
  • Invalid - error using payment method
Available options:
active,
inactive,
detached,
invalid
​
holder_name
string | null

Name on the credit card

​
preference
integer | null

Priority of the configured payment method. Smaller number is higher priority