CoDi

How to use Codi to submit a payin in Mexico.

Payin by CoDi

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

This endpoint allows you to submit a payin by CoDi in 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	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: CoDi
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 - 0.1~8,000 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

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: CoDi

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 - 0.1~8,000 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",
    "prepay_id":"QUVQM3ZrVHZhdGJU****VpK02mcHY1a1d23MVRDaz0=-D7a1a5B0",
    "trade_no": "2022010110293900084",
    "out_trade_no": "202201010354004",
    "web_url": "",
    "trade_status": "PROCESSING",
    "qr_code":"{\"TYP\":20,\"v\":{\"DEV\":\"00000161803500000000/0\"},\"ic\":{\"IDC\":\"2cee29d4ed\",\"SER\":7254764,\"ENC\":\"d6XHjV42clxs162KdoN+Md4yJlnoh3Rpj9L+/gM4QnqFt2I+qJrGIAIbi4oX743+xK7apETvIpn+IDQ2tbjTN8Zo4WiPwPaDBIndqrvEoZbixTFPvoqIU+Cb0YVrwR/BeZ2AcikYvNZjvU8SGT/4X4MmbOT/aubVvVse8//CNTCc****L0wG7E5cMSY2zXARRWLfkFSjwCt7xqjklPwxsV2Z0N25m0epbvXyhCr48w5rKTmmTIiSkJoBrQRHIJX45*****180BWsYs4nwNfQT65c//v2IfQxbb03NSwF*****hwpHkCszGzEO8xXHXNCQ/FjbNrcyT6bkSS0EK8L//AyX99oR4808V****FU+3lpL7xW6YBL+0Q30ogdFw==\"},\"CRY\":\"bPi7ICAIYZ+7klXLtfDvHdDSNa0dO0wazXtC9l8OaYM=\"}",
    "reference": "0000000",
}

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

User payment tips

Users only need to scan the QR code to finish the payment. QR code can be generated with qr_code value.

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": "CoDi",
    * "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.

PreviousNotification of Virtual Account Payment NextOXXOPay

Last updated 11 months ago