Get a list of payment acceptors for provided filters

GET

/v:version/payment-acceptors

GET

/v:version/payment-acceptors

$ curl https://test.api.solvimon.com/v1/payment-acceptors \
>      -H "X-API-KEY: <apiKey>"

1 {
2   "data": [
3     {
4       "object_type": "string",
5       "id": "string",
6       "billing_entity_id": "string",
7       "customer_id": "string",
8       "reference": "string",
9       "name": "string",
10       "description": "string",
11       "type": "BANK_ACCOUNT",
12       "bank_account": {
13         "type": "IBAN",
14         "iban": "string",
15         "country": "string",
16         "bic": "string",
17         "bank_name": "string",
18         "bank_address": {
19           "line1": "string",
20           "line2": "string",
21           "city": "string",
22           "postal_code": "string",
23           "state": "string",
24           "country": "AD"
25         },
26         "account_number_and_bic": {
27           "account_number": "string",
28           "bank_code": "string",
29           "bic": "string"
30         },
31         "uk_local": {
32           "account_number": "string",
33           "sort_code": "string"
34         },
35         "us_local": {
36           "account_number": "string",
37           "account_type": "CHECKING",
38           "bank_code": "string",
39           "routing_number": "string"
40         },
41         "br_local": {
42           "branch": "string",
43           "account_number": "string",
44           "bic": "string"
45         },
46         "ar_local": {
47           "cbu": "string",
48           "account_number": "string",
49           "bic": "string"
50         },
51         "mx_local": {
52           "clabe": "string",
53           "account_number": "string",
54           "bic": "string"
55         },
56         "account_number": "string",
57         "bank_code": "string",
58         "routing_number": "string",
59         "account_type": "CHECKING"
60       },
61       "payment_gateway": {
62         "integration_id": "string",
63         "integration": {
64           "object_type": "string",
65           "id": "string",
66           "reference": "string",
67           "name": "string",
68           "description": "string",
69           "status": "DRAFT",
70           "message": "string",
71           "type": "PAYMENT_GATEWAY",
72           "authentication": {
73             "api_key": {
74               "header": "string",
75               "value": "string"
76             },
77             "client_credentials": {
78               "client_id": "string",
79               "client_secret": "string"
80             },
81             "username_password": {
82               "username": "string",
83               "password": "string"
84             }
85           },
86           "payment_gateway": {
87             "variant": "ADYEN",
88             "adyen": {
89               "company_account": "string",
90               "environment": "LIVE",
91               "live_prefix": "string",
92               "merchant_accounts": [
93                 "string"
94               ],
95               "public_key": "string",
96               "signing_secret": "string",
97               "ownership": "PLATFORM",
98               "system_ownership_details": {
99                 "account_holder_id": "string",
100                 "balance_account_id": "string",
101                 "legal_entity_id": "string",
102                 "store_id": "string"
103               },
104               "balance_platform_details": {
105                 "account": "string",
106                 "authentication": {
107                   "api_key": {
108                     "header": "string",
109                     "value": "string"
110                   },
111                   "client_credentials": {
112                     "client_id": "string",
113                     "client_secret": "string"
114                   },
115                   "username_password": {
116                     "username": "string",
117                     "password": "string"
118                   }
119                 }
120               },
121               "legal_entity_manager_details": {
122                 "authentication": {
123                   "api_key": {
124                     "header": "string",
125                     "value": "string"
126                   },
127                   "client_credentials": {
128                     "client_id": "string",
129                     "client_secret": "string"
130                   },
131                   "username_password": {
132                     "username": "string",
133                     "password": "string"
134                   }
135                 }
136               },
137               "enabled_payment_methods": [
138                 "string"
139               ]
140             },
141             "stripe": {
142               "public_key": "string",
143               "signing_secret": "string"
144             }
145           },
146           "e_invoicing": {
147             "mandates": [
148               {
149                 "name": "string",
150                 "country": "string",
151                 "mappings": [
152                   {
153                     "target": "string",
154                     "source": "string",
155                     "description": "string"
156                   }
157                 ],
158                 "condition_groups": [
159                   {
160                     "conditions": [
161                       {
162                         "field": "string",
163                         "comparator_type": "EQUALS",
164                         "value": "string"
165                       }
166                     ]
167                   }
168                 ],
169                 "include_pdf_in_einvoice": true,
170                 "supported_file_formats": [
171                   {
172                     "type": "string",
173                     "description": "string"
174                   }
175                 ]
176               }
177             ],
178             "processor": "AVALARA"
179           },
180           "data_export": {
181             "variant": "S3",
182             "s3": {
183               "bucket_name": "string",
184               "bucket_path": "string",
185               "bucket_region": "string",
186               "authentication_type": "ACCESS_KEY_AND_SECRET",
187               "role_arn": "string",
188               "external_id": "string"
189             },
190             "bigquery": {
191               "project_id": "string",
192               "dataset_id": "string",
193               "dataset_location": "string",
194               "gcs_bucket_name": "string",
195               "gcs_hmac_key_access_id": "string",
196               "gcs_hmac_key_secret": "string"
197             },
198             "gcs": {
199               "bucket_region": "string",
200               "bucket_name": "string",
201               "bucket_path": "string",
202               "flattening": true
203             },
204             "snowflake": {
205               "host": "string",
206               "role": "string",
207               "warehouse": "string",
208               "database": "string",
209               "schema": "string"
210             },
211             "transport_type": "string"
212           },
213           "tax_calculation": {
214             "billing_entity_id": "string",
215             "variant": "AVATAX",
216             "ava_tax": {
217               "company_code": "string"
218             },
219             "custom_tax_codes": [
220               {
221                 "field": "INVOICE_COMMITMENT",
222                 "value": "string"
223               }
224             ],
225             "enable_tax_filing": true
226           },
227           "linked_resources_configurations": [
228             {
229               "resource_type": "string",
230               "link_details": [
231                 {
232                   "base_url": "string",
233                   "custom_field_reference": "string"
234                 }
235               ]
236             }
237           ],
238           "email_provider": {
239             "variant": "SYSTEM",
240             "mailgun": {
241               "domain": "string",
242               "region": "US",
243               "plan": "string"
244             },
245             "delivery_window": {
246               "type": "DAY",
247               "value": 1
248             },
249             "use_localized_templates": true
250           }
251         },
252         "store_payment_method": true,
253         "auto_charge_payment_method": true,
254         "collection_type": "LINK",
255         "link": {
256           "expiry_period": {
257             "type": "DAY",
258             "value": 1
259           }
260         },
261         "adyen": {
262           "auto_rescue": {
263             "enabled": true,
264             "period": {
265               "type": "DAY",
266               "value": 1
267             }
268           },
269           "merchant_account": "string",
270           "allowed_payment_methods": [
271             "string"
272           ]
273         }
274       },
275       "custom_redirect": {
276         "url": "string"
277       },
278       "status": "DRAFT"
279     }
280   ]
281 }

Requires the PAYMENT_ACCEPTOR.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

billing_entity_idstringOptional

The resource id of the billingEntity.

customer_idstringOptional

The resource id of the customer.

statuses[]list of stringsOptional

Filter paymentAcceptor based on status(es)

Response

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors