Create Client Payment Instrument

post

https://connect.digits.com/v1/organization/clients/payment-instruments

Create or update a payment instrument owned by a client entity.

Requires scope: organization:sync.

Body Params

CreateClientPaymentInstrumentRequest describes a client-scoped payment instrument to create or update.

clientOrganizationExternalId

string

Client organization's caller-assigned ID.

clientOrganizationId

string

Client organization's Digits-assigned ID.

clientEntityExternalId

string

Client entity's caller-assigned ID.

clientEntityId

string

Client entity's Digits-assigned ID.

externalId

string

required

Caller-assigned identifier for idempotent upsert of the payment instrument.

currencyCode

string

The ISO 4217 currency code for the instrument.

nickname

string

User-provided nickname for the instrument.

userId

string

User's Digits-assigned ID.

userExternalId

string

User's caller-assigned ID, resolved on the backend.

fundsFlow

string

enum

required

Whether payments using this instrument are Digits-managed or managed externally by the source.
Only ExternallyManaged is currently supported.

Allowed:

bankAccount

object

Bank account details for a funding instrument.

Responses

200OK