Payment Methods

Explore the Commerce Payment Methods endpoints in Swagger.

View the coverage for payment methods in the Data Coverage Explorer.

Overview

A Payment Method represents the payment method(s) used to make payments.

From the Payment Methods endpoints you can retrieve:

  • A list of all payment methods from a data connection:
    GET /companies​/{companyId}​/connections​/{connectionId}​/data​/commerce-paymentMethods
  • The details of an individual payment method:
    GET ​/companies​/{companyId}​/connections​/{connectionId}​/data​/commerce-paymentMethods/{paymentMethodId}

Data model

Field

Type

Decription

id

string

Unique identifier for the payment method.

name

string

Name of the payment method.

status

string

Status of the Payment Method:

  • Active: Available for use
  • Archived: Unavailable
  • Unknown

modifiedDate

string
See date

Date the payment method details were last updated in the Codat system.

sourceModifiedDate

string
See date

Date the payment method details were last changed in the commerce system.

Example data

{
    "id": "ac003a22-0813-4763-9203-6f94046188ae",
    "name": "Alipay",
    "status": "Active",
        "modifiedDate" : "2022-01-01T00:00:00Z"
    "sourceModifiedDate": "2022-03-18T02:17:50Z"
}

Did this page help you?