Credit Card

How to use CreditCard to submit a payin in Brazil.

Payin by CreditCard

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

This endpoint allows you to submit a payin by CreditCard in Brazil.

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 -

method*

string

Fixed value: CreditCard

out_trade_no*

string

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

notify_url*

string

Where Pagsmile will send notification to

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.01~50,000 BRL -

order_currency*

string

Fixed value: BRL

content

string

payment reason detail or item detail

- Max. 255 chars -

buyer_id*

string

merchant user's id

version*

string

Fixed value: 2.0

trade_type*

string

Fixed value: API

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)

customer.name*

string

User's name

customer.email*

string

User's email

customer.phone*

string

User's phone

customer.identify.type*

string

User's identification type

- CPF or CNPJ -

customer.identify.number*

string

User's identification number

- 11 digits if CPF or 14 digits if CNPJ -

address.zip_code*

string

billing zip code

{
    "code": "10000",
    "msg": "Success",
    "out_trade_no": "out***300",
    "trade_no": "20240***34",
    "prepay_id": "UloyV0l3NFFyW***DTT0=-645a8F4c"
}

Step 1: Follow the step here to add the Pagsmile JavaScript library.

Step 2: Get the "prepay_id" from the API response. Each transaction should create a unique prepay_id.

Step 3: Follow the step here to submit the payment form.

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "1649***56",
    * "out_trade_no": "out***3300",
    * "order_currency": "BRL",
    * "method": "CreditCard",
    * "order_amount": "1",
    * "subject": "pagsmile test ",
      "content": "pagsmile test ",
    * "trade_type": "API",
      "timeout_express": "15d",
    * "timestamp": "2024-07-04 18:50:42",
    * "notify_url": "http://demo.gemini-tiger.cn/callback/success",
    * "buyer_id": "buyer52023",
    * "version": "2.0",
    * "customer" : {
    * "identify": {
    *     "type": "CPF",
    *     "number": "39***826"
      },
    *     "name": "Gabr tinez",
    *     "email": "gabrz000@gmail.com",
    *     "phone": "119***21"
      }
    * "address": {
    *         "zip_code":"01001000"
          }
      }
}

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.

PreviousBrazilNextCredit Card Pre Auth

Last updated