Checkout Page (E-com)

How to use Pagsmile Checkoutpage to submit a payin.

Payin by using Pagsmile checkout page

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

This endpoint allows you to submit a payin by using Pagsmile checkout page

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.identify.number*

string

User's identification number

method

string

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

timestamp*

string

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

subject*

string

payment reason or item title

- Max. 128 chars -

order_amount*

string

order amount - 0.01 ~ 999999999 -

order_currency*

string

content*

string

payment reason detail or item detail. This will be shown on the bank bill.

- Max. 255 chars -

buyer_id*

string

merchant user's id

address.postal_code*

string

zip code

address.street*

string

street

address.street_number*

string

street number

address.city*

string

city

address.state*

string

state

channel

string

only use when method = Wallet

customer.phone*

string

User's phone

customer.email*

string

User's email

customer.name*

string

User's name

address.country*

string

country

trade_type*

string

fixed value: WEB

billing.address.postal_code*

string

billing zip code

billing.address.country*

string

billing country

billing.address.state*

string

billing state

billing.address.city*

string

billing city

billing.address.street*

string

billing street

billing.address.street_number*

string

billing street number

billing.address.neighborhood*

string

billing neighborhood

billing.identification.number*

string

billing identify number

billing.identification.type*

string

billing identify type

address.neighborhood*

string

neighborhood

billing.phone*

string

billing phone

billing.email*

string

billing email

billing.name*

string

billing name

shipping.address.street_number*

string

shipping street number

shipping.idenification.type*

string

shipping identify type

shipping.identification.number*

string

shipping identify number

shipping.address.neiborhood*

string

shipping neighborhood

shipping.address.street*

string

shipping street

shipping.address.city*

string

shipping city

shipping.address.state*

string

shipping state

shipping.address.country*

string

shipping country

shipping.address.postal_code*

string

shipping zip code

shipping.phone*

string

shipping phone

shipping.email*

string

shipping email

shipping.name*

string

shipping name

products.quanity*

string

product quantity

products.name*

string

product name - Max. 200 chars -

products.url*

string

product url - Max. 2000 chars -

products.description*

string

product description - Max. 1000 chars -

return_url

sring

web redirect url when payment is finish

timeout_express

string

m(minutes), h(hours), d(days), c(always end in current day).

Used to control the expiration time of submitting an order (from initial to processing). (90m in default, max 15d)

version*

string

fixed value: 2.0

cancellation_express

string

m(minutes), h(hours), d(days). The value must be an integer.

Used to cancel an order. Ex: 90m Used to control the expiration time of a processing order.

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900083",
    "out_trade_no": "202201010354003",
    "web_url": "http://checkout.pagsmile.com?prepay_id=123456"
}

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

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
      "charset": "UTF-8",
    * "app_id": "162************38",
    * "out_trade_no": "202201010354002",
    * "order_currency": "BRL",
    * "order_amount": "12.01",
    * "subject": "item name",
    * "content": "20 item description",
    * "trade_type": "WEB",
      "timeout_express": "15d",
    * "timestamp": "2022-01-01 03:54:01",
    * "notify_url": "http://merchant/callback/success",
    * "buyer_id": "buyer_0101_0001",
    * "version": "2.0",
    * "customer" : {
    *     "identification": {
    *         "type": "CPF",
    *         "number": "50284414001"
        },
    *     "name": "customer user name",
    *     "email": "test@gmail.com",
    *     "phone": "5511987654321",
    * 	"buyer_id": "buyer_0101_0001",
        "ip": "127.0.0.1"
      },
    * "address":{
    * 	         "postal_code":"38082365",
    *            "country":"address test country",
    *            "state":"address state123",
    *            "city":"address city123",
    *            "street":"address streetqqq",
    *            "street_number":"4567",
    *            "neighborhood":"neighbor address222"
   			 },
    * "billing": {
    *     "address": {
    *            "postal_code":"38082365",
    *            "country":"billingtest country001",
    *            "state":"billingstate123",
    *            "city":"billingcity123",
    *            "street":"billingstreetqqq",
    *            "street_number":"22222",
    *            "neighborhood":"billingneighborhood222"
          },
    *     "identification": {
    *         "type": "cpf",
    *         "number": "50284414727"
        },
    *     "email": "email@test.com",
    *     "name": "test",
    *     "phone": "5511987654321"
      },
    * "shipping": {
    *     "address": {
    *            "postal_code":"38082365",
    *            "country":"Brazil",
    *            "state":"shipping state123",
    *            "city":"shipping city123",
    *            "street":"shipping streetqqq",
    *            "street_number":"4567",
    *            "neighborhood":"shipping hood222"
          },
    *     "identification": {
    *         "type": "cpf",
    *         "number": "50284414727"
          },
    *     "email": "email@test.com",
    *     "name": "test",
    *     "phone": "5511987654321"
      },
    * "products": [
          {
    *         "quantity": "1",
    *         "name": "product 1",
    *         "url": "https://www.pagsmile.com/product/1",
    *         "description": "this is a product"
          },
          {
           "quantity": "1",
           "name": "product 2",
           "url": "https://www.pagsmile.com/product/2",
           "description": "this is a product"
          },
          {
           "quantity": "3",
           "name": "product 3",
           "url": "https://www.pagsmile.com/product/3",
           "description": "this is a product"
        },
        {
           "quantity": "4",
            "name": "product 4",
            "url": "https://www.pagsmile.com/product/4",
            "description": "this is a product"
        }
    ]
}'

Returnurl is not required in the request parameters. However if needed, you can overwrite it by appending the return_url after the web_url when redirect.

http://checkout.pagsmile.com?prepay_id={$prepay_id}

↓↓↓

http://checkout.pagsmile.com?prepay_id={$prepay_id}&return_url=encodeURIComponent({$return_url})

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.

PreviousCheckout Page (General)NextDirect integration

Last updated 3 months ago

Was this helpful?

Payin by using Pagsmile checkout page

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

This endpoint allows you to submit a payin by using Pagsmile checkout page

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.identify.number*

string

User's identification number

method

string

Add this object to show only the selected method. For instance, “method”: “PIX” will only show the PIX method. To show all the methods do not add this object in the request body. Check for all methods

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

- check to check identify type for different countries -

timestamp*

string

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

subject*

string

payment reason or item title

- Max. 128 chars -

order_amount*

string

order amount - 0.01 ~ 999999999 -

(refer to amount limit for different )

order_currency*

string

order currency - Max. 3 chars - Check for all methods.

content*

string

payment reason detail or item detail. This will be shown on the bank bill.

- Max. 255 chars -

buyer_id*

string

merchant user's id

address.postal_code*

string

zip code

address.street*

string

street

address.street_number*

string

street number

address.city*

string

city

address.state*

string

state

channel

string

only use when method = Wallet

customer.phone*

string

User's phone

customer.email*

string

User's email

customer.name*

string

User's name

address.country*

string

country

trade_type*

string

fixed value: WEB

billing.address.postal_code*

string

billing zip code

billing.address.country*

string

billing country

billing.address.state*

string

billing state

billing.address.city*

string

billing city

billing.address.street*

string

billing street

billing.address.street_number*

string

billing street number

billing.address.neighborhood*

string

billing neighborhood

billing.identification.number*

string

billing identify number

billing.identification.type*

string

billing identify type

address.neighborhood*

string

neighborhood

billing.phone*

string

billing phone

billing.email*

string

billing email

billing.name*

string

billing name

shipping.address.street_number*

string

shipping street number

shipping.idenification.type*

string

shipping identify type

shipping.identification.number*

string

shipping identify number

shipping.address.neiborhood*

string

shipping neighborhood

shipping.address.street*

string

shipping street

shipping.address.city*

string

shipping city

shipping.address.state*

string

shipping state

shipping.address.country*

string

shipping country

shipping.address.postal_code*

string

shipping zip code

shipping.phone*

string

shipping phone

shipping.email*

string

shipping email

shipping.name*

string

shipping name

products.quanity*

string

product quantity

products.name*

string

product name - Max. 200 chars -

products.url*

string

product url - Max. 2000 chars -

products.description*

string

product description - Max. 1000 chars -

return_url

sring

web redirect url when payment is finish

timeout_express

string

m(minutes), h(hours), d(days), c(always end in current day).

Used to control the expiration time of submitting an order (from initial to processing). (90m in default, max 15d)

version*

string

fixed value: 2.0

cancellation_express

string

m(minutes), h(hours), d(days). The value must be an integer.

Used to cancel an order. Ex: 90m Used to control the expiration time of a processing order.

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900083",
    "out_trade_no": "202201010354003",
    "web_url": "http://checkout.pagsmile.com?prepay_id=123456"
}

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

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
      "charset": "UTF-8",
    * "app_id": "162************38",
    * "out_trade_no": "202201010354002",
    * "order_currency": "BRL",
    * "order_amount": "12.01",
    * "subject": "item name",
    * "content": "20 item description",
    * "trade_type": "WEB",
      "timeout_express": "15d",
    * "timestamp": "2022-01-01 03:54:01",
    * "notify_url": "http://merchant/callback/success",
    * "buyer_id": "buyer_0101_0001",
    * "version": "2.0",
    * "customer" : {
    *     "identification": {
    *         "type": "CPF",
    *         "number": "50284414001"
        },
    *     "name": "customer user name",
    *     "email": "test@gmail.com",
    *     "phone": "5511987654321",
    * 	"buyer_id": "buyer_0101_0001",
        "ip": "127.0.0.1"
      },
    * "address":{
    * 	         "postal_code":"38082365",
    *            "country":"address test country",
    *            "state":"address state123",
    *            "city":"address city123",
    *            "street":"address streetqqq",
    *            "street_number":"4567",
    *            "neighborhood":"neighbor address222"
   			 },
    * "billing": {
    *     "address": {
    *            "postal_code":"38082365",
    *            "country":"billingtest country001",
    *            "state":"billingstate123",
    *            "city":"billingcity123",
    *            "street":"billingstreetqqq",
    *            "street_number":"22222",
    *            "neighborhood":"billingneighborhood222"
          },
    *     "identification": {
    *         "type": "cpf",
    *         "number": "50284414727"
        },
    *     "email": "email@test.com",
    *     "name": "test",
    *     "phone": "5511987654321"
      },
    * "shipping": {
    *     "address": {
    *            "postal_code":"38082365",
    *            "country":"Brazil",
    *            "state":"shipping state123",
    *            "city":"shipping city123",
    *            "street":"shipping streetqqq",
    *            "street_number":"4567",
    *            "neighborhood":"shipping hood222"
          },
    *     "identification": {
    *         "type": "cpf",
    *         "number": "50284414727"
          },
    *     "email": "email@test.com",
    *     "name": "test",
    *     "phone": "5511987654321"
      },
    * "products": [
          {
    *         "quantity": "1",
    *         "name": "product 1",
    *         "url": "https://www.pagsmile.com/product/1",
    *         "description": "this is a product"
          },
          {
           "quantity": "1",
           "name": "product 2",
           "url": "https://www.pagsmile.com/product/2",
           "description": "this is a product"
          },
          {
           "quantity": "3",
           "name": "product 3",
           "url": "https://www.pagsmile.com/product/3",
           "description": "this is a product"
        },
        {
           "quantity": "4",
            "name": "product 4",
            "url": "https://www.pagsmile.com/product/4",
            "description": "this is a product"
        }
    ]
}'

Returnurl is not required in the request parameters. However if needed, you can overwrite it by appending the return_url after the web_url when redirect.

http://checkout.pagsmile.com?prepay_id={$prepay_id}

↓↓↓

http://checkout.pagsmile.com?prepay_id={$prepay_id}&return_url=encodeURIComponent({$return_url})

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