Returns list of alternative service to a provided service

get https://{environment}.masspay.io/{VERSION}/payout/service/{destination_token}/alternatives

This GET endpoint is used to retrieve a list of alternative services to a provided service.
You can use this endpoint to obtain information about other available services and pricing offered by different companies for a particular destination.
To use this endpoint, you need to provide the destination_token as a required parameter in the URL Path.
The response will include a JSON array containing details for each company, including the company name, available alternative services, and pricing.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

country_code

string

required

length between 3 and 3

Country code ISO_3166

delivery_type

string

required

The type of service. I.e. cash pickup, home delivery, etc.

CASH_PICKUP BANK_DEPOSIT HOME_DELIVERY MOBILE_WALLET MASSPAY_CARD PAPER_CHECK BILL CRYPTOCURRENCY

payers

array of objects

required

payers*

object

destination_token

uuid

required

Token that represents the payout destination. 36 characters long

payer_logo

string

base64 representation of the payer logo

payer_name

string

required

Name of payer

exchange_rate

array of objects

required

Lists all available currencies and their estimated rates

exchange_rate*

object

currency_symbol

string

required

Using ISO 4217 format.

exchange_rate

double

required

Estimated rate

fee

double

required

Service fee

max_limit

double

required

The maximum amount (inclusive) the user can send with this service. 0 if no upper limit

min_limit

double

required

The minimum amount (inclusive) the user can send with this service. 0 if no lower limit

source_amount

double

Optional return field. Will only show if limit parameter is provided

number_of_locations

int32

≥ 0

Defaults to 0

Total number of locations. Mostly relevant for cash pickup services. 0 if unknown or irrelevant

estimated_availability

date-time

Estimated availability of funds. When funds would be available to pickup/deposited

additional_description

string

When available, additional description that explains the service offered or requirements for funds delivery.

is_dynamic_token

boolean

required

When set to true, it indicates that this destination_token will auto retry the transaction for a set time until it is successful or timesout. False value means the transaction will be processed by the payer in real-time with instant feedback on success/failure.

is_variable_fee

boolean

required

Indicates whether the fee is variable. When set to true, you can expect the fee to change based on the source_amount. Although certain crypto currencies's fee can vary due to network fee flactuation, they are not considered a variable fee as MassPay's fee is not variable based on the source_amount.

Headers

object

Access-Control-Allow-Origin

string

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.masspay.io/v1.0.0/payout/service/destination_token/alternatives?show_dynamic_tokens_only=false' \
3
     --header 'accept: application/json'


xxxxxxxxxx
26
}
1
{
2
  "country_code": "MEX",
3
  "delivery_type": "CASH_PICKUP",
4
  "payers": [
5
    {
6
      "destination_token": "dest_123e4567-e89b-12d3-a456-426614174000",
7
      "payer_logo": "U3dhZ2dlciByb2Nrcw==",
8
      "payer_name": "Elektra",
9
      "exchange_rate": [
10
        {
11
          "currency_symbol": "MXN",
12
          "exchange_rate": 18.37
13
        }
14
      ],
15
      "fee": 8,
16
      "max_limit": 10000,
17
      "min_limit": 0,
18
      "source_amount": 104.3,
19
      "number_of_locations": 13007,
20
      "estimated_availability": "2020-07-21T17:32:28Z",
21
      "additional_description": "Requires drivers license to pickup funds",
22
      "is_dynamic_token": true,
23
      "is_variable_fee": true
24
    }
25
  ]

200Successful operation.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method Not Allowed.

500Internal server error.

504Gateway Time-out.