Create Bank Account
POST /api/v1/Counterparties/accounts
Description
This endpoint is used to create a new bank account for a counterparty.
Headers:
- None
ApiKey:
- No API key required
Content-Type:
-
text/plain
-
application/json
-
text/json
Path Parameters:
- version: string, required
Request Body:
- CreateCounterpartyBankAccountRequest
URL:
- POST:
{{baseUrl API url}}/api/v1/Counterparties/accounts
Response:
- A CounterpartyBankAccountResponseResponse object containing the details of the newly created bank account for the counterparty.
Error Codes:
-
400: Bad Request
-
404: Resource not found
-
500: Internal server error
Example:
Request:
POST /api/v1/Counterparties/accounts
Content-Type: application/json
{
"counterpartyId": "1234567890",
"accountNumber": "1234567890",
"accountType": "Savings",
"bankName": "Bank A",
"branchCode": "12345",
"countryCode": "US",
"currencyCode": "USD",
"accountHolderName": "John Doe"
}
Response:
HTTP/1.1 200 OK
{
"id": "0987654321",
"accountNumber": "1234567890",
"accountType": "Savings",
"bankName": "Bank A",
"branchCode": "12345",
"countryCode": "US",
"currencyCode": "USD",
"accountHolderName": "John Doe"
}
Method: POST
/api/v1/Counterparties/accounts
Headers
| Content-Type | Value |
|---|---|
Content-Type | application/json |
Headers
| Content-Type | Value |
|---|---|
| Accept | text/plain |
Body (raw)
{
"counterpartyId": "<uuid>",
"account": 5,
"counterpartyType": 1,
"accountType": 4,
"bankCode": "<string>",
"bankName": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"iban": "<string>",
"swiftCode": "<string>",
"bankAddress": "<string>",
"routingNumber": "<string>"
}
Response: 200
{
"succeeded": "<boolean>",
"message": "<string>",
"errors": [
"<string>",
"<string>"
],
"data": {
"id": "<uuid>",
"merchantId": "<uuid>",
"counterpartyId": "<uuid>",
"account": 4,
"counterpartyType": 2,
"accountType": 2,
"bankCode": "<string>",
"bankName": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"iban": "<string>",
"swiftCode": "<string>",
"bankAddress": "<string>",
"routingNumber": "<string>"
}
}
LANGUAGE
CURL REQUEST
curl --request POST \
--url /api/v1/Counterparties/accounts \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!