Qodex.ai

Partner Payment Batch Flow (Send Money)

Number of APIs: 9

Partner Payment Batch Flow

A set of Qodex collections containing the example flows to demonstrate and test the TransferWise Connected Apps API for partners.

For use with the Qodex client, please use the latest version: download it here.

Set Up

Import the Qodex collections

Import the appropriate collection file into Qodex - For sending money by bank transfer: Connected Apps Payment flow (Send Money).Qodex_collection.json - For sending money funded by a multi-currency account (balance): Connected Apps Payment flow (Balance).Qodex_collection.json

Also import the TW-API-ENVIRONMENT.Qodex_environment.json file, found in the top level of this project, to add the environment variables used to manage your sandbox/production credentials.

Set up your Qodex environment variables

Set environment variables for client-id, client-secret and client-redirect-uri credentials issued to you by TransferWise.

Use our oauth flow to generate an authorization code and set this to an environment variable called client-auth-code.

Getting started

The collection is set up to use the Collection Runner. Open with Runner and select the collection you imported. It should look something like this:

Collection Runner

Make sure the correct Environment is set, and upload the Connected Apps Payment flow.csv file.

Run the collection, a summary will be provided along with a JSON message with the pay-in instructions.

Funding and waiting for completion

You cannot fund sandbox bankj transfer payments with real money, you must use our transfer simulation API.

When funding from balance sandbox we do provide a virtual balance that you can use for this purpose.

To monitor the status of the payments you create, listen to the transfer state change webhook to listen for events. Details on subscribing to webhook events can be found here.

Making your own payment data

Our online template instructions tool makes this very easy:

  1. Navigate to the Bank Template instructions page (you will need a TransferWise account)

  2. Select your desired source/target currencies and download the template. If you want to set multiple target currencies see this section

  3. Fill in the columns provided, both our API docs and the template instructions page provide information about these fields

Help

If you need any help using the API please contact our support team.

  1. 1. Authenticate as application - Refresh existing access token POST {{host}}/oauth/token

  2. 4. Complete and fund - Complete batch group PATCH {{host}}/v3/profiles/{{profile}}/batch-groups/{{batch_group_id}}

  3. Pre-checks (ignore this, used by Qodex) - Start iteration GET {{host}}/health

  4. 2. Set up batch group - Create batch group POST {{host}}/v3/profiles/{{profile}}/batch-groups

  5. 3. Add payments-Pre-checks (ignore this, used by Qodex) - Decide which recipient to create GET {{host}}/health

  6. 3. Add payments-3.1. Add recipient (one per payment) - Create USD account POST {{host}}/v1/accounts

  7. 3. Add payments-3.2. Add transfer - Create quote POST {{host}}/v2/quotes

  8. 3. Add payments-3.2. Add transfer - Create batch group transfer POST {{host}}/v3/profiles/{{profile}}/batch-groups/{{batch_group_id}}/transfers

  9. 4. Complete and fund - Get batch group version GET {{host}}/v3/profiles/{{profile}}/batch-groups/{{batch_group_id}}