PAYOUT CODE: Create and Get Payout Code

RSP can use this method to acquire a maximum of 100 Payout code as for Cash Pickup Transactions for India and Philippines.

Definition:

POST v1/payments/payoutcodes

Sample Request:

curl -v -X POST http://staging-gloremit.tranglo.com:2014/v1/payments/payoutcodes \
-H "Content-Type: application/json" \
-H "Authorization: GLOREMIT <UID>:<PWD> :<rspSign>" \
-d '{
"requestId": "12345678901234",
"countryCode": "PH",
"preBookQty": "20"
}'

Request Description

Parameter NameRequiredMin/Max LengthTypeRemark
UIDM5/50AlphanumericUsername for validation
PWDM5/50AlphanumericPassword for validation
rspSignM32/50AlphanumericDigital signature of RSP
requestIdM1/50Alphanumeric14-character request ID for Payout code
countryCodeM2/2TextISO country Code.IN for IndiaPH for Philippines
preBookQtyM1/3NumericNumbers of payout code to be request. Maximum of 100 on all time request. If first request 50 payoutcodes, the second request, request for 60 payoutcodes, system will only return 50 payoutcodes.

Response Description

Sample Response:

{
    "RequestId":"12345678901234",
    "CountryCode":"PH",
    "Status":"000",
    "Description":"Transaction is Successful",
    "PayoutCodes": [
    {
    "Code": "P331701041556"
    },
    {
    "Code": "P331701045620"
    },
    {
    "Code": "P331701032895"
    },
    {
    "Code": "P331701015677"
    },
    {
    "Code": "P331701018108"
    },
    {
    "Code": "P331701032853"
    },
    {
    "Code": "P331701016955"
    },
    {
    "Code": "P331701029958"
    },
    {
    "Code": "P331701040482"
    },
    {
    "Code": "P331701042074"
    },
    {
    "Code": "P331701019501"
    },
    {
    "Code": "P331701017828"
    },
    {
    "Code": "P331701027720"
    },
    {
    "Code": "P331701032049"
    },
    {
    "Code": "P331701005039"
    },
    {
    "Code": "P331701029204"
    },
    {
    "Code": "P331701005772"
    },
    { "Code": "P331701012470"
    },
    {
    "Code": "P331701027629"
    },
    {
    "Code": "P331701048488"
    }
    ]
 }
Parameter NameRequiredTypeRemark
RequestIdMNumericRequestID for the payoutcode request
CountryCodeMTextISO Country code for the Payout code country request
Accept ISO 3166-1 Alpha-2 or Alpha-3 ONLY
StatusMAlphaNumericTransaction status response code. Please see Section 3.6 for full description
DescriptionMTextDescription of the status
PayoutCodeMArrayList of the Payout code requested