Link counterparty

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

Associate a counterparty with a shared payment method.

Adds a counterparty to a shared catalog instrument. The payment method must already be in shared association_mode. Parked instruments cannot be shared. Linking an already-associated counterparty is idempotent.

Path parameters

Name Type Required

code

Payment method code (code).

Example: PM-001

string

Max 50

Required

Body parameters

Name Type Required

counterparty_id

Counterparty code (account_code) to associate.

Example: CPT-042

string

No maximum

Required

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.
`counterparty_id is required`	400	The body does not include counterparty_id.
`Tenant ID required`	400	The authenticated credential is not bound to a tenant.
`Payment method is not shareable`	409	The instrument is exclusive, parked, or otherwise cannot accept another association.
`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: Bulk import payment methods Next: Update payment method