Retrieves the payment methods of a cart.

cURL

curl -X GET \
 /public/checkout/cart/{id}/payment-methods \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "default": true,
      "status": "active",
      "enabled": true,
      "name": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "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"
      }
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

GET

public

checkout

cart

{id}

payment-methods

cURL

curl -X GET \
 /public/checkout/cart/{id}/payment-methods \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "default": true,
      "status": "active",
      "enabled": true,
      "name": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "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"
      }
    }
  ],
  "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

string

required

Cart 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

Response

Cart collection

data

object[]

Show child attributes

data.id

string

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.default

boolean

data.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

data.enabled

boolean

data.name

string | null

data.creationDate

string<date-time>

data.expirationDate

string<date-time> | null

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"

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Retrieves the payment methods of a cart.

Authorizations

Path Parameters

Query Parameters

Response