OXXO

Cómo utilizar OXXO para realizar un payin en México.

Payin por OXXO

POST https://gateway-test.pagsmile.com/trade/pay

Este endpoint te permite usar OXXO para realizar un payin en Mexico.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
Authorization*	string	Basic Base($app_id:$security_key)

Name

Type

Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

Name	Type	Description
app_id*	string	Id de app creado en dashboard - Max. 32 chars -
customer.phone*	string	Teléfono de usuario
customer.email*	string	Correo de usuario
customer.identify.number*	string	Número de identificación de usuario - 13 chars, ex: MAMB780915969 -
method*	string	Valor fijo: OXXO
out_trade_no*	string	ID dado por el merchant en su sistema - Max. 64 chars -
notify_url*	string	Donde Pagsmile enviará la notificación
customer.identify.type*	string	Tipo de identificación de usuario - RFC -
customer.name*	string	Nombre de usuario
timestamp*	string	yyyy-MM-dd HH:mm:ss - Max. 19 chars -
subject*	string	Razón de pago o título - Max. 128 chars -
order_amount*	string	Monto de pago - 8~10,000 MXN -
order_currency*	string	Valor fijo: MXN
content	string	Detalle de razón de pago o título. - Max. 255 chars -
buyer_id*	string	Usuario id de merchant
address.zip_code*	string	zip code - 5 digitos -
website_url	string	URL de website de merchant - Max. 128 chars -
address.street	string	calle - Requerido si no hay zip_code -
address.street_number	string	número de calle - Requerido si no hay zip_code -
address.city	string	ciudad - Requerido si no hay zip_code -
address.state	string	provincia - Requerido si no hay zip_code -
return_url	string	Redirigir a la URL del merchant cuando el usuario haya terminado checkout

Name

Type

Description

app_id*

string

Id de app creado en dashboard

- Max. 32 chars -

customer.phone*

string

Teléfono de usuario

customer.email*

string

Correo de usuario

customer.identify.number*

string

Número de identificación de usuario

- 13 chars, ex: MAMB780915969 -

method*

string

Valor fijo: OXXO

out_trade_no*

string

ID dado por el merchant en su sistema

- Max. 64 chars -

notify_url*

string

Donde Pagsmile enviará la notificación

customer.identify.type*

string

Tipo de identificación de usuario

- RFC -

customer.name*

string

Nombre de usuario

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

subject*

string

Razón de pago o título

- Max. 128 chars -

order_amount*

string

Monto de pago

- 8~10,000 MXN -

order_currency*

string

Valor fijo: MXN

content

string

Detalle de razón de pago o título.

- Max. 255 chars -

buyer_id*

string

Usuario id de merchant

address.zip_code*

string

zip code

- 5 digitos -

website_url

string

URL de website de merchant

- Max. 128 chars -

address.street

string

calle

- Requerido si no hay zip_code -

address.street_number

string

número de calle

- Requerido si no hay zip_code -

address.city

string

ciudad

- Requerido si no hay zip_code -

address.state

string

provincia - Requerido si no hay zip_code -

return_url

string

Redirigir a la URL del merchant cuando el usuario haya terminado checkout

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900084",
    "out_trade_no": "202201010354004",
    "web_url": "",
    "barcode": "88644659044520042000028006",
    "pay_url": "https://checkout-testv2.pagsmile.com/checkout?prepay_id=R3FmamNKOTI2bXRnNW41aHZBNUI2U0JFMitSeWlDdTVUMWN3TE5EWGF6Zz0=-8B62e5F4",
    "trade_status": "PROCESSING"
}

{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "duplicate-out_trade_no",
    "sub_msg": "out_trade_no is duplicate"
}

Consejos de pago para el usuario

barcode es el número de ticket que el usuario necesita usar para el pago
Proveer un localizador puede ayudar al usuario a localizar una tienda rápidamente. Puedes conectarla en https://www.google.com/maps/search/oxxo/
Proporcionar una versión PDF descargable podría ayudar a los usuarios móviles a tener sus tickets en sus teléfonos sin mantener el navegador abierto.

Ejemplo

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id": "162************38",
    "out_trade_no": "202201010354004",
    "method": "OXXO",
    "order_amount": "12.01",
    "order_currency": "MXN",
    "subject": "trade pay test",
    "content": "trade pay test conent",
    "notify_url": "http://merchant/callback/success",
    "return_url": "https://www.merchant.com",
    "buyer_id": "buyer_0101_0001",
    "timestamp": "2022-01-01 03:54:01",
    "timeout_express":"1c",
    "customer" : {
        "identify": {
            "type": "RFC",
            "number": "MAMB780915969"
        },
        "name": "Test User Name",
        "email": "test@pagsmile.com",
        "phone": "523135759140"
    },
    "address" : {
        "zip_code": "37900",
    }'

Nota: 162************38 es el test ID de pagsmile para prueba en sandbox, y MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== es el token de autorización asociado con el app ID de prueba.

Favor utilizar tu propio app_id y genera tu propio authorization token al realizar pruebas.

PreviousCoDi NextOXXOPay

Last updated 1 year ago