v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Withdraw Endpoints

gcm/withdraw/transactions

Get a list of crossborder withdraw transactions.

get/gcm/withdraw/transactions

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

The client account ID

StartDateTimestring

The start date and time for the transactions

EndDateTimestring

The end date and time for the transactions

Limitinteger

The limit of transactions to fetch

Timezone string

Use this parameter to convert the time to the specified timezone. If no timezone is specified, the default is UTC.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Error message if any

Example response

{
  "Transactions": {
    "0": {
      "TransactionID": "2421928",
      "DestinationCountryAbbreviation": "AUS",
      "RecipientName": "First Last",
      "FirstName": "First",
      "LastName": "Last",
      "BusinessName": "AnytimeTerrorism",
      "Status": "in progress",
      "DeliveryMethodType": "Bank Account",
      "PaymentType": "buy",
      "FeesIncluded": "1",
      "TransactionDate": "2024-11-15 19:55:19",
      "Amount": "100.00",
      "PrincipalAmount": "98.40",
      "CustomerCreditedAmount": "57.15",
      "FXRate": "0.5807926829",
      "RecipientCurrency": "AUD",
      "SenderCurrency": "CAD",
      "CorridorID": "1",
      "RecipientContactID": "test_account",
      "DeliveryMethodID": "2",
      "DeliveryMethodToken": "3aguu9elzyqs8dk9vwruv208h2ijz2vzivrggo3rnr2s07nyw4c2o6t1k3kcyskg",
      "SenderPurposeOfPayment": "Medical Expenses",
      "SenderBusinessName": "Test Business",
      "SenderNationality": "CAN",
      "SenderGovernmentIds": "[]",
      "SenderRelationshipWithBeneficiary": "Mother",
      "SenderDateOfBirth": "1998-12-20",
      "SenderAddress1": "123 Main Street",
      "SenderAddressCity": "Vancouver",
      "SenderAddressPostalCode": "V6G3G9",
      "SenderAddressCountry": "Canada",
      "SenderAddressProvince": "British Columbia",
      "SenderEmailAddress": "fist.last@vopay.com",
      "RecipientFirstName": "John",
      "RecipientLastName": "Doe",
      "RecipientAddress1": "Severodvinskaya ulitsa, 14",
      "RecipientAddressCity": "Mockba",
      "RecipientAddressPostalCode": "127224",
      "RecipientAddressCountry": "United States",
      "RecipientAddressProvince": "British Columbia",
      "RecipientEmailAddress": "john.doe@gmail.com",
      "RecipientNationality": "AUS",
      "RecipientGovernmentIds": "[{\"government_id_uri\":\"ppn:123456789;expiration-date=2019-05-01;issue-date=2011-07-12;country=CAN\"}]",
      "GLCode": "4300",
      "TransactionTypeCode": "999"
    }
  }
}