Obtener lista de métodos de pago

La API de métodos de pago te permite consultar los métodos de pago disponibles. Puedes usar este endpoint para mostrar los métodos de pago que podrías aceptar en tu checkout.

Header parameters (parámetros del encabezado)

La siguiente tabla describe el esquema de los parámetros del encabezado:

Parámetro	Descripción	Tipo	Requerido / Opcional	Notas
Content-Type	Define el formato del objeto de la llamada	application/json	Requerido	Solicitud en formato JSON
Authorization	Especifica el token de acceso	String	Requerido	token de autenticación

Query parameters (parámetros del cuerpo de la solicitud)

La siguiente tabla describe el esquema de los parámetros de consulta:

Parámetro

Descripción

Tipo

Ejemplo

Requerido / Opcional

Notas

country

Código del país

String

"MX”

Opcional

Código de país con el formato. ISO 3166-1 alpha-2 code.

El valor por defecto es MX.

Respuesta

La respuesta contiene todos los elementos enviados en el body más los campos que se muestran en la siguiente tabla:

Parámetro			Descripción	Tipo	Notas
id			id del método de pago.	String	Identificación del método de pago. Posibles valores: amex, visa, master, arcuspay. Arcuspay hace referencia a Clip Cash o pago en efectivo.
logo			URL con la imágen del método de pago.	String	URL del logotipo del método de pago.
name			Nombre del método de pago.	String	Nombre completo del método de pago.. Posibles valores:American Express, Visa, Mastercard y Arcus Pay.
status			Status del método de pago.	String	Posibles valores: active, deactive.
type			Tipo de tarjeta.	String	Posibles valores: credit_card, debit_card, ticket (efectivo).
validations			Objeto con los tipos de validación.	Objeto
	name		Nombre del tipo de validación.	String	Posibles valores: bin, card_number, cvv, accepted_amount
	metadata		NObjeto con los valores del tipo de validación.	Objeto	Solo pueden incluirse hasta 30 parámetros. Cada parámetro tiene una longitud máxima de 255 caracteres. Acepta un tamaño máximo de 1 MB.
		pattern	Patrón del número BIN.	String	Valor asociado con el tipo de validación “bin”.
		exclusion_pattern	Patrón de exclusión.	String	Valor asociado con el tipo de validación “bin”.
		installments_pattern	Meses sin intereses disponibles para el número BIN.	String	Valor asociado con el tipo de validación “bin”.
		algorithm	Algoritmo del número de tarjeta.	String	Valor asociado con el tipo de validación “card_number”.
		length	Longitud del número de la tarjeta.	String	Valor asociado con el tipo de validación “card_number”.
		card_location	Ubicación del número CVV.	String	Valor asociado con el tipo de validación “cvv”. Posibles valores: front o back
		length	Longitud del número CVV.	String	Valor asociado con el tipo de validación “cvv”.
		type	Indica si el CVV es obligatorio u opcional.	String	Valor asociado con el tipo de validación “cvv”.
		min	Monto mínimo aceptado para este método de pago.	String	Valor asociado con el tipo de validación “accepted_amount”.
		max	Monto máximo aceptado para este método de pago.	String	Valor asociado con el tipo de validación “accepted_amount”.

Código de ejemplo

Ejemplo de una llamada.

El siguiente bloque de código muestra un ejemplo de la solicitud cURL:

curl --location --request POST 'https://api.payclip.com/payment_methods?country=MX' \
--header 'Authorization: Basic MTBkMTA2Y2QtMTI4Ny00MjI1LWE0ZWQtNzY3MWRkM2Y5ZDEzOjExNWYwMjE0LWJkZDgtNGY1ZS04ODRmLWVhMTM0YjVhNTUyNA==' \
--header 'Content-Type: application/json' \

Ejemplo de un objeto de la respuesta

El siguiente objeto es una respuesta de éxito con código HTTP 201 OK:

[
  {
    "id": "amex",
    "logo": "https://example.com/payment_logos/amex.png",
    "name": "American Express",
    "status": "active",
    "type": "credit_card",
    "validations": [
      {
        "name": "bin",
        "metadata": {
          "pattern": "^(3)",
          "installment_pattern": "^(360935)"
        }
      },
      {
        "name": "card_number",
        "metadata": {
          "algorithm": "luhn",
          "length": 16
        }
      },
      {
        "name": "cvv",
        "metadata": {
          "card_location": "front",
          "length": 4,
          "type": "mandatory"
        }
      },
      {
        "name": "accepted_amount",
        "metadata": {
          "min": 1,
          "max": 300000
        }
      }
    ]
  },
  {
    "id": "visa",
    "logo": "https://example.com/payment_logos/visa.png",
    "name": "Visa",
    "status": "active",
    "type": "credit_card",
    "validations": [
      {
        "name": "bin",
        "metadata": {
          "pattern": "^(4)",
          "exclusion_pattern": null,
          "installment_pattern": "^(417401)"
        }
      },
      {
        "name": "card_number",
        "metadata": {
          "algorithm": "luhn",
          "length": 16
        }
      },
      {
        "name": "cvv",
        "metadata": {
          "card_location": "back",
          "length": 3,
          "type": "mandatory"
        }
      },
      {
        "name": "accepted_amount",
        "metadata": {
          "min": 1,
          "max": 300000
        }
      }
    ]
  },
  {
    "id": "master",
    "logo": "https://example.com/payment_logos/master.png",
    "name": "Mastercard",
    "status": "active",
    "type": "credit_card",
    "validations": [
      {
        "name": "bin",
        "metadata": {
          "pattern": "^(5)",
          "installment_pattern": "^(511052)"
        }
      },
      {
        "name": "card_number",
        "metadata": {
          "algorithm": "luhn",
          "length": 16
        }
      },
      {
        "name": "cvv",
        "metadata": {
          "card_location": "back",
          "length": 3,
          "type": "mandatory"
        }
      },
      {
        "name": "accepted_amount",
        "metadata": {
          "min": 1,
          "max": 300000
        }
      }
    ]
  },
  {
    "id": "arcuspay",
    "logo": "https://example.com/payment_logos/arcuspay.png",
    "name": "Arcus Pay",
    "status": "active",
    "type": "ticket",
    "validations": [
      {
        "name": "accepted_amount",
        "metadata": {
          "min": 1,
          "max": 10000
        }
      }
    ]
  }
]

Códigos de respuesta

La siguiente tabla contiene una lista de los códigos de respuesta y su asociación con algunos de los estados HTTP:

404	BR1301	Not Found
401	CL1501	Unauthorized
500	AI1899	Internal error.

Este es un ejemplo del objeto de error en formato JSON:

{
"error_code": "BR1301",
"message": "Not found",
"detail": [
  "Not found"
  ]
}

Llamada de prueba

Puedes realizar una llamada de prueba llenando los campos necesarios en el formulario que se muestra a continuación.

Asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha: