/payment-methods/{id}

Returns a PaymentMethod object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

namestring<=255 characters

The payment method’s name

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-only

The datetime that this object was modified by Merge.

method_typeenum or null

The type of the payment method.

CREDIT_CARD - CREDIT_CARD
DEBIT_CARD - DEBIT_CARD
ACH - ACH
CASH - CASH
CHECK - CHECK

The type of the payment method. * `CREDIT_CARD` - CREDIT_CARD * `DEBIT_CARD` - DEBIT_CARD * `ACH` - ACH * `CASH` - CASH * `CHECK` - CHECK

Allowed values:

is_activeboolean or null

True if the payment method is active, False if not.

remote_updated_atdatetime or null

When the third party's payment method was updated.

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

method_typeenum or nullOptional

The type of the payment method.

CREDIT_CARD - CREDIT_CARD
DEBIT_CARD - DEBIT_CARD
ACH - ACH
CASH - CASH
CHECK - CHECK

Allowed values:

namestringOptional<=255 characters

The payment method’s name

is_activebooleanOptional

True if the payment method is active, False if not.

remote_updated_atdatetime or nullOptional

When the third party's payment method was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

method_typeenum or nullOptional

The type of the payment method.

CREDIT_CARD - CREDIT_CARD
DEBIT_CARD - DEBIT_CARD
ACH - ACH
CASH - CASH
CHECK - CHECK

Allowed values:

namestringOptional<=255 characters

The payment method’s name

is_activebooleanOptional

True if the payment method is active, False if not.

remote_updated_atdatetime or nullOptional

When the third party's payment method was updated.

remote_datalist of objects or nullOptionalRead-only

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	client.accounting.payment_methods.retrieve(
8	id="id",
9	)

1	{
2	"name": "John Smith's Credit Card",
3	"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
4	"remote_id": "088899",
5	"created_at": "2021-09-15T00:00:00Z",
6	"modified_at": "2021-10-16T00:00:00Z",
7	"method_type": "CREDIT_CARD",
8	"is_active": true,
9	"remote_updated_at": "2021-09-15T00:00:00Z",
10	"field_mappings": {
11	"organization_defined_targets": {
12	"custom_key": "custom_value"
13	},
14	"linked_account_defined_targets": {
15	"custom_key": "custom_value"
16	}
17	},
18	"remote_data": [
19	{
20	"path": "/actions"
21	}
22	]
23	}

/payment-methods/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration