{"info":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","description":"

What is TransferLink?

TransferLink is a is a member-owned Global Network providing the following services to its' Members

Connectivity.
Transaction switching.
Currency exchange
Clearing and settlement.

Owner and Custodian of Diaspora Price Promise Remittance Product (DPPRP) with committed end2end maximum cost of 2.5%.

How's the platform?

Expandable/Adaptive: Modular by design (micro-services) to fit different use-case and additional functionality.
Secure: Open, and interoperable set of Application Programming Interfaces (APIs) as the safest and most efficient way to exchange data securely (authenticated and authorized).
Simple: APIs enhanced with adaptation bridges intended to simplify integrations for Members.
Modern/Relevant: Built on latest architecture: NodeJS-based microservices using Google Kubernetes Engine Inter-service communication using a hybrid of gRPC and NATS.

Requests format

All the requests to the TransferLink API happen using JSON in the body of the requests where appropriate. Requests must include the corresponding Content-Type header application/json.

Authorization

Requests to the API will only be processed in presence of the given partner's API key which identifies the TransferLink partner. The API Key is an opaque string which is rotated periodically.

Aditionally, the partner may specify a CIDR range to whitelist requests from.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2580979","collectionId":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","publishedId":"2sA2xfXDFn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1e40af"},"publishDate":"2024-03-06T21:09:33.000Z"},"item":[{"name":"Accounts","item":[{"name":"Create Account","id":"69eeb556-f109-4677-b5cb-d7a8769e9071","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currency\": \"usd\",\n \"name\": \"Operational account name\",\n \"institutionId\": \"{{institutionId}}\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.transfer.link/accounts","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}},"urlObject":{"path":["accounts"],"host":["https://api.transfer.link"],"query":[],"variable":[]}},"response":[],"_postman_id":"69eeb556-f109-4677-b5cb-d7a8769e9071"},{"name":"Delete Account","id":"d29b1017-d1ad-4f6f-8af8-c3e4596840e4","protocolProfileBehavior":{"disableBodyPruning":true,"strictSSL":false},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.transfer.link/accounts/{{ accountId }}","description":"

This endpoint is used to delete a specific account identified by the account ID in the URL.

Note: It is only possible to delete an account that has no transactions.

Request Parameters

accountId (in the URL path): The unique identifier of the account to be deleted.

Response

The response will be an empty body with a status 200 in case of successful deletions.

Error

The response will have a status code of 404 with a JSON body containing the following fields:

statusCode: The status code of the error.
message: A message providing more information about the error.
error: Details about the error encountered.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}},"urlObject":{"path":["accounts","{{ accountId }}"],"host":["https://api.transfer.link"],"query":[],"variable":[]}},"response":[],"_postman_id":"d29b1017-d1ad-4f6f-8af8-c3e4596840e4"},{"name":"List Accounts","id":"a64d7a19-3539-4a4c-9c6f-fabdfb38a6b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.transfer.link/accounts","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}},"urlObject":{"path":["accounts"],"host":["https://api.transfer.link"],"query":[],"variable":[]}},"response":[],"_postman_id":"a64d7a19-3539-4a4c-9c6f-fabdfb38a6b7"},{"name":"List Account Movements","id":"83a0b1e8-816f-4d8d-8a6d-f6de2906ef97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.transfer.link/accounts/{{accountId}}/movements","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}},"urlObject":{"path":["accounts","{{accountId}}","movements"],"host":["https://api.transfer.link"],"query":[],"variable":[]}},"response":[],"_postman_id":"83a0b1e8-816f-4d8d-8a6d-f6de2906ef97"}],"id":"f684bfb8-0778-43b0-9335-adab03ae7263","description":"

Operations in the network are backed up by the accounts of the ledger, prociding the operational float for customer's operations.

Accounts are entities that an institution can create and manage, allowing them to operate in different currencies.

\n","_postman_id":"f684bfb8-0778-43b0-9335-adab03ae7263","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}}},{"name":"Institutions","item":[{"name":"Create institution","id":"023e579c-1dae-4b57-a6c3-386d8e44ea11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"TransferLink Partner Inc.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.transfer.link/institutions","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}},"urlObject":{"path":["institutions"],"host":["https://api.transfer.link"],"query":[],"variable":[]}},"response":[],"_postman_id":"023e579c-1dae-4b57-a6c3-386d8e44ea11"},{"name":"List institutions","id":"bc8d3a9e-b363-490a-80c7-bb280ea6f126","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.transfer.link/institutions","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}},"urlObject":{"path":["institutions"],"host":["https://api.transfer.link"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc8d3a9e-b363-490a-80c7-bb280ea6f126"}],"id":"47c31306-98a7-422c-83e1-6cbd15568d2e","_postman_id":"47c31306-98a7-422c-83e1-6cbd15568d2e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}}},{"name":"Transactions","item":[{"name":"Deposit","id":"9c8ea7aa-39f1-4319-89a8-b2f92f0a55b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"currency\": \"USD\",\n \"accountId\": \"{{senderAccountId}}\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.transfer.link/transactions/deposits","description":"

Allow requesting a deposit into one of the accounts of the system.

This request is validated by the team after it is settled via agreed mechanisms.

Request a withdrawal of funds from a given operational account by its `accountId`.

Note: This request is validated and approved by the TransferLink team.

Send funds to a destination of the network on behalf of a institution user.

Sender account: Account ID from which to withdraw the funds.
\n
Receiver Virtual Account ID: UUID of the destination previously looked-up.
\n
Reference: String containing a reference visible for the user. (Optional)
\n
Amount and currency: To send the fund into.
\n

Queries the integrated networks for possible destinations and returns them in a mapped, unified, format.

phoneNumber: Should be a valid E.164 mobile number.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}},"urlObject":{"path":["virtual-accounts"],"host":["https://api.transfer.link"],"query":[{"key":"phoneNumber","value":"%2b260950009020"}],"variable":[]}},"response":[],"_postman_id":"2af2ee5e-f1fb-4f28-8adc-3766829ddeda"}],"id":"717fcca8-977a-480a-8292-49100927460f","_postman_id":"717fcca8-977a-480a-8292-49100927460f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}}},{"name":"Fx","item":[{"name":"Get rates","id":"14bbf963-95ab-42c8-8d5f-35d53433c30b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.transfer.link/fx","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}},"urlObject":{"path":["fx"],"host":["https://api.transfer.link"],"query":[],"variable":[]}},"response":[],"_postman_id":"14bbf963-95ab-42c8-8d5f-35d53433c30b"}],"id":"acb1671a-d9de-44b8-8da3-48db03f43097","description":"

Provide Fx information.

\n","_postman_id":"acb1671a-d9de-44b8-8da3-48db03f43097","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":true,"source":{"_postman_id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","id":"7fdbe09e-1d10-4a3d-8ff5-e523fc443aa6","name":"(v4) Account Service","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]}},"event":[{"listen":"prerequest","script":{"id":"10549087-121f-40a3-8245-de28784ee0d3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"281907fa-fc49-4ec8-8311-145ac97e8a69","type":"text/javascript","exec":[""]}}],"variable":[{"key":"apiUrl","value":"https://api.transfer.link","type":"string"},{"key":"baseUrl","value":"https://api.transfer.link","type":"string"}]}