Delete a payment acceptor

DELETE

/v:version/payment-acceptors/:resourceId

DELETE

/v:version/payment-acceptors/:resourceId

1 curl -X DELETE https://test.api.solvimon.com/v1/payment-acceptors/ \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "reference": "PA-20240601-001",
3   "object_type": "payment_acceptor",
4   "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5   "billing_entity_id": "be1234567890",
6   "name": "Main Corporate Bank Account",
7   "description": "Primary bank account for corporate payments",
8   "type": "BANK_ACCOUNT",
9   "bank_account": {
10     "type": "IBAN",
11     "iban": "GB82WEST12345698765432",
12     "country": "GB",
13     "bic": "WESTGB22",
14     "bank_name": "Westminster Bank",
15     "bank_address": {
16       "line1": "10 Downing Street",
17       "line2": "Westminster",
18       "city": "London",
19       "postal_code": "SW1A 2AA",
20       "state": "Greater London",
21       "country": "GB"
22     },
23     "account_number_and_bic": {
24       "account_number": "12345678",
25       "bank_code": "400300",
26       "bic": "WESTGB22"
27     },
28     "uk_local": {
29       "account_number": "12345678",
30       "sort_code": "40-03-00"
31     },
32     "us_local": {
33       "account_number": "987654321",
34       "account_type": "CHECKING",
35       "bank_code": "021000021",
36       "routing_number": "021000021"
37     },
38     "account_number": "12345678",
39     "bank_code": "400300",
40     "routing_number": "1100001",
41     "account_type": "CHECKING"
42   },
43   "payment_gateway": {
44     "integration_id": "pgw-9876543210",
45     "collection_type": "LINK",
46     "integration": {
47       "reference": "PGW-INT-2024",
48       "name": "Adyen Live Integration",
49       "description": "Integration with Adyen payment gateway for live transactions",
50       "type": "PAYMENT_GATEWAY",
51       "linked_resources_configurations": [
52         {
53           "resource_type": "invoice",
54           "link_details": [
55             {
56               "base_url": "https://invoices.company.com",
57               "custom_field_reference": "invoice_id"
58             }
59           ]
60         }
61       ],
62       "object_type": "payment_gateway_integration",
63       "id": "int-1234567890",
64       "status": "ACTIVE",
65       "message": "Integration active and operational",
66       "authentication": {
67         "api_key": {
68           "header": "X-API-Key",
69           "value": "sk_live_4eC39HqLyjWDarjtT1zdp7dc"
70         },
71         "client_credentials": {
72           "client_id": "client_abc123",
73           "client_secret": "secret_987xyz"
74         },
75         "username_password": {
76           "username": "user_adyen",
77           "password": "securePass!2024"
78         }
79       },
80       "payment_gateway": {
81         "variant": "ADYEN",
82         "adyen": {
83           "company_account": "Company_12345",
84           "environment": "LIVE",
85           "live_prefix": "live_",
86           "merchant_accounts": [
87             "MerchantAccount1",
88             "MerchantAccount2"
89           ],
90           "public_key": "pub_key_adyen_2024",
91           "signing_secret": "sign_secret_adyen_2024"
92         },
93         "stripe": {
94           "public_key": "pk_live_51H8xY2L",
95           "signing_secret": "whsec_1234567890abcdef"
96         }
97       },
98       "e_invoicing": {
99         "mandates": [
100           {
101             "name": "SEPA Direct Debit",
102             "country": "DE",
103             "mappings": [
104               {
105                 "target": "mandate_reference",
106                 "source": "invoice_id",
107                 "description": "Maps invoice ID to mandate reference"
108               }
109             ],
110             "condition_groups": [
111               {
112                 "conditions": [
113                   {
114                     "field": "payment_method",
115                     "comparator_type": "EQUALS",
116                     "value": "SEPA"
117                   }
118                 ]
119               }
120             ],
121             "supported_file_formats": [
122               {
123                 "type": "XML",
124                 "description": "Supports XML format for SEPA mandates"
125               }
126             ]
127           }
128         ],
129         "processor": "AVALARA"
130       },
131       "data_export": {
132         "variant": "S3",
133         "s3": {
134           "bucket_name": "company-payments-data",
135           "bucket_path": "exports/2024/",
136           "bucket_region": "us-east-1"
137         },
138         "bigquery": {
139           "project_id": "company-data-project",
140           "dataset_id": "payments_dataset",
141           "dataset_location": "US",
142           "gcs_bucket_name": "company-bigquery-exports",
143           "gcs_hmac_key_access_id": "hmac-access-id-123",
144           "gcs_hmac_key_secret": "hmac-secret-key-abc"
145         },
146         "gcs": {
147           "bucket_region": "us-central1",
148           "bucket_name": "company-gcs-exports",
149           "bucket_path": "payments/2024/",
150           "flattening": true
151         },
152         "snowflake": {
153           "host": "account123.snowflakecomputing.com",
154           "role": "DATA_ENGINEER",
155           "warehouse": "COMPUTE_WH",
156           "database": "PAYMENTS_DB",
157           "schema": "PUBLIC"
158         }
159       },
160       "tax_calculation": {
161         "billing_entity_id": "be1234567890",
162         "variant": "AVATAX",
163         "ava_tax": {
164           "company_code": "COMPANY123"
165         },
166         "custom_tax_codes": [
167           {
168             "field": "INVOICE_COMMITMENT",
169             "value": "STANDARD"
170           }
171         ],
172         "enable_tax_filing": true
173       },
174       "email_provider": {
175         "variant": "SYSTEM",
176         "mailgun": {
177           "domain": "mg.company.com",
178           "region": "US",
179           "plan": "premium"
180         },
181         "delivery_window": {
182           "type": "DAY",
183           "value": 2
184         },
185         "use_localized_templates": true
186       }
187     },
188     "store_payment_method": true,
189     "auto_charge_payment_method": true,
190     "link": {
191       "expiry_period": {
192         "type": "DAY",
193         "value": 7
194       }
195     },
196     "adyen": {
197       "auto_rescue": {
198         "enabled": true,
199         "period": {
200           "type": "DAY",
201           "value": 3
202         }
203       },
204       "merchant_account": "MerchantAccount1"
205     }
206   },
207   "custom_redirect": {
208     "url": "https://company.com/payment-success"
209   },
210   "status": "ACTIVE"
211 }

Requires the PAYMENT_ACCEPTOR.DELETE 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

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

referencestringformat: "^\S+$"0-256 characters

object_typestring or nullRead-only

idstring or nullRead-only

billing_entity_idstring or null

Resource ID of type BILLING_ENTITY

customer_idstring or null

Resource ID of type CUSTOMER

namestring or nullformat: "^.*$"0-256 characters

descriptionstring or nullformat: "^.*$"0-256 characters

typeenum or null

Allowed values:

bank_accountobject

payment_gatewayobject

custom_redirectobject

statusenum or null

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors