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 Payment Initiation API is intended to give a third party provider - with the consent of the customer - access to initiate a payment on customer’s account.

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 .

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

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

See Access Token section for details.

Access token expires in 2 mins and refresh token expires in 6 mins. You can refresh the access token as below.

See Refresh Token section for details.

STEP 2: Setup Payment Consent

The PISP connects to OFX (ASPSP) that services the PSU’s account(s) and creates a payment-consent resource.

This informs OFX that one of its customers is granting access to initiate a payment to a PISP. 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 /payment-consent endpoint.

See Create Payment Consent Specification section for details.

STEP 3: Authorise Consent

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

During authorisation, the OFX user will be able to authorise or reject the payment-consent. Once the consent has been authorised, the PSU is redirected back to the PISP.

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

See Authorize section for details.

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: Payment Flow

The PISP will make a GET call to /payment-flow to initiate the payment. it should include token, consentId and the redirect url that the PSU will be redirected to after the payment is done.

See Get Payment Flow Specification section for details.

STEP 5: Get Payment Details

The PISP can check the status and details of a payment by making a GET request to /deal/{DealId}

See Get Payment Details 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