v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Delivery Method Endpoints

gcm/delivery-methods/add

Add a new delivery method for a certain recipient contact and corridor delivery method.

post/gcm/delivery-methods/add

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

DeliveryChannelIDstring required

The delivery channel ID

ClientAccountIDstring

The client account ID

AccountTypestring

The account type

BankAccountNumberstring

The bank account number

BankIdentifierCodestring

The bank identifier code

InternationalBankAccountNumberstring

The international bank account number

EWalletIDstring

The e-wallet ID

ServiceProviderstring

The service provider

TelephoneNumberstring

The telephone number

BankNamestring

The bank name

BankCodestring

The bank code

BranchNamestring

The branch name

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Error message if any

DeliveryMethodTokenstring

The token of the added delivery method

RecipientContactIDstring

The recipient contact ID

Example response

{
  "DeliveryMethodToken": "374lrxtrutgk8o6qxmv94xmet28r0jle93xwkc2vmydbr65oqos1fklpeqnsni6h",
  "RecipientContactID": "test_account"
}