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               },
103               "balance_platform_details": {
104                 "account": "string",
105                 "authentication": {
106                   "api_key": {
107                     "header": "string",
108                     "value": "string"
109                   },
110                   "client_credentials": {
111                     "client_id": "string",
112                     "client_secret": "string"
113                   },
114                   "username_password": {
115                     "username": "string",
116                     "password": "string"
117                   }
118                 }
119               },
120               "legal_entity_manager_details": {
121                 "authentication": {
122                   "api_key": {
123                     "header": "string",
124                     "value": "string"
125                   },
126                   "client_credentials": {
127                     "client_id": "string",
128                     "client_secret": "string"
129                   },
130                   "username_password": {
131                     "username": "string",
132                     "password": "string"
133                   }
134                 }
135               },
136               "enabled_payment_methods": [
137                 "string"
138               ]
139             },
140             "stripe": {
141               "public_key": "string",
142               "signing_secret": "string"
143             }
144           },
145           "e_invoicing": {
146             "mandates": [
147               {
148                 "name": "string",
149                 "country": "string",
150                 "mappings": [
151                   {
152                     "target": "string",
153                     "source": "string",
154                     "description": "string"
155                   }
156                 ],
157                 "condition_groups": [
158                   {
159                     "conditions": [
160                       {
161                         "field": "string",
162                         "comparator_type": "EQUALS",
163                         "value": "string"
164                       }
165                     ]
166                   }
167                 ],
168                 "include_pdf_in_einvoice": true,
169                 "supported_file_formats": [
170                   {
171                     "type": "string",
172                     "description": "string"
173                   }
174                 ]
175               }
176             ],
177             "processor": "AVALARA"
178           },
179           "data_export": {
180             "variant": "S3",
181             "s3": {
182               "bucket_name": "string",
183               "bucket_path": "string",
184               "bucket_region": "string"
185             },
186             "bigquery": {
187               "project_id": "string",
188               "dataset_id": "string",
189               "dataset_location": "string",
190               "gcs_bucket_name": "string",
191               "gcs_hmac_key_access_id": "string",
192               "gcs_hmac_key_secret": "string"
193             },
194             "gcs": {
195               "bucket_region": "string",
196               "bucket_name": "string",
197               "bucket_path": "string",
198               "flattening": true
199             },
200             "snowflake": {
201               "host": "string",
202               "role": "string",
203               "warehouse": "string",
204               "database": "string",
205               "schema": "string"
206             }
207           },
208           "tax_calculation": {
209             "billing_entity_id": "string",
210             "variant": "AVATAX",
211             "ava_tax": {
212               "company_code": "string"
213             },
214             "custom_tax_codes": [
215               {
216                 "field": "INVOICE_COMMITMENT",
217                 "value": "string"
218               }
219             ],
220             "enable_tax_filing": true
221           },
222           "linked_resources_configurations": [
223             {
224               "resource_type": "string",
225               "link_details": [
226                 {
227                   "base_url": "string",
228                   "custom_field_reference": "string"
229                 }
230               ]
231             }
232           ],
233           "email_provider": {
234             "variant": "SYSTEM",
235             "mailgun": {
236               "domain": "string",
237               "region": "US",
238               "plan": "string"
239             },
240             "delivery_window": {
241               "type": "DAY",
242               "value": 1
243             },
244             "use_localized_templates": true
245           }
246         },
247         "store_payment_method": true,
248         "auto_charge_payment_method": true,
249         "collection_type": "LINK",
250         "link": {
251           "expiry_period": {
252             "type": "DAY",
253             "value": 1
254           }
255         },
256         "adyen": {
257           "auto_rescue": {
258             "enabled": true,
259             "period": {
260               "type": "DAY",
261               "value": 1
262             }
263           },
264           "merchant_account": "string",
265           "allowed_payment_methods": [
266             "string"
267           ]
268         }
269       },
270       "custom_redirect": {
271         "url": "string"
272       },
273       "status": "DRAFT"
274     }
275   ]
276 }

Requires the PAYMENT_ACCEPTOR.VIEW permission.

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

{
  "data": [
    {
      "object_type": "string",
      "id": "string",
      "billing_entity_id": "string",
      "customer_id": "string",
      "reference": "string",
      "name": "string",
      "description": "string",
      "type": "BANK_ACCOUNT",
      "bank_account": {
        "type": "IBAN",
        "iban": "string",
        "country": "string",
        "bic": "string",
        "bank_name": "string",
        "bank_address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "postal_code": "string",
          "state": "string",
          "country": "AD"
        },
        "account_number_and_bic": {
          "account_number": "string",
          "bank_code": "string",
          "bic": "string"
        },
        "uk_local": {
          "account_number": "string",
          "sort_code": "string"
        },
        "us_local": {
          "account_number": "string",
          "account_type": "CHECKING",
          "bank_code": "string",
          "routing_number": "string"
        },
        "br_local": {
          "branch": "string",
          "account_number": "string",
          "bic": "string"
        },
        "ar_local": {
          "cbu": "string",
          "account_number": "string",
          "bic": "string"
        },
        "mx_local": {
          "clabe": "string",
          "account_number": "string",
          "bic": "string"
        },
        "account_number": "string",
        "bank_code": "string",
        "routing_number": "string",
        "account_type": "CHECKING"
      },
      "payment_gateway": {
        "integration_id": "string",
        "integration": {
          "object_type": "string",
          "id": "string",
          "reference": "string",
          "name": "string",
          "description": "string",
          "status": "DRAFT",
          "message": "string",
          "type": "PAYMENT_GATEWAY",
          "authentication": {
            "api_key": {
              "header": "string",
              "value": "string"
            },
            "client_credentials": {
              "client_id": "string",
              "client_secret": "string"
            },
            "username_password": {
              "username": "string",
              "password": "string"
            }
          },
          "payment_gateway": {
            "variant": "ADYEN",
            "adyen": {
              "company_account": "string",
              "environment": "LIVE",
              "live_prefix": "string",
              "merchant_accounts": [
                "string"
              ],
              "public_key": "string",
              "signing_secret": "string",
              "ownership": "PLATFORM",
              "system_ownership_details": {
                "account_holder_id": "string",
                "balance_account_id": "string",
                "legal_entity_id": "string"
              },
              "balance_platform_details": {
                "account": "string",
                "authentication": {
                  "api_key": {
                    "header": "string",
                    "value": "string"
                  },
                  "client_credentials": {
                    "client_id": "string",
                    "client_secret": "string"
                  },
                  "username_password": {
                    "username": "string",
                    "password": "string"
                  }
                }
              },
              "legal_entity_manager_details": {
                "authentication": {
                  "api_key": {
                    "header": "string",
                    "value": "string"
                  },
                  "client_credentials": {
                    "client_id": "string",
                    "client_secret": "string"
                  },
                  "username_password": {
                    "username": "string",
                    "password": "string"
                  }
                }
              },
              "enabled_payment_methods": [
                "string"
              ]
            },
            "stripe": {
              "public_key": "string",
              "signing_secret": "string"
            }
          },
          "e_invoicing": {
            "mandates": [
              {
                "name": "string",
                "country": "string",
                "mappings": [
                  {
                    "target": "string",
                    "source": "string",
                    "description": "string"
                  }
                ],
                "condition_groups": [
                  {
                    "conditions": [
                      {
                        "field": "string",
                        "comparator_type": "EQUALS",
                        "value": "string"
                      }
                    ]
                  }
                ],
                "include_pdf_in_einvoice": true,
                "supported_file_formats": [
                  {
                    "type": "string",
                    "description": "string"
                  }
                ]
              }
            ],
            "processor": "AVALARA"
          },
          "data_export": {
            "variant": "S3",
            "s3": {
              "bucket_name": "string",
              "bucket_path": "string",
              "bucket_region": "string"
            },
            "bigquery": {
              "project_id": "string",
              "dataset_id": "string",
              "dataset_location": "string",
              "gcs_bucket_name": "string",
              "gcs_hmac_key_access_id": "string",
              "gcs_hmac_key_secret": "string"
            },
            "gcs": {
              "bucket_region": "string",
              "bucket_name": "string",
              "bucket_path": "string",
              "flattening": true
            },
            "snowflake": {
              "host": "string",
              "role": "string",
              "warehouse": "string",
              "database": "string",
              "schema": "string"
            }
          },
          "tax_calculation": {
            "billing_entity_id": "string",
            "variant": "AVATAX",
            "ava_tax": {
              "company_code": "string"
            },
            "custom_tax_codes": [
              {
                "field": "INVOICE_COMMITMENT",
                "value": "string"
              }
            ],
            "enable_tax_filing": true
          },
          "linked_resources_configurations": [
            {
              "resource_type": "string",
              "link_details": [
                {
                  "base_url": "string",
                  "custom_field_reference": "string"
                }
              ]
            }
          ],
          "email_provider": {
            "variant": "SYSTEM",
            "mailgun": {
              "domain": "string",
              "region": "US",
              "plan": "string"
            },
            "delivery_window": {
              "type": "DAY",
              "value": 1
            },
            "use_localized_templates": true
          }
        },
        "store_payment_method": true,
        "auto_charge_payment_method": true,
        "collection_type": "LINK",
        "link": {
          "expiry_period": {
            "type": "DAY",
            "value": 1
          }
        },
        "adyen": {
          "auto_rescue": {
            "enabled": true,
            "period": {
              "type": "DAY",
              "value": 1
            }
          },
          "merchant_account": "string",
          "allowed_payment_methods": [
            "string"
          ]
        }
      },
      "custom_redirect": {
        "url": "string"
      },
      "status": "DRAFT"
    }
  ]
}

Get a list of payment acceptors for provided filters

Get a list of payment acceptors for provided filters

Authentication

Path parameters

Headers

Query parameters

Response

Errors

Authentication

Path parameters

Headers

Query parameters

Response

Errors

$	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	},
103	"balance_platform_details": {
104	"account": "string",
105	"authentication": {
106	"api_key": {
107	"header": "string",
108	"value": "string"
109	},
110	"client_credentials": {
111	"client_id": "string",
112	"client_secret": "string"
113	},
114	"username_password": {
115	"username": "string",
116	"password": "string"
117	}
118	}
119	},
120	"legal_entity_manager_details": {
121	"authentication": {
122	"api_key": {
123	"header": "string",
124	"value": "string"
125	},
126	"client_credentials": {
127	"client_id": "string",
128	"client_secret": "string"
129	},
130	"username_password": {
131	"username": "string",
132	"password": "string"
133	}
134	}
135	},
136	"enabled_payment_methods": [
137	"string"
138	]
139	},
140	"stripe": {
141	"public_key": "string",
142	"signing_secret": "string"
143	}
144	},
145	"e_invoicing": {
146	"mandates": [
147	{
148	"name": "string",
149	"country": "string",
150	"mappings": [
151	{
152	"target": "string",
153	"source": "string",
154	"description": "string"
155	}
156	],
157	"condition_groups": [
158	{
159	"conditions": [
160	{
161	"field": "string",
162	"comparator_type": "EQUALS",
163	"value": "string"
164	}
165	]
166	}
167	],
168	"include_pdf_in_einvoice": true,
169	"supported_file_formats": [
170	{
171	"type": "string",
172	"description": "string"
173	}
174	]
175	}
176	],
177	"processor": "AVALARA"
178	},
179	"data_export": {
180	"variant": "S3",
181	"s3": {
182	"bucket_name": "string",
183	"bucket_path": "string",
184	"bucket_region": "string"
185	},
186	"bigquery": {
187	"project_id": "string",
188	"dataset_id": "string",
189	"dataset_location": "string",
190	"gcs_bucket_name": "string",
191	"gcs_hmac_key_access_id": "string",
192	"gcs_hmac_key_secret": "string"
193	},
194	"gcs": {
195	"bucket_region": "string",
196	"bucket_name": "string",
197	"bucket_path": "string",
198	"flattening": true
199	},
200	"snowflake": {
201	"host": "string",
202	"role": "string",
203	"warehouse": "string",
204	"database": "string",
205	"schema": "string"
206	}
207	},
208	"tax_calculation": {
209	"billing_entity_id": "string",
210	"variant": "AVATAX",
211	"ava_tax": {
212	"company_code": "string"
213	},
214	"custom_tax_codes": [
215	{
216	"field": "INVOICE_COMMITMENT",
217	"value": "string"
218	}
219	],
220	"enable_tax_filing": true
221	},
222	"linked_resources_configurations": [
223	{
224	"resource_type": "string",
225	"link_details": [
226	{
227	"base_url": "string",
228	"custom_field_reference": "string"
229	}
230	]
231	}
232	],
233	"email_provider": {
234	"variant": "SYSTEM",
235	"mailgun": {
236	"domain": "string",
237	"region": "US",
238	"plan": "string"
239	},
240	"delivery_window": {
241	"type": "DAY",
242	"value": 1
243	},
244	"use_localized_templates": true
245	}
246	},
247	"store_payment_method": true,
248	"auto_charge_payment_method": true,
249	"collection_type": "LINK",
250	"link": {
251	"expiry_period": {
252	"type": "DAY",
253	"value": 1
254	}
255	},
256	"adyen": {
257	"auto_rescue": {
258	"enabled": true,
259	"period": {
260	"type": "DAY",
261	"value": 1
262	}
263	},
264	"merchant_account": "string",
265	"allowed_payment_methods": [
266	"string"
267	]
268	}
269	},
270	"custom_redirect": {
271	"url": "string"
272	},
273	"status": "DRAFT"
274	}
275	]
276	}