/payment-methods/{id}

Beta

Returns a PaymentMethod object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

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

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-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
Allowed values:
is_activeboolean

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

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information