Introduction

Global Currency Account - OFX issues online sellers with local currency accounts which allows the sellers to receive marketplace and website proceeds from sales of their products into an equivalent of a local bank account.

The Global currency account becomes a “multi-currency account” that allows a seller to see all of their currency accounts in one dashboard, hold balances to make payments to suppliers/vendors directly from the account.

The Global Currency Account APIs are designed specifically for Account Information Service Providers (AISP) or Payment Initiation Service Providers (PISP)

Check out our video and flyer about Global Currency Account.

Flyer

How does it work?

The Global Currency Account APIs are designed specifically for Account Information Service Providers (AISP) or Payment Initiation Service Providers (PISP) to access OFX (ASPSP) GCA customers’ accounts (PSU). Third-party developers can make use of our services by leveraging our robust and secure platform via API integration.

The Account and Transaction API is intended to give a third party provider - with the consent of the customer - access to accounts, balances, transactions and beneficiary information related to that customer’s accounts.

Getting Started:

Register with OFX

Securely access using your API Keys. We use OAuth 2.0 over SSL encryption

See Getting started guide for more information on how to get API keys.

STEP 1: Get an access token

Get the Access token following OAuth 2.0 client credentials flow.

Replace your_client_id and your_client_secret with your client id and client secret.

Note: Consumer Key is same as client id and Consumer Secret is same as client secret.

Copy a temporary access token from your response, which expires in the defined timeframe (seconds).

Please note you need to specify “accounts” as the scope.

See Access Token section for details.

Access token expires in 30 mins and refresh token expires in 90 days. You can refresh the access token as below.

See Refresh Token section for details.

STEP 2: Setup Account Access Consent

The AISP connects to OFX (ASPSP) that services the PSU’s account(s) and creates an account-access-consent resource.

This informs OFX that one of its customers is granting access to account and transaction information to an AISP. OFX responds with an identifier for the resource (the ConsentId - which is the intent identifier).

This step is carried out by making a POST request to /account-access-consents endpoint.

See Create Account Access Consent Specification section for details.

STEP 3: Authorise Consent

The AISP redirects OFX user to OFX where AISP requests OFX user to authorise the consent. This call includes the ConsentId generated in the previous step.

During authorisation, the OFX user selects accounts that are authorised for the AISP request (in OFX’s banking interface) and will be able to authorise or reject the account-access-consent details in its entirety.

Please note you need to specify “accounts” as the scope.

See Authorize section for details.

Note: Authorisation can also be done through the website. Add client id, redirect url and consent id in below url. Enter the url in address bar of the browser to get the authorisation.

https://sandbox.api.ofx.com/v1/oauth/authorize?response_type=code&client_id={{client_id}}&scope=accounts&redirect_uri={{redirect_uri}}&consent_id={{consent_Id}}

For sandbox environment, please use the following user details when prompted for authentication (via login form)

Username: JohnDoe@ofx.com and password: Testuser1

The response of the Authorize endpoints is code value, which will be used in authorization_code endpoint to get a token.

See Authorization_code section for details.

STEP 4: Request Data

The unique AccountId(s) that are valid for the account-access-consent will be returned with a call to GET /accounts.

This will always be the first call once an AISP has a valid access token.

See Get Accounts Specification section for details.

Run in Postman

We are using CURL commands in our examples, but if you prefer Postman, then you can import the entire collection from the below link:

Run in Postman

What’s next ?

You can also get more information at our Developer FAQ page and OFX FAQ page