Create Entity Payment Instrument

post

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

Create or update a payment instrument owned by an organization entity. The entity's first instrument
becomes its default funding instrument; an existing default is never overwritten.

Body Params

CreateEntityPaymentInstrumentRequest describes a payment instrument to create or update.

entityExternalId

string

Legal entity's caller-assigned ID.

entityId

string

Legal 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

BankAccountRequest describes raw bank account details for a payment instrument.
Provide routing details for exactly one payment rail; ach is the only rail
currently supported.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response