Create Counterparty

Create a new counterparty for the purpose of pulling funds into the platform or pushing out

SecurityOAuth2: OAuth2Flow
Request
header Parameters
Authorization
string

OAuth bearer token (see authentication flows)

x-l2f-request-id
string

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

x-l2f-idempotency-id
string

Unique ID used to safely retry an operation. See idempotency section for more details.

Request Body schema: application/json
customer_id
required
string

The customer to which this counter party will be registered for use.

description
string

Description of the counterparty.

counterparty_type
required
string

The type of counterparty will determine the available rails for sending or receiving funds. See the guides for more detailed explanation of counterparty types.

is_international
required
boolean
Default: false

If the counterparty is international set as true

supported_rails
required
Array of strings

The rails required for this counterparty. Rail selection will determine data requirements. See guides for full breakdowns.

Items Enum: "ACH" "FEDWIRE" "SWIFT"
required
object (CounterPartyProfileFIATUS)

Details of the counter party account holder. Required fields are determined by the combination of required rails. See the API Guides for a full documented breakdown of required fields.

required
object (CounterPartyAccountFIATUS)

Details of the counter party account and institution. Required fields are determined by the combination of required needed rails. See the API Guides for a full documented breakdown of required fields.

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

post/v1/counterparties
Request samples
application/json
{
  • "customer_id": "string",
  • "description": "string",
  • "counterparty_type": "FIAT_US",
  • "is_international": false,
  • "supported_rails": [
    ],
  • "profile": {
    },
  • "account_information": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}
© 2023 Layer2 Financial Inc. All Rights Reserved.