Bulk import payment methods

POST https://api.invunion.com/api/v1/payment-methods/bulk payment_methods:write Idempotency-Key Markdown

Import catalog payment methods in bulk.

Creates or attaches up to 500 catalog instruments in one request. Each row needs an iban, identifier, or code. Existing catalog keys are skipped. Counterparty identity follows the same cascade as invoice attach. Unknown instruments without a counterparty park on Unclassified.

Body parameters

Name	Type	Required
`payment_methods` Rows to import. Maximum 500. Each object needs iban, identifier, or code, plus optional counterparty identity fields.	array	Required
`iban` IBAN. One of iban, identifier, or code is required. Example: FR7630006000011234567890189	string Max 50	Recommended
`identifier` Non-IBAN instrument key. Example: [email protected]	string Max 120	Optional
`code` Existing PM-NNN code to look up. Code never creates a new instrument on its own. Example: PM-001	string Max 50	Recommended
`name` Display name. Defaults from the counterparty name or the instrument key. Example: Leones Cars EUR	string No maximum	Optional
`type` Instrument type. Default bank_account when an IBAN is present.	string No maximum	Recommended
Allowed values`bank_accountcredit_cardpaypalwerotwintcrypto_walletother`
`bic` BIC. Example: BNPAFRPP	string Max 11	Optional
`currency` ISO 4217 currency. Default EUR. Example: EUR	string Max 3	Optional
`is_own_account` If true, import as a company account on an Internal counterparty. own_account is accepted as an alias. Allowed values`truefalse`	boolean	Optional
`counterparty_id` Existing counterparty code (`account_code`). Example: CPT-042	string No maximum	Recommended
`association_mode` exclusive (one owner) or shared (several counterparties). Default exclusive. Allowed values`exclusiveshared`	string No maximum	Recommended
`account_code` Counterparty account_code for identity lookup. Example: CPT-042	string Max 50	Optional
`counterparty_name` Counterparty name used for identity lookup and, if needed, create. Example: Leones Cars	string No maximum	Optional
`external_reference` Counterparty external reference. Example: ERP-1842	string Max 255	Optional
`vat_number` Counterparty VAT number. Example: FR12345678901	string Max 50	Optional
`email` Counterparty email. Example: [email protected]	string No maximum	Optional

Errors

This operation can return the following errors in addition to generic HTTP failures.

Error	HTTP code	Description
`Missing Bearer token`	401	The Authorization header is missing or is not a Bearer token.
`Invalid or revoked API key`	401	The API key is unknown, malformed, expired, or has been revoked.
`API key is missing scope payment_methods:write`	403	The key does not include payment_methods:write. A write scope does not imply the matching read scope.
`Too many requests, please try again later`	429	More than 100 requests in one minute from this API key or IP address. Wait for the Retry-After header (seconds) and retry.
`Tenant ID required`	400	The authenticated credential is not bound to a tenant.
`payment_methods must be a non-empty array`	400	The body is missing payment_methods, or the array is empty.
`Maximum 500 payment methods per bulk import`	400	The array contains more than 500 rows.
`Internal server error`	500	Unexpected server error. The JSON body includes correlationId. Retry with backoff.
`Idempotency-Key must be 8-255 characters: letters, digits, ".", "_", ":" or "-".`	400	The Idempotency-Key header is present but malformed.
`A request with this Idempotency-Key is still being processed.`	409	The first request with this key has not finished. Retry after it completes. code is idempotency_in_progress.
`This Idempotency-Key was already used with a different request body.`	422	Send a new key for a different request. code is idempotency_key_reuse.

Previous: Create payment method Next: Link counterparty