v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Delivery Method Endpoints

gcm/delivery-methods

Get a list of all the stored delivery methods for a certain recipient contact and corridor delivery method (optional).

get/gcm/delivery-methods

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

RecipientContactIDstring required

The recipient contact ID

ClientAccountIDstring

The client account ID

DeliveryChannelIDstring

The delivery channel ID

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "DeliveryMethods": {
    "0": {
      "DeliveryMethodToken": "3aguu9elzyqs8dk9vwruv208h2ijz2vzivrggo3rnr2s07nyw4c2o6t1k3kcyskg",
      "DeliveryChannelID": "55",
      "BankAccountNumber": "0080****",
      "BankIdentifierCode": "BNPAAU2SXXX",
      "BankCode": "ANZ",
      "DeliveryMethodType": "Bank Account",
      "DestinationCountry": "Australia",
      "DestinationCountryCode": "AUS",
      "DestinationAbbreviation": "AU",
      "DeliveryFee": "1.60"
    }
  }
}