This page contains example API calls for providers that have specific requirements.

Bank payments via SWIFT provider

The below are the generic set of fields expected to be used for SWIFT bank payments, including all mandatory fields. There are additional fields which may be used; see API reference for a complete list, and Provider Guide for specific information on using the SWIFT provider.

Some markets may require fields in addition to the below. For more information, contact your representative.

{
  "requestId": "769b870d-5031-4121-98f1-b86b4985037b",
  "batchReference": "batch-12345",
   "transactions": [
    {
      "transactionId": "id-12345",
      "provider": "swift",
      "amount": 1,
      "currency": "EUR",
      "recipientAccountId": "NL39RABO1782371249",
      "name": "Jane Doe",
      "address": "Agnietenstraat 1",
      "address2" : "Haidian District",
      "city": "Utrecht",
      "postalCode": "3512",
      "country": "NL",
      "reason": "Payment for goods and services",
      "recipientBank": {
        "bic": "RABONL2U",
      },
      "sender": {
          ...
      },
      "intermediary":{
          ...
      }
    }
  ]
}
  ]
}

API examples

Cross-currency payments

The below are the generic set of fields expected to be used for cross-currency SWIFT bank payments, including all mandatory fields. Not all the below are mandatory, and there are additional fields which may be used; see API reference for a complete list, and Provider Guide for specific information on using cross-currency payments.

Note that the below is for specifying a payment for 1 USD, in which the recipient will receive an equivalent amount of Euros.

/api/pay payload

{
  "requestId": "769b870d-5031-4121-98f1-b86b4985037b",
  "batchReference": "batch-12345",
  "foreignExchange":{
      "tenor": "spot",
   "transactions": [
    {
      "transactionId": "id-12345",
      "provider": "swift",
      "sourceCurrencyAmount": 1,
      "currency": "EUR",
      "sourceCurrency": "USD",
      "recipientAccountId": "NL39RABO1782371249",
      "name": "Jane Doe",
      "address": "Agnietenstraat 1",
      "address2" : "Haidian District",
      "city": "Utrecht",
      "postalCode": "3512",
      "country": "NL",
      "reason": "Payment for goods and services",
      "recipientBank": {
        "bic": "RABONL2U",
      },
      "sender": {
          ...
      },
      "intermediary":{
          ...
      }
    }
  ]
}
  ]
}

/api/transactionstatus response

Note that /api/pay callbacks do not presently contain FX details. These should be requested via /api/transactionstatus.

{
  "requestId": "an-id",
      ...
   },
   "transactions": [
    {
      "transactionId": "id-12345",
      "provider": "swift",
      "amount": 565,
      "currency": "XOF",
      ...,
      "foreignExchange": {    
            "sourceCurrency": "USD",
            "SourceCurrencyAmount": 1,
            "typeOfAmountSpecified": "source",
            "linkedFxTradeDetails": {
                  "fxTradeId": "id-abcdef",
                  "destinationCurrency": "XOF",
                  "destinationCurrencyAmount": 565,  
                  "sourceCurrency": "USD",
                  "sourceCurrencyAmount": 1,
                  "fxRate": 565.0000,
                  "tenor": "SPOT",
                  "fxValueDate": "2021-11-05",
                  "fxTransactionTime": "2021-11-04T14:52:26.418Z"
                }
            }  
      }, 
         }, 
      ...,
      }
  ]
}