Skip to content
API Reference/
Money Transfer
/
/Pricing

Pricing

This section provides the Pricing endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform.

These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support core business operations and compliance workflows.

Operations

pricing/payers

Request

Purpose

Retrieves available payers with their exchange rates and transaction limits for a given destination country and branch.

When to Use

  • Display available payout options and pricing to customers before they select a payer
  • Show which payment networks are available in a destination country with their rate ranges
  • Allow customers to compare payers by exchange rate and transaction limits

How It Works

  1. Send branchId and deliveryCountryISO as query parameters
  2. Authenticate with x-client-id and x-secret-key headers
  3. Receive a list of payers with rates and limits for the requested country

Authentication

Requires x-client-id and x-secret-key headers. Partner must have pricing/payers in their allowed resources.

Notes

  • The deliveryCountryISO accepts ISO 3166-1 alpha-3 codes (e.g., MEX, COL, HND).
  • Results include rate ranges and transaction amount limits per payer.

Common Errors

  • 400 Validation errors (missing branchId, missing deliveryCountryISO, invalid headers)
  • 401 Invalid credentials
  • 403 Access forbidden (endpoint not in partner resources)
  • 422 Pricing data not available for the given parameters
  • 500 Internal server error
  • 502 Upstream service authentication failure
  • 503 Service temporarily unavailable
Error codes (click to expand)
CodeDescription
400001branchId is required
400005x-secret-key is required
400009deliveryCountryISO is required
400416The branchId is not valid for this partner
401000Invalid credentials
403001Access to this resource is forbidden for this client
422006Pricing data could not be retrieved
500000Internal server error
502001Unable to authenticate with upstream service
503001Service temporarily unavailable
Query
branchIdstring, [ 1 .. 20 ] charactersrequired

Branch identifier for the partner. Must be a valid branch belonging to the partner's chain.

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

Example:branchId=string
deliveryCountryISOstring, [ 2 .. 4 ] characters^[A-Z]{2,3}$required

Destination country in ISO 3166-1 alpha-3 format (e.g., MEX, COL, HND, GTM).

You can retrieve the list of available countries from our Catalogs API: Catalogs Endpoint Countries

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009

Example:deliveryCountryISO=string
validationsstring

Return validation schema instead of executing the request. When set to 'true', returns the merged schema (base + partner override) as JSON.

Error codes: type=400002, allowedValues=400010

Enum:"true""false"
Example:validations=true
Headers
x-client-idstring, [ 16 .. 64 ] charactersrequired

Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request.

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

Example:string
x-secret-keystring, [ 32 .. 128 ] charactersrequired

Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential.

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

Example:string
GET
/pricing/payers
curl -i -X GET \
  'https://sandbox-viablocks.viamericas.io/pricing/payers?branchId=string&deliveryCountryISO=string&validations=true' \
  -H 'x-client-id: string' \
  -H 'x-secret-key: string'

Responses

Payer rates and limits returned successfully.

Bodyapplication/json
statusstring

Response status indicator.

dataArray of objects

Array of payer objects with rates and limits for the requested country.

Response
{
  "status": "success",
  "data": [
    { … },
    { … }
  ]
}