List payment methods available for a country, currency and amount

GET

/payment-methods

const url = 'https://api.pachapay.io/v1/payment-methods?country=CL&currency=CLP&direction=payin';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.pachapay.io/v1/payment-methods?country=CL&currency=CLP&direction=payin' \
  --header 'Authorization: Bearer <token>'

Returns methods with limits and the fields the payer must provide.

Authorizations

ApiKey

Parameters

Query Parameters

country

required

ISO 3166-1 alpha-2. Target countries for the first release are CL, CO, EC, PE, MX and BR; availability per country depends on the agreement with the payment provider.

string

Allowed values: CL CO EC PE MX BR

currency

required

ISO 4217 code. Crypto assets are not accepted in this field.

string

Allowed values: CLP COP PEN MXN BRL USD

amount

integer format: int64

>= 1

Amount in minor units. When present, methods whose limits do not fit are omitted.

direction

string

default: payin

Allowed values: payin payout

Responses

200

Available methods.

application/json

object

data

required

Array<object>

object

code

required

string

family

required

string

Allowed values: card bank_redirect bank_transfer wallet cash deposit_reference

country

required

ISO 3166-1 alpha-2. Target countries for the first release are CL, CO, EC, PE, MX and BR; availability per country depends on the agreement with the payment provider.

string

Allowed values: CL CO EC PE MX BR

currency

required

ISO 4217 code. Crypto assets are not accepted in this field.

string

Allowed values: CLP COP PEN MXN BRL USD

name

required

string

min_amount

integer format: int64

max_amount

integer format: int64

required_fields

Fields the merchant must send, e.g. payer.document, payer.phone, destination.bank_code.

Array<string>

expires_in_seconds

Typical lifetime of an unpaid payment.

integer

Example

{
  "data": [
    {
      "code": "PE.YAPE",
      "family": "card",
      "country": "CL",
      "currency": "CLP"
    }
  ]
}

4XX

Error. See error.code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error invalid_state_error idempotency_error rate_limit_error api_error

code

required

Stable machine-readable code that does not change within a major version. Examples are parameter_invalid, parameter_missing, amount_out_of_range, api_key_invalid, api_key_revoked, merchant_not_active, method_not_allowed, country_not_allowed, resource_not_found, idempotency_conflict, idempotency_in_progress, invalid_state, insufficient_balance, method_not_available, blocked_payer, limit_exceeded, rate_limited, internal_error, provider_unavailable, service_unavailable.

string

message

required

string

param

Name of the offending parameter, if any.

string

request_id

required

string

Examples

Merchant not approved

{
  "error": {
    "type": "permission_error",
    "code": "merchant_not_active",
    "message": "KYB is not approved for this merchant.",
    "request_id": "req_01"
  }
}

Not enough balance

{
  "error": {
    "type": "invalid_state_error",
    "code": "insufficient_balance",
    "message": "Available balance is lower than the amount plus fee.",
    "param": "amount",
    "request_id": "req_02"
  }
}

5XX

Error. See error.code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error invalid_state_error idempotency_error rate_limit_error api_error

code

required

string

message

required

string

param

Name of the offending parameter, if any.

string

request_id

required

string

Examples

Merchant not approved

{
  "error": {
    "type": "permission_error",
    "code": "merchant_not_active",
    "message": "KYB is not approved for this merchant.",
    "request_id": "req_01"
  }
}

Not enough balance

{
  "error": {
    "type": "invalid_state_error",
    "code": "insufficient_balance",
    "message": "Available balance is lower than the amount plus fee.",
    "param": "amount",
    "request_id": "req_02"
  }
}