Create a Destination Account

POST/destination-accounts

Create a new recipient’s account

Body application/json

type"bank_account" | "digital_wallet" | "cash_pickup" | "card"required

Bank account or digital wallet or Cash Pickup or Card For destination account type is card, we disallow to update the information. In case you want to change the card, please call POST /destination-accounts/:destinationAccountId/card-forms to generate a new link for adding card and start adding card process again. Please checkout POST /destination-accounts/:destinationAccountId/card-forms for further notes.

owner_idstring<uuid>

Local currency for this account.

external_idstring

Your own platform’s identifier for this payment destination account.

receiving_institution_idstring<uuid>required

Identifier of a receiving institution which refers to a bank or a digital wallet operator.

currencystring<iso-4217-ext>required

Local currency for this account.

country_codestring<iso-3166-1-alpha3>required

The country associated with the payment destination.

aliasstring

Name or label for this payment destination.

accountobjectrequired

Show account properties

cashpointstring

Receiving Institution Reference Code

recipient_namestring

Recipient Full Name

Identification type (For ARG, CUIT/CUIL = TAX_ID. For COL, Cedula de Ciudadania = NATIONAL_ID, NIT = TAX_ID, passport = PASSPORT)

recipient_identification_numberstring

Identification number

recipient_nationalitystring<iso-3166-1-alpha3>

Nationality

recipient_addressstring

Residence address

recipient_province_statestring

Residence State/Province

recipient_citystring

Residence city

recipient_emailstring

Email address

recipient_date_of_birthstring<date>

Date of birth

recipient_identification_issuerstring

Identification issuer

recipient_identification_issue_datestring<date>

Identification issue date

recipient_identification_expiry_datestring<date>

Identification expiry date

recipient_gender"female" | "male"

Gender

recipient_zip_codestring

Residence address zip code or postal code

mobile_numberstring

account_namestring

Bank account holder’s full name.

account_numberstring

Bank account number.

The bank account number’s format.

bank_account_type"SAVINGS" | "CHECKING"

The bank account type.

routing_codestring

additional_routing_codestring

branch_codestring

bank_namestring

The network that can be used for transferring funds to this account

intermediary_bank_detailsobject

Show intermediary_bank_details properties

routing_code_type"SWIFT-BIC"

Routing code type for intermedary bank details

routing_code_valuestring

Routing code value for intermedary bank details

bank_namestring

Intermedary bank name

addressobject

Intermediay bank address defines intermediary bank address used for intermediary bank

Show address properties

address_line_1string

Address line 1 of bank address

address_line_2string

Address line 2 of bank address

citystring

City of the intermediary bank address

statestring

State of the intermediary bank address

zip_codestring

Zip code of intermediary bank address

country_codestring

Country code of intermediary bank address

Response

Created

idstring

type"bank_account" | "digital_wallet" | "cash_pickup" | "card"

Type of destination account

owner_idstring<uuid>

external_idstring

Your own platform’s identifier for this payment destination account.

receiving_institution_idstring<uuid>

Identifier of a receiving institution which refers to a bank or a digital wallet operator.

currencystring<iso-4217>

Local currency for this account.

country_codestring<iso-3166-1-alpha3>

The country associated with the payment destination.

aliasstring

Name or label for this payment destination.

archivedboolean

No past payment destinations can be deleted, however they can be disabled so they can be avoided for use.

accountobject

Show account properties

cashpointstring

Receiving Institution Reference Code

recipient_namestring

Recipient Full Name

Identification type (For ARG, CUIT/CUIL = TAX_ID. For COL, Cedula de Ciudadania = NATIONAL_ID, NIT = TAX_ID, passport = PASSPORT)

recipient_identification_numberstring

Identification number

recipient_nationalitystring<iso-3166-1-alpha3>

Nationality

recipient_addressstring

Residence address

recipient_province_statestring

Residence State/Province

recipient_citystring

Residence city

recipient_emailstring

Email address

recipient_date_of_birthstring<date>

Date of birth

recipient_identification_issuerstring

Identification issuer

recipient_identification_issue_datestring<date>

Identification issue date

recipient_identification_expiry_datestring<date>

Identification expiry date

recipient_gender"female" | "male"

Gender

recipient_zip_codestring

Residence address zip code or postal code

mobile_numberstring

account_namestring

Bank account holder’s full name.

account_numberstring

Bank account number.

The bank account number’s format.

bank_account_type"SAVINGS" | "CHECKING"

The bank account type.

routing_codestring

additional_routing_codestring

branch_codestring

bank_namestring

The network that can be used for transferring funds to this account

intermediary_bank_detailsobject

Show intermediary_bank_details properties

routing_code_type"SWIFT-BIC"

Routing code type for intermedary bank details

routing_code_valuestring

Routing code value for intermedary bank details

bank_namestring

Intermedary bank name

addressobject

Intermediay bank address defines intermediary bank address used for intermediary bank

Show address properties

address_line_1string

Address line 1 of bank address

address_line_2string

Address line 2 of bank address

citystring

City of the intermediary bank address

statestring

State of the intermediary bank address

zip_codestring

Zip code of intermediary bank address

country_codestring

Country code of intermediary bank address

created_atstring<date>

updated_atstring<date-time>

statusstring

reasonstring

reason_codestring

deleted_atstring<date>

expires_atstring<date>

used_atstring<date>

submitted_atstring<date>

charged_atstring<date>

hosted_urlstring<uri>

The link to the card adding form (front end). Card form is only valid for a certain time. To generate the new link, please call POST /destination-accounts/{accountId}/card_form. Please checkout the note for that api

Error defines errors may be returned from the system.

messagestring

errorsobject[]

Show errors properties

errorCodestring

messagestring

Error defines errors may be returned from the system.

messagestring

errorsobject[]

Show errors properties

errorCodestring

messagestring

Error defines errors may be returned from the system.

messagestring

errorsobject[]

Show errors properties

errorCodestring

messagestring

Error defines errors may be returned from the system.

messagestring

errorsobject[]

Show errors properties

errorCodestring

messagestring

curl -X POST "https://api.uat.triple-a.io/api/fiat-payout/v1/destination-accounts" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <token>" \ -d '{ "type": "bank_account", "owner_id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "receiving_institution_id": "00000000-0000-0000-0000-000000000000", "currency": "USD", "country_code": "USA", "alias": "Account 1", "account": { "cashpoint": "string", "recipient_name": "string", "recipient_identification_type": "NATIONAL_ID", "recipient_identification_number": "S98765433X", "recipient_nationality": "SGP", "recipient_address": "1 Falcon Ave, California", "recipient_province_state": "New York", "recipient_city": "New York City", "recipient_email": "jamse.zhang@example.com", "recipient_date_of_birth": "2019-08-24", "recipient_identification_issuer": "City hall", "recipient_identification_issue_date": "2019-08-24", "recipient_identification_expiry_date": "2025-08-24", "recipient_gender": "female", "recipient_zip_code": "12345", "mobile_number": "string", "account_name": "John Zuckerberg", "account_number": "9876543201", "account_type": "IBAN", "bank_account_type": "SAVINGS", "routing_type": "SWIFT-BIC", "routing_code": "string", "additional_routing_type": "SWIFT-BIC", "additional_routing_code": "string", "branch_code": "string", "bank_name": "string", "network": "network:local" }, "intermediary_bank_details": { "routing_code_type": "SWIFT-BIC", "routing_code_value": "BKENGB2LXXX", "bank_name": "Bank of England", "address": { "address_line_1": "1600 Amphitheatre Parkway", "address_line_2": "Building 43", "city": "Mountain View", "state": "California", "zip_code": "94043", "country_code": "USA" } } }'

const response = await fetch(`https://api.uat.triple-a.io/api/fiat-payout/v1/destination-accounts`, { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer <token>' }, body: JSON.stringify({ "type": "bank_account", "owner_id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "receiving_institution_id": "00000000-0000-0000-0000-000000000000", "currency": "USD", "country_code": "USA", "alias": "Account 1", "account": { "cashpoint": "string", "recipient_name": "string", "recipient_identification_type": "NATIONAL_ID", "recipient_identification_number": "S98765433X", "recipient_nationality": "SGP", "recipient_address": "1 Falcon Ave, California", "recipient_province_state": "New York", "recipient_city": "New York City", "recipient_email": "jamse.zhang@example.com", "recipient_date_of_birth": "2019-08-24", "recipient_identification_issuer": "City hall", "recipient_identification_issue_date": "2019-08-24", "recipient_identification_expiry_date": "2025-08-24", "recipient_gender": "female", "recipient_zip_code": "12345", "mobile_number": "string", "account_name": "John Zuckerberg", "account_number": "9876543201", "account_type": "IBAN", "bank_account_type": "SAVINGS", "routing_type": "SWIFT-BIC", "routing_code": "string", "additional_routing_type": "SWIFT-BIC", "additional_routing_code": "string", "branch_code": "string", "bank_name": "string", "network": "network:local" }, "intermediary_bank_details": { "routing_code_type": "SWIFT-BIC", "routing_code_value": "BKENGB2LXXX", "bank_name": "Bank of England", "address": { "address_line_1": "1600 Amphitheatre Parkway", "address_line_2": "Building 43", "city": "Mountain View", "state": "California", "zip_code": "94043", "country_code": "USA" } } }) }); const data = await response.json();

import requests response = requests.request( "POST", "https://api.uat.triple-a.io/api/fiat-payout/v1/destination-accounts", headers={ "Authorization": "Bearer <token>" }, json={ "type": "bank_account", "owner_id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "receiving_institution_id": "00000000-0000-0000-0000-000000000000", "currency": "USD", "country_code": "USA", "alias": "Account 1", "account": { "cashpoint": "string", "recipient_name": "string", "recipient_identification_type": "NATIONAL_ID", "recipient_identification_number": "S98765433X", "recipient_nationality": "SGP", "recipient_address": "1 Falcon Ave, California", "recipient_province_state": "New York", "recipient_city": "New York City", "recipient_email": "jamse.zhang@example.com", "recipient_date_of_birth": "2019-08-24", "recipient_identification_issuer": "City hall", "recipient_identification_issue_date": "2019-08-24", "recipient_identification_expiry_date": "2025-08-24", "recipient_gender": "female", "recipient_zip_code": "12345", "mobile_number": "string", "account_name": "John Zuckerberg", "account_number": "9876543201", "account_type": "IBAN", "bank_account_type": "SAVINGS", "routing_type": "SWIFT-BIC", "routing_code": "string", "additional_routing_type": "SWIFT-BIC", "additional_routing_code": "string", "branch_code": "string", "bank_name": "string", "network": "network:local" }, "intermediary_bank_details": { "routing_code_type": "SWIFT-BIC", "routing_code_value": "BKENGB2LXXX", "bank_name": "Bank of England", "address": { "address_line_1": "1600 Amphitheatre Parkway", "address_line_2": "Building 43", "city": "Mountain View", "state": "California", "zip_code": "94043", "country_code": "USA" } } }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.uat.triple-a.io/api/fiat-payout/v1/destination-accounts"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json", "Authorization: Bearer <token>"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "type": "bank_account", "owner_id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "receiving_institution_id": "00000000-0000-0000-0000-000000000000", "currency": "USD", "country_code": "USA", "alias": "Account 1", "account": { "cashpoint": "string", "recipient_name": "string", "recipient_identification_type": "NATIONAL_ID", "recipient_identification_number": "S98765433X", "recipient_nationality": "SGP", "recipient_address": "1 Falcon Ave, California", "recipient_province_state": "New York", "recipient_city": "New York City", "recipient_email": "jamse.zhang@example.com", "recipient_date_of_birth": "2019-08-24", "recipient_identification_issuer": "City hall", "recipient_identification_issue_date": "2019-08-24", "recipient_identification_expiry_date": "2025-08-24", "recipient_gender": "female", "recipient_zip_code": "12345", "mobile_number": "string", "account_name": "John Zuckerberg", "account_number": "9876543201", "account_type": "IBAN", "bank_account_type": "SAVINGS", "routing_type": "SWIFT-BIC", "routing_code": "string", "additional_routing_type": "SWIFT-BIC", "additional_routing_code": "string", "branch_code": "string", "bank_name": "string", "network": "network:local" }, "intermediary_bank_details": { "routing_code_type": "SWIFT-BIC", "routing_code_value": "BKENGB2LXXX", "bank_name": "Bank of England", "address": { "address_line_1": "1600 Amphitheatre Parkway", "address_line_2": "Building 43", "city": "Mountain View", "state": "California", "zip_code": "94043", "country_code": "USA" } } }'); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("POST", "https://api.uat.triple-a.io/api/fiat-payout/v1/destination-accounts", strings.NewReader(`{ "type": "bank_account", "owner_id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "receiving_institution_id": "00000000-0000-0000-0000-000000000000", "currency": "USD", "country_code": "USA", "alias": "Account 1", "account": { "cashpoint": "string", "recipient_name": "string", "recipient_identification_type": "NATIONAL_ID", "recipient_identification_number": "S98765433X", "recipient_nationality": "SGP", "recipient_address": "1 Falcon Ave, California", "recipient_province_state": "New York", "recipient_city": "New York City", "recipient_email": "jamse.zhang@example.com", "recipient_date_of_birth": "2019-08-24", "recipient_identification_issuer": "City hall", "recipient_identification_issue_date": "2019-08-24", "recipient_identification_expiry_date": "2025-08-24", "recipient_gender": "female", "recipient_zip_code": "12345", "mobile_number": "string", "account_name": "John Zuckerberg", "account_number": "9876543201", "account_type": "IBAN", "bank_account_type": "SAVINGS", "routing_type": "SWIFT-BIC", "routing_code": "string", "additional_routing_type": "SWIFT-BIC", "additional_routing_code": "string", "branch_code": "string", "bank_name": "string", "network": "network:local" }, "intermediary_bank_details": { "routing_code_type": "SWIFT-BIC", "routing_code_value": "BKENGB2LXXX", "bank_name": "Bank of England", "address": { "address_line_1": "1600 Amphitheatre Parkway", "address_line_2": "Building 43", "city": "Mountain View", "state": "California", "zip_code": "94043", "country_code": "USA" } } }`)) req.Header.Set("Content-Type", "application/json") req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.uat.triple-a.io/api/fiat-payout/v1/destination-accounts")) .header("Content-Type", "application/json") .header("Authorization", "Bearer <token>") .method("POST", HttpRequest.BodyPublishers.ofString("{\n \"type\": \"bank_account\",\n \"owner_id\": \"00000000-0000-0000-0000-000000000000\",\n \"external_id\": \"string\",\n \"receiving_institution_id\": \"00000000-0000-0000-0000-000000000000\",\n \"currency\": \"USD\",\n \"country_code\": \"USA\",\n \"alias\": \"Account 1\",\n \"account\": {\n \"cashpoint\": \"string\",\n \"recipient_name\": \"string\",\n \"recipient_identification_type\": \"NATIONAL_ID\",\n \"recipient_identification_number\": \"S98765433X\",\n \"recipient_nationality\": \"SGP\",\n \"recipient_address\": \"1 Falcon Ave, California\",\n \"recipient_province_state\": \"New York\",\n \"recipient_city\": \"New York City\",\n \"recipient_email\": \"jamse.zhang@example.com\",\n \"recipient_date_of_birth\": \"2019-08-24\",\n \"recipient_identification_issuer\": \"City hall\",\n \"recipient_identification_issue_date\": \"2019-08-24\",\n \"recipient_identification_expiry_date\": \"2025-08-24\",\n \"recipient_gender\": \"female\",\n \"recipient_zip_code\": \"12345\",\n \"mobile_number\": \"string\",\n \"account_name\": \"John Zuckerberg\",\n \"account_number\": \"9876543201\",\n \"account_type\": \"IBAN\",\n \"bank_account_type\": \"SAVINGS\",\n \"routing_type\": \"SWIFT-BIC\",\n \"routing_code\": \"string\",\n \"additional_routing_type\": \"SWIFT-BIC\",\n \"additional_routing_code\": \"string\",\n \"branch_code\": \"string\",\n \"bank_name\": \"string\",\n \"network\": \"network:local\"\n },\n \"intermediary_bank_details\": {\n \"routing_code_type\": \"SWIFT-BIC\",\n \"routing_code_value\": \"BKENGB2LXXX\",\n \"bank_name\": \"Bank of England\",\n \"address\": {\n \"address_line_1\": \"1600 Amphitheatre Parkway\",\n \"address_line_2\": \"Building 43\",\n \"city\": \"Mountain View\",\n \"state\": \"California\",\n \"zip_code\": \"94043\",\n \"country_code\": \"USA\"\n }\n }\n}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.uat.triple-a.io/api/fiat-payout/v1/destination-accounts") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/json" request["Authorization"] = "Bearer <token>" request.body = "{\n \"type\": \"bank_account\",\n \"owner_id\": \"00000000-0000-0000-0000-000000000000\",\n \"external_id\": \"string\",\n \"receiving_institution_id\": \"00000000-0000-0000-0000-000000000000\",\n \"currency\": \"USD\",\n \"country_code\": \"USA\",\n \"alias\": \"Account 1\",\n \"account\": {\n \"cashpoint\": \"string\",\n \"recipient_name\": \"string\",\n \"recipient_identification_type\": \"NATIONAL_ID\",\n \"recipient_identification_number\": \"S98765433X\",\n \"recipient_nationality\": \"SGP\",\n \"recipient_address\": \"1 Falcon Ave, California\",\n \"recipient_province_state\": \"New York\",\n \"recipient_city\": \"New York City\",\n \"recipient_email\": \"jamse.zhang@example.com\",\n \"recipient_date_of_birth\": \"2019-08-24\",\n \"recipient_identification_issuer\": \"City hall\",\n \"recipient_identification_issue_date\": \"2019-08-24\",\n \"recipient_identification_expiry_date\": \"2025-08-24\",\n \"recipient_gender\": \"female\",\n \"recipient_zip_code\": \"12345\",\n \"mobile_number\": \"string\",\n \"account_name\": \"John Zuckerberg\",\n \"account_number\": \"9876543201\",\n \"account_type\": \"IBAN\",\n \"bank_account_type\": \"SAVINGS\",\n \"routing_type\": \"SWIFT-BIC\",\n \"routing_code\": \"string\",\n \"additional_routing_type\": \"SWIFT-BIC\",\n \"additional_routing_code\": \"string\",\n \"branch_code\": \"string\",\n \"bank_name\": \"string\",\n \"network\": \"network:local\"\n },\n \"intermediary_bank_details\": {\n \"routing_code_type\": \"SWIFT-BIC\",\n \"routing_code_value\": \"BKENGB2LXXX\",\n \"bank_name\": \"Bank of England\",\n \"address\": {\n \"address_line_1\": \"1600 Amphitheatre Parkway\",\n \"address_line_2\": \"Building 43\",\n \"city\": \"Mountain View\",\n \"state\": \"California\",\n \"zip_code\": \"94043\",\n \"country_code\": \"USA\"\n }\n }\n}" response = http.request(request) puts response.body

{ "id": "string", "type": "bank_account", "owner_id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "receiving_institution_id": "00000000-0000-0000-0000-000000000000", "currency": "USD", "country_code": "USA", "alias": "Account 1", "archived": false, "account": { "cashpoint": "string", "recipient_name": "string", "recipient_identification_type": "NATIONAL_ID", "recipient_identification_number": "S98765433X", "recipient_nationality": "SGP", "recipient_address": "1 Falcon Ave, California", "recipient_province_state": "New York", "recipient_city": "New York City", "recipient_email": "jamse.zhang@example.com", "recipient_date_of_birth": "2019-08-24", "recipient_identification_issuer": "City hall", "recipient_identification_issue_date": "2019-08-24", "recipient_identification_expiry_date": "2025-08-24", "recipient_gender": "female", "recipient_zip_code": "12345", "mobile_number": "string", "account_name": "John Zuckerberg", "account_number": "9876543201", "account_type": "IBAN", "bank_account_type": "SAVINGS", "routing_type": "SWIFT-BIC", "routing_code": "string", "additional_routing_type": "SWIFT-BIC", "additional_routing_code": "string", "branch_code": "string", "bank_name": "string", "network": "network:local" }, "intermediary_bank_details": { "routing_code_type": "SWIFT-BIC", "routing_code_value": "BKENGB2LXXX", "bank_name": "Bank of England", "address": { "address_line_1": "1600 Amphitheatre Parkway", "address_line_2": "Building 43", "city": "Mountain View", "state": "California", "zip_code": "94043", "country_code": "USA" } }, "created_at": "2024-01-01", "updated_at": "1970-01-01T00:00:00.000Z", "status": "string", "reason": "string", "reason_code": "string", "deleted_at": "2024-01-01", "expires_at": "2024-01-01", "used_at": "2024-01-01", "submitted_at": "2024-01-01", "charged_at": "2024-01-01", "hosted_url": "string" }