Add payment instrument

post

https://api.sandbox.layer1.com/platform/v1/contacts/{id}/instruments

Adds a new payment instrument (such as a crypto address) to an existing contact. This operation may require approval depending on the trusted address approval settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Contact ID

Body Params

uuid

id for payment instrument

currency

string

currency

description

string

description as supplied by end user

verification

object

The instrument's verification state

updatedAt

date-time

createdAt

date-time

type

string

enum

Allowed:

accountNumber

string

Account number of the bank account

paymentMethods

array of strings

Payment methods available for payment

accountType

string

enum

Type of bank account (CHEQUE, CHECKING, SAVINGS, TRANSMISSION)

Allowed:

intermediaryBanks

array of objects

List of intermediary banks

intermediaryBanks

bank

object

The main recipient bank for the bank account

accountHolderName

object

Name of the account holder if it differs from the contact's name

accountHolderAddress

object

Address of the account holder if it differs from the contact's address

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

*/*

201Payment instrument added successfully

202Payment instrument creation might require approval

400Invalid payment instrument data

401Unauthorized

403Forbidden

404Contact not found

409Approval conflict - similar request already pending approval

428Precondition Required