Update the payment acceptor

PATCH

/v:version/payment-acceptors/:resourceId

PATCH

/v:version/payment-acceptors/:resourceId

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

1 {
2   "reference": "PA-20240601-001",
3   "object_type": "payment_acceptor",
4   "id": "pa_1234567890abcdef",
5   "billing_entity_id": "be_9876543210fedcba",
6   "name": "Main Corporate Bank Account",
7   "description": "Primary bank account for corporate transactions",
8   "type": "BANK_ACCOUNT",
9   "bank_account": {
10     "type": "IBAN",
11     "iban": "GB82WEST12345698765432",
12     "country": "GB",
13     "bic": "WESTGB2L",
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": "WESTGB2L"
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": "intg_abcdef123456",
45     "collection_type": "LINK",
46     "integration": {
47       "reference": "PG-Stripe-001",
48       "name": "Stripe Payment Gateway",
49       "description": "Integration with Stripe for payment processing",
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": "pg_abcdef123456",
64       "status": "DRAFT",
65       "message": "Pending activation",
66       "authentication": {
67         "api_key": {
68           "header": "Authorization",
69           "value": "sk_live_4eC39HqLyjWDarjtT1zdp7dc"
70         },
71         "client_credentials": {
72           "client_id": "client_1234567890",
73           "client_secret": "secret_0987654321"
74         },
75         "username_password": {
76           "username": "apiuser",
77           "password": "securepassword123"
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           ],
89           "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A...\n-----END PUBLIC KEY-----",
90           "signing_secret": "s3cr3tS1gn1ngK3y"
91         },
92         "stripe": {
93           "public_key": "pk_live_51H8xY2Lz...",
94           "signing_secret": "whsec_1234567890abcdef"
95         }
96       },
97       "e_invoicing": {
98         "mandates": [
99           {
100             "name": "SEPA Direct Debit",
101             "country": "DE",
102             "mappings": [
103               {
104                 "target": "mandate_reference",
105                 "source": "invoice_id",
106                 "description": "Map invoice ID to mandate reference"
107               }
108             ],
109             "condition_groups": [
110               {
111                 "conditions": [
112                   {
113                     "field": "payment_method",
114                     "comparator_type": "EQUALS",
115                     "value": "SEPA"
116                   }
117                 ]
118               }
119             ],
120             "supported_file_formats": [
121               {
122                 "type": "XML",
123                 "description": "Supports XML format for SEPA mandates"
124               }
125             ]
126           }
127         ],
128         "processor": "AVALARA"
129       },
130       "data_export": {
131         "variant": "S3",
132         "s3": {
133           "bucket_name": "company-payment-exports",
134           "bucket_path": "exports/2024/06",
135           "bucket_region": "us-east-1"
136         },
137         "bigquery": {
138           "project_id": "company-data-project",
139           "dataset_id": "payment_data",
140           "dataset_location": "US",
141           "gcs_bucket_name": "company-gcs-bucket",
142           "gcs_hmac_key_access_id": "hmac-access-id-123",
143           "gcs_hmac_key_secret": "hmac-secret-key-abc"
144         },
145         "gcs": {
146           "bucket_region": "us-central1",
147           "bucket_name": "company-gcs-bucket",
148           "bucket_path": "payment_exports/2024/06",
149           "flattening": true
150         },
151         "snowflake": {
152           "host": "sfaccount.snowflakecomputing.com",
153           "role": "DATA_ENGINEER",
154           "warehouse": "COMPUTE_WH",
155           "database": "PAYMENTS_DB",
156           "schema": "PUBLIC"
157         }
158       },
159       "tax_calculation": {
160         "billing_entity_id": "be_9876543210fedcba",
161         "variant": "AVATAX",
162         "ava_tax": {
163           "company_code": "COMPANY123"
164         },
165         "custom_tax_codes": [
166           {
167             "field": "INVOICE_COMMITMENT",
168             "value": "STANDARD"
169           }
170         ],
171         "enable_tax_filing": true
172       },
173       "email_provider": {
174         "variant": "SYSTEM",
175         "mailgun": {
176           "domain": "mg.company.com",
177           "region": "US",
178           "plan": "premium"
179         },
180         "delivery_window": {
181           "type": "DAY",
182           "value": 1
183         },
184         "use_localized_templates": true
185       }
186     },
187     "store_payment_method": true,
188     "auto_charge_payment_method": true,
189     "link": {
190       "expiry_period": {
191         "type": "DAY",
192         "value": 1
193       }
194     },
195     "adyen": {
196       "auto_rescue": {
197         "enabled": true,
198         "period": {
199           "type": "DAY",
200           "value": 1
201         }
202       },
203       "merchant_account": "MerchantAccount1"
204     }
205   },
206   "custom_redirect": {
207     "url": "https://company.com/payment-success"
208   },
209   "status": "DRAFT"
210 }

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

Request

This endpoint expects an object.

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

billing_entity_idstring or nullOptional

Resource ID of type BILLING_ENTITY

customer_idstring or nullOptional

Resource ID of type CUSTOMER

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

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

typeenum or nullOptional

Allowed values:

bank_accountobjectOptional

payment_gatewayobjectOptional

custom_redirectobjectOptional

statusenum or nullOptional

Allowed values:

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

Request

Response

Errors