v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Delivery Channel Endpoints

gcm/delivery-channels

Get a list of all the available delivery methods available for a certain corridor and use case.

get/gcm/delivery-channels

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

CorridorIDstring required

The corridor ID

UseCasestring

Valid values are B2B, B2P, P2B, P2P

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

{
  "DeliveryChannels": {
    "0": {
      "DeliveryChannelID": "5",
      "DeliveryMethodType": "Bank Account",
      "UseCase": "B2B",
      "DeliveryFee": "1.50",
      "Currency": "British Pound Sterling",
      "ShortForm": "GBP",
      "DeliveryMethodTypeDetails": "swift"
    }
  }
}