OXXO

How to use OXXO to submit a payin in Mexico.

PreviousWallet NextColombia

Last updated 11 months ago

Was this helpful?

OXXO

How to use OXXO to submit a payin in Mexico.

Payin by OXXO

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

This endpoint allows you to submit a payin by OXXO in Mexico.

OXXO is terminated on 2024.5.31. Please use .

Headers

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

created app's id at dashboard

- Max. 32 chars -

customer.phone

string

User's phone

customer.email*

string

User's email

customer.identify.number*

string

User's identification number

- RFC: 13 chars, ex: MAMB780915969; CURP: 18 chars -

method*

string

Fixed value: OXXO

out_trade_no*

string

ID given by the merchant in their system - Max. 64 chars -

notify_url*

string

Where Pagsmile will send notification to

customer.identify.type*

string

User's identification type

- RFC or CURP -

customer.name*

string

User's name

timestamp*

string

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

subject*

string

payment reason or item title

- Max. 128 chars -

order_amount*

string

payment amount - 8~9,999 MXN -

order_currency*

string

Fixed value: MXN

content

string

payment reason detail or item detail

- Max. 255 chars -

buyer_id*

string

merchant user's id

address.zip_code

string

zip code

- 5 digits -

website_url

string

merchant website URL

- Max. 128 chars -

address.street

string

street

address.street_number

string

street number

address.city

string

city

address.state

string

state

return_url

string

Redirect to Merchant's url when user finished 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"
}

OXXOPay is recommended because it has the same coverage as OXXO but can be processed instantly.

User payment tips

barcode is the ticket number that the user needs to use for payment
Providing a downloadable PDF version could help mobile users to have their tickets on their phones without keeping the browser open.

Example

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"
      }
      }'

Note: 162************38 is pagsmile's test app id for sandbox, and MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== is authorization token associated with the test app id.

Please use your own app_id and generate your own authorization token when testing.

PreviousWallet NextColombia

Last updated 11 months ago

Was this helpful?

Payin by OXXO

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

This endpoint allows you to submit a payin by OXXO in Mexico.

OXXO is terminated on 2024.5.31. Please use .

Headers

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

created app's id at dashboard

- Max. 32 chars -

customer.phone

string

User's phone

customer.email*

string

User's email

customer.identify.number*

string

User's identification number

- RFC: 13 chars, ex: MAMB780915969; CURP: 18 chars -

method*

string

Fixed value: OXXO

out_trade_no*

string

ID given by the merchant in their system - Max. 64 chars -

notify_url*

string

Where Pagsmile will send notification to

customer.identify.type*

string

User's identification type

- RFC or CURP -

customer.name*

string

User's name

timestamp*

string

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

subject*

string

payment reason or item title

- Max. 128 chars -

order_amount*

string

payment amount - 8~9,999 MXN -

order_currency*

string

Fixed value: MXN

content

string

payment reason detail or item detail

- Max. 255 chars -

buyer_id*

string

merchant user's id

address.zip_code

string

zip code

- 5 digits -

website_url

string

merchant website URL

- Max. 128 chars -

address.street

string

street

address.street_number

string

street number

address.city

string

city

address.state

string

state

return_url

string

Redirect to Merchant's url when user finished 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"
}

OXXOPay is recommended because it has the same coverage as OXXO but can be processed instantly.

User payment tips

barcode is the ticket number that the user needs to use for payment
Providing a locator could help the user to find a store faster. Can link it to
Providing a downloadable PDF version could help mobile users to have their tickets on their phones without keeping the browser open.

Example

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"
      }
      }'

Please use your own app_id and generate your own authorization token when testing.