Customer Payment Methods

Customer Payment Methods represent chargeable payment methods like credit cards or direct debit mandates belonging to a customer. You can save them to Customer objects to store instrument details for future payments.

Endpoints

The Customer Payment Method object

Attributes

_id

Required

string

The ID of the payment method

primary

Required

boolean

Whether the payment method is primary

active

Required

boolean

Whether the payment method is primary

gatewayId

Required

string

The ID of the attached payment gateway or additional payment method

Optional Attributes

Collapse all

data

Optional

object

Whether the payment method is primary

paymentDetails

Optional

object

Whether the payment method is primary

gatewayType

Optional

string

The type of the payment gateway associated to this method

stripepaypaladyencustomcardconnectworldlineshift4authorizenetwalleesquarepayfasttouchnetvivenuPaymentsadditional-payment-method

channels

Optional

array

The type of the customer payment method

One of

Only one of the following types

One of

Only one of the following types

createdAt

Optional

string date-time

The created ISO timestamp

updatedAt

Optional

string date-time

The last updated ISO timestamp

Was this section helpful?

Yes No

{
  "_id": "string",
  "data": {},
  "paymentDetails": {},
  "primary": true,
  "active": true,
  "gatewayType": "stripe",
  "gatewayId": "string",
  "channels": [
    []
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get payment methods for customer

Query

channel

Optional

string

Channel the methods are used for

primary

Optional

boolean

Whether the payment method is primary or not

active

Optional

boolean

Whether the payment method is active or not

gatewayId

Optional

string

The ID of the payment gateway or additional payment method which the payment method belongs to

paymentGatewayChannels

Optional

array<string>

The allowed payment gateway channels

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "data": {},
    "paymentDetails": {},
    "primary": true,
    "active": true,
    "gatewayType": "stripe",
    "gatewayId": "string",
    "channels": [
      []
    ],
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
]

Create a customer payment method

Payload

One of

Only one of the following types

gatewayId

Required

string

The ID of the payment gateway or additional payment method which the payment method belongs to

Optional Attributes

Collapse all

data

Optional

object

data.iban

Required

string

The IBAN of the customer payment method.

data.bic

Required

string

The BIC of the customer payment method.

data.accountHolderName

Required

string

The account holder name of the customer payment method.

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "data": {
    "iban": "string",
    "bic": "string",
    "accountHolderName": "string"
  },
  "gatewayId": "string"
}

{
  "_id": "string",
  "data": {},
  "paymentDetails": {},
  "primary": true,
  "active": true,
  "gatewayType": "stripe",
  "gatewayId": "string",
  "channels": [
    []
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Set customer payment method to primary

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "data": {},
  "paymentDetails": {},
  "primary": true,
  "active": true,
  "gatewayType": "stripe",
  "gatewayId": "string",
  "channels": [
    []
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}