Payment methods

Obtain Access Token

post
/v1/oauth/token

Retrieve an access token using client credentials.

Authorizations
Body
grant_typestringRequired

The type of grant request (e.g., 'client_credentials').

client_idstringRequired

The client identifier issued to the client.

Responses
200

Access token successfully obtained.

application/json
post
/v1/oauth/token

List Payment Methods for a Customer

get
/v1/companies/{companyId}/customers/{customerId}/payment-methods

Retrieve all payment methods associated with a specific customer of a company.

Authorizations
Path parameters
companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

Responses
200

An array of payment methods.

application/json
get
/v1/companies/{companyId}/customers/{customerId}/payment-methods

Add a Payment Method for a Customer

post
/v1/companies/{companyId}/customers/{customerId}/payment-methods

Create a new payment method for a specific customer of a company.

Authorizations
Path parameters
companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

Body
methodstring · enumOptionalPossible values:
Responses
post
/v1/companies/{companyId}/customers/{customerId}/payment-methods

Retrieve Specific Payment Method

get
/v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId}

Get details of a specific payment method for a given customer of a company.

Authorizations
Path parameters
companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

paymentMethodIdstringRequired

Unique identifier of the payment method.

Responses
200

Details of the payment method.

application/json
get
/v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId}

Delete a Payment Method

delete
/v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId}

Delete a specific payment method from a customer's account.

Authorizations
Path parameters
companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

paymentMethodIdstringRequired

Unique identifier of the payment method.

Responses
delete
/v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId}

No content

Last updated