Service Options
How to implement service options
Overview:
Service options refers to the different methods customers can transfer funds (i.e. cash pickup, bank deposit, wallet deposit, card deposit). MoneyGram support multiple service options to any given destinationCountry
.
serviceOptionCode
will contain a unique code to identify the service option. serviceOptionName
will contain the consumer facing name convention that can be displayed in the application UI.
A full list of supported serviceOptionCodes
and serviceOptionNames
are below:
serviceOptionCode | serviceOptionName |
---|---|
WILL_CALL | 10 Minute Service |
WILLCALL_TO | 10 Minute Service to |
2_HOUR | 2 Hour Service |
OVERNIGHT | Overnight pick-up after 7am at any |
OVERNIGHT2ANY | Overnight Available after 7am |
24_HOUR | 24 Hour Service |
48_HOUR | 48 Hour Service |
BANK_DEPOSIT | Bank Deposit |
DIRECT_TO_ACCT | Send to Wallet |
CARD_DEPOSIT | Send to a Card |
HOME_DELIVERY | Home Delivery |
How to implement:
serviceOptionCode
contains the unique code of the service option. It can be passed on the Quote API request to quote a specific service option to adestinationCountry
.
curl --request POST \
--url https://sandboxapi.moneygram.com/transfer/v1/transactions/quote \
--header 'X-MG-ClientRequestId: 957908758' \
--header 'accept: application/json' \
--header 'authorization: Bearer NG46z9GEpNQlh0P5X9ISIHHX4GO3' \
--header 'content-type: application/json' \
--data '
{
"targetAudience": "CONSUMER_FACING",
"agentPartnerId": 43688984,
"destinationCountryCode": "IND",
"destinationCountrySubdivisionCode": "IN-DL",
"serviceOptionCode": "WILL_CALL",
"sendAmount": {
"value": 100,
"currencyCode": "USD"
},
"sendAmountIncludingFee": true
"receiveCurrencyCode": "INR",
}
'
{
"transactions": [
{
"transactionId": "5cd02b98-aed2-4a7d-b857-41fb76af108f",
"serviceOptionCode": "0",
"serviceOptionName": "WILL_CALL",
"sendAmount": {
"amount": {
"value": 100,
"currencyCode": "USD"
},
"fees": {
"value": 15,
"currencyCode": "USD"
},
"taxes": {
"value": 0,
"currencyCode": "USD"
},
"total": {
"value": 100,
"currencyCode": "USD"
}
},
"receiveAmount": {
"amount": {
"value": 6821.44,
"currencyCode": "INR"
},
"fees": {
"value": 0,
"currencyCode": "INR"
},
"taxes": {
"value": 0,
"currencyCode": "INR"
},
"total": {
"value": 6821.44,
"currencyCode": "INR"
},
"fxRate": 80.2522,
"fxRateEstimated": false
}
}
]
}
- If left blank on the Quote API request, all service option to the destination will be returned.
curl --request POST \
--url https://sandboxapi.moneygram.com/transfer/v1/transactions/quote \
--header 'X-MG-ClientRequestId: 957908758' \
--header 'accept: application/json' \
--header 'authorization: Bearer NG46z9GEpNQlh0P5X9ISIHHX4GO3' \
--header 'content-type: application/json' \
--data '
{
"targetAudience": "CONSUMER_FACING",
"agentPartnerId": 43688984,
"destinationCountryCode": "IND",
"destinationCountrySubdivisionCode": "IN-DL",
"serviceOptionCode": "null",
"sendAmount": {
"value": 100,
"currencyCode": "USD"
},
"sendAmountIncludingFee": true
"receiveCurrencyCode": "INR",
}
{
"transactions": [
{
"transactionId": "5cd02b98-aed2-4a7d-b857-41fb76af108f",
"serviceOptionCode": "0",
"serviceOptionName": "WILL_CALL",
"sendAmount": {
"amount": {
"value": 100,
"currencyCode": "USD"
},
"fees": {
"value": 15,
"currencyCode": "USD"
},
"taxes": {
"value": 0,
"currencyCode": "USD"
},
"total": {
"value": 100,
"currencyCode": "USD"
}
},
"receiveAmount": {
"amount": {
"value": 6821.44,
"currencyCode": "INR"
},
"fees": {
"value": 0,
"currencyCode": "INR"
},
"taxes": {
"value": 0,
"currencyCode": "INR"
},
"total": {
"value": 6821.44,
"currencyCode": "INR"
},
"fxRate": 80.2522,
"fxRateEstimated": false
}
}
{
{
"transactionId": "5cd02b98-aed2-4a7d-b857-41fb76af108f",
"serviceOptionCode": "0",
"serviceOptionName": "BANK_DEPOSIT",
"sendAmount": {
"amount": {
"value": 100,
"currencyCode": "USD"
},
"fees": {
"value": 15,
"currencyCode": "USD"
},
"taxes": {
"value": 0,
"currencyCode": "USD"
},
"total": {
"value": 100,
"currencyCode": "USD"
}
},
"receiveAmount": {
"amount": {
"value": 6821.44,
"currencyCode": "INR"
},
"fees": {
"value": 0,
"currencyCode": "INR"
},
"taxes": {
"value": 0,
"currencyCode": "INR"
},
"total": {
"value": 6821.44,
"currencyCode": "INR"
},
"fxRate": 80.2522,
"fxRateEstimated": false
}
}
]
}
serviceOptionName
is returned on Quote Response. The values returned in theserviceOptionName
are consumer facing naming conventions and must be used in the application UI.
Updated 18 days ago