/payment-methods

Beta

GET

/accounting/v1/payment-methods

GET

/api/accounting/v1/payment-methods

1 from merge import Merge
2 
3 client = Merge(
4     account_token="YOUR_ACCOUNT_TOKEN",
5     api_key="YOUR_API_KEY",
6 )
7 response = client.accounting.payment_methods.list(
8     cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
9 )
10 for item in response:
11     yield item
12 # alternatively, you can paginate page-by-page
13 for page in response.iter_pages():
14     yield page

200Retrieved

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

Returns a list of PaymentMethod objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

cursorstringOptional

The pagination cursor value.

include_deleted_databooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).

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).

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

Response

nextstring or null

previousstring or null

resultslist of objects or null

<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9WTbWvbMBDHv8rQy+CHJWkaahgjT2sTsNI27lgpRVyki6NEthxLTtqUfvdhJ7TJVlgHhbF3uuPuf3e/Oz0RDhZjnT+SgADnukitTGPikEQLVCQgl/CYYGpDtHMtiEMgkxQSPApn6wZxiCmyTOcWxTeJSpiLHGckIH6CeYxukcqZROG/JvkytRjnYKVOjf+S7M6qbOIQJdMlis4u4c9yu3B37/nFNL6SxhKHZGCMnee6iOfXuCrQvEO57E1hSQGUK8CCf6Di5juZt3zlFAIVWhR9sNBHi7wcd19xbm1mAt+fo8q8qroncO1j6kNuJVdo/FbzrNE+a7l7lar6VxarL/XaYjXV03aNxVwxKGphxB9oNNzQRXxCeycPdHvTotvlli6Wn2sshloYha1xdNsc9zv18RsBbHL64+x7t98d0RrfDpp0cbuhEa+HEV9Ot8Pm6JxvRhdXD3R72wj7N00aDVqjc10f965N2LvWYcfziEMOt0qCu6dDx/5wKNpJIS0eRw8TiPGAym4dkEk3K6ZKcs80PUhgq1PYGI/rxE9QSPApWlOqMbMqIEcvq863AiZ1+sKcBGRALzq0N+gfn0FnDVLBVCEJbF7gb3dMgjsiDQNu5bpsOal+ArOPWWml5UilXvVLiENyTLRFVi7q2GIZ2PmrSwpyXxqrQuYoLiGHBC3mZbn7Z+ctbFeF5Muu1kvzaZwqmX4Qv1dZd0eQ3cwap912/T8i+fIuMgEWBQP7t3QnEOOnYWqBc/sxYEtFtldkkx3a9VpS04Z/jXb/Mu88x/vnnzv/6KsoBgAA" />

Supported response fields

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