List Transfers

GET/transfers

This endpoint allows API users to retrieve a list of transfers they made.

Query Parameters

pageinteger

Specify the page number

per_pageinteger

Specify the number of items per page

external_idstring

Response

idstring<uuid>

Transfer Identifier

source_transfer_idstring<uuid>

The ID of the original transfer this transfer was retried from. Only present on retry transfers.

external_idstring

Transfer Reference provided by API caller

sender_idstring<uuid>

Identifier of the sender (a Individual or company)

recipient_idstring<uuid>

Identifier of the recipient (a Individual or company)

destination_account_idstring<uuid>

DestinationAccount Identifier

destination_accountobject

A DestinationAccount is bank account or digital wallet account to receive a local currency transfer.

Show destination_account properties

idstring<uuid>

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-time>

updated_atstring<date-time>

mode"sending" | "receiving"

sending mode allow users to specify the sending_amount and get a quote for receiving_amount; receiving mode allows users to specify the receiving_amount and get a quote for sending_amount.

sending_amountnumber<double>

Sending amount

sending_currencystring<iso-4217-ext>

Sending Currency which is defined by /currencies.

receiving_amountnumber<double>

Receiving amount

receiving_currencystring<iso-4217-ext>

Receiving Currency which is defined by /currencies.

Receiving Currency which is defined by /currencies. If OTHER is used, it could cause extended delays

Receiving Currency which is defined by /currencies.

Relationship between sender and recipient

remarksstring

Remarks or notes

transaction_pinstring

A PIN related the transfer, e.g. Cash Pickup PIN

exchange_ratenumber<double>

The exchange rate from sending currency to receiving currency, e.g. 1 BTC = 57151.5 USD.

Transfer Status

sub_status"none" | "ambiguous" | "invalid_parameters" | "declined_by_provider" | "reversed_by_provider"

Transfer SubStatus

error_descstring

Transfer error description / decline reason

error_code"E001" | "E002" | "E003" | "E004" | "E005" | "E006" | "E007" | "E008" | "E010" | "E011" | "E012" | "E013" | "E014" | "E015" | "E016" | "E017" | "E018" | "E019" | "E020" | "E022" | "E023" | "E024" | "E025" | "E026" | "E027" | "E028" | "E029" | "E030" | "E031" | "E032" | "E033" | "E034" | "E035" | "E036" | "E037" | "E038" | "E041" | "E042" | "E043" | "E044" | "E045" | "E048" | "E049" | "E052" | "E053" | "E054" | "E059" | "E060" | "E061" | "E063" | "E064" | "E065" | "E066" | "E067" | "E069" | "E072" | "E073" | "E074" | "E075" | "E076" | "E077"

Transfer error code

balance_idstring<uuid>

This indicates which balance is used for this transfer

balance_debit_amountnumber<double>

This indicates the amount which will be debit from merchant’s balance with balance_id for this transfer.

balance_currencystring<iso-4217-ext>

Iso-4217 for fiat_money (i.e., local currency), non-iso-4217 listed here (https://en.wikipedia.org/wiki/ISO_4217) for cyptocurrency’

feenumber<double>

This indicates the amount which will be debit from merchant’s balance as a transaction fee with balance_id for this transfer. This includes VAT and intermediary bank fee (if applicable).

fee_currencystring<iso-4217-ext>

currency for transaction fee; where ISO-4217 for fiat_money (i.e., local currency), non-iso-4217 listed here (https://en.wikipedia.org/wiki/ISO_4217) for cyptocurrency’

vatnumber<double>

This indicates the VAT amount calculated on agreed pricing fee.

vat_percentagenumber<double>

This indicates the VAT percentage is used to calculate VAT fee on agreed pricing fee.

sending_amount_returnednumber<double>

This indicates the sending amount which will be returned to merchant’s balance with balance_id for this transfer when the transfer is failed (rejected, cancelled, declined and reversed).

fee_returnednumber<double>

This indicates the transaction fee amount which will be returned to merchant’s balance with balance_id for this transfer when the transfer is failed (rejected, cancelled and declined); for transfers are reversed, this will be 0.

expires_atstring<date-time>

Creation Timestamp

created_atstring<date-time>

Creation Timestamp

updated_atstring<date-time>

Update Timestamp

charge_type"OUR" | "SHA"

To specify which party bears the bank fee. OUR means that the initiator will pay the fee, which means an additional fee when you create the transfer. SHA means that both the initiator and the recipient will pay the fee. Some fees will be deducted from the amount sent by the intermediary banks

intermediary_bank_feenumber<double>

Indicates the intermediary bank charge. It will follow the sending currency.

paymentobject

Payment

Show payment properties

idstring<uuid>

Payment Identifier

statusstring

Payment status

reasonstring<uuid>

Failed/Declined Reason

urlstring

CDN of payment page

crypto_addressstring

Cryptocurrency token address

crypto_currencystring

Cryptocurrency value

crypto_networkstring

The blockchain to use to pay

expires_atstring<date-time>

The expiration of the address

card_issuer_countrystring

The issuer country of card if payment is made via card

reference_numberstring

Payment reference number

ibanstring

IBAN

card_formobject

Only present for Card Destination Account

Show card_form properties

idstring

statusstring

reasonstring

reason_codestring

created_atstring<date>

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

conditionsobject

Conditions that a transfer must meet before it can be processed

Show conditions properties

document_typesobject

Show document_types properties

transfer_purposestring

documentsobject[]

Show documents properties

idstring<uuid>

external_idstring

A reference to the document given by API caller

owner_idstring<uuid>

The ID of an individual or company who owns the document.

category"identity_verification"

More categories will be added over time.

document_type"passport" | "national_id" | "selfie_photo" | "kyc_provider_result"

The type kyc_provider_result can be used to upload reports from the 3rd party KYC providers.

mime_typestring

The type kyc_provider_result can be used to upload reports from the 3rd party KYC providers.

file_namestring

file_idstring

status"none" | "valid" | "pending" | "rejected" | "expired"

expires_atstring<date-time>

Time of expiry of the validity of this identity document.

created_atstring<date-time>

updated_atstring<date-time>

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.uat.triple-a.io/api/fiat-payout/v1/transfers"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://api.uat.triple-a.io/api/fiat-payout/v1/transfers", nil) 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/transfers")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .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/transfers") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body

[ { "id": "00000000-0000-0000-0000-000000000000", "source_transfer_id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "sender_id": "00000000-0000-0000-0000-000000000000", "recipient_id": "00000000-0000-0000-0000-000000000000", "destination_account_id": "00000000-0000-0000-0000-000000000000", "destination_account": { "id": "00000000-0000-0000-0000-000000000000", "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": "1970-01-01T00:00:00.000Z", "updated_at": "1970-01-01T00:00:00.000Z" }, "mode": "sending", "sending_amount": 0.001, "sending_currency": "BTC", "receiving_amount": 57.15, "receiving_currency": "USD", "purpose_of_remittance": "FAMILY_SUPPORT", "source_of_funds": "SALARY", "relationship": "FATHER", "remarks": "string", "transaction_pin": "string", "exchange_rate": 57151.5, "status": "created", "sub_status": "none", "error_desc": "string", "error_code": "E001", "balance_id": "00000000-0000-0000-0000-000000000000", "balance_debit_amount": 57.15, "balance_currency": "USD", "fee": 57.15, "fee_currency": "USD", "vat": 57.15, "vat_percentage": 57.15, "sending_amount_returned": 57.15, "fee_returned": 57.15, "expires_at": "1970-01-01T00:00:00.000Z", "created_at": "1970-01-01T00:00:00.000Z", "updated_at": "1970-01-01T00:00:00.000Z", "charge_type": "SHA", "intermediary_bank_fee": 25, "payment": { "id": "00000000-0000-0000-0000-000000000000", "status": "string", "reason": "00000000-0000-0000-0000-000000000000", "url": "string", "crypto_address": "string", "crypto_currency": "string", "crypto_network": "string", "expires_at": "1970-01-01T00:00:00.000Z", "card_issuer_country": "USA", "reference_number": "MFB-870989-FPP", "iban": "FR7630006000011234567890189" }, "card_form": { "id": "string", "status": "string", "reason": "string", "reason_code": "string", "created_at": "2024-01-01", "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" }, "conditions": { "document_types": { "transfer_purpose": "string" } }, "documents": [ { "id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "owner_id": "00000000-0000-0000-0000-000000000000", "category": "identity_verification", "document_type": "passport", "mime_type": "string", "file_name": "string", "file_id": "string", "status": "pending", "expires_at": "1970-01-01T00:00:00.000Z", "created_at": "1970-01-01T00:00:00.000Z", "updated_at": "1970-01-01T00:00:00.000Z" } ] } ]