HomeGuidesAPI ReferenceChangelog
Log In
API Reference
  1. Braid API
  2. Counterparty

Create a payment instrument for an existing counterparty

post
https://api.sandbox.braid.zone/v2/counterparty//paymentInstrument
Path Params
integer
required

CounterpartyId

Body Params

Counterparty payment instruments

int32 | null

ID of existing payment instrument for update

paymentInstrumentTypes
array of strings

Payment instruments types

paymentInstrumentTypes
Allowed:
string

Account number of the payment instrument

string
enum

Type of identifier for the beneficiary's financial institution

Allowed:
string

Identifier for the beneficiary's financial institution

string
enum

Type of the bank account

Allowed:
string | null
enum

Type of identifier for the correspondent's financial institution

Allowed:
string | null

Identifier for the corespondent's financial institution

boolean

Whether FX is enabled for this wire payment instrument

string

ISO-4217 currency code for the beneficiary account. Required when fxEnabled=true, must be null otherwise.

string | null

Additional bank code (optional, may be required for some FX currency/country combinations)

string | null

Additional code (optional, may be required for some FX currency/country combinations)

string | null

Bank branch code (optional, may be required for some FX currency/country combinations)

string | null

Bank branch name (optional, may be required for some FX currency/country combinations)

string | null

Beneficiary bank IBAN (optional, may be required for some FX currency/country combinations)

string | null

Beneficiary bank tax ID (optional, may be required for some FX currency/country combinations)

fxAdditionalFields
object

Blocked Results in JSON format

string | null

Default purpose-of-payment category code for this beneficiary

string | null

Default purpose-of-payment free-text description for this beneficiary

Responses

Updated 10 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 10 days ago

Did this page help you?