Create Card Payment

How to create a card payment.

Create Card Payment

Payin by CreditCard

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

This endpoint allows you to create a card payment.

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

CreditCard or DiscoverCard

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

order_currency*

string

BRL, HKD, JPY, USD, EUR or GBP

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

customer.name

string

User's name

token*

string

issuer*

string

issuer of CreditCard

user_ip*

string

user's IP address

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 -

customer.email

string

User's email

customer.phone

string

User's phone

address.zip_code

string

zip code

website_url

string

merchant website URL

- Max. 128 chars -

address.street

string

street

- Required if zip_code not provide -

address.street_number

string

street number

- Required if zip_code not provide -

address.city

string

city

- Required if zip_code not provide -

address.state

string

state - Required if zip_code not provide -

return_url

string

Redirect to Merchant's url when user finished checkout

installments

string

installments for CreditCard

threeds.server_trans_id

string

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call

threeds.version

string

Version used in the transaction

threeds.cavv

string

Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

threeds.status_code

string

3DSecure - Status code recieved from authorization/authentication response, (Possible values: U, N, Y, A, C, D, R, I)

threeds.eci

string

ECI value recieved from authorization/authentication response

threeds.status

string

3DSecure - Status text received from 3D secure vendor

threeds.status_reason_code

string

String EMVCO Indicator of the reason for the 3DS status code provided during the authentication, (Possible values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16)

threeds.liability_shift

string

liability shift - indicate whether the chargeback liability shifted to the card issuer

threeds.acs_trans_id

string

This field contains a universally unique transaction identifier assigned by the ACS to identify a single transaction.

threeds.ds_trans_id

string

A universally unique transaction identifier is assigned by the DS to identify a single transaction.

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)

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900084",
    "out_trade_no": "202201010354003",
    "web_url": "",
    "trade_status": "PROCESSING"
    "pay_url": "https://checkout-test.pagsmile.com/checkout?prepay_id=", //Only available when method=DiscoverCard
    "check_url": "https://checkout-test.pagsmile.com/checkout?prepay_id=", //For 3DS. Only available when method=DiscoverCard
    "form_data": { //Only available when 3DS is applied
        "sessionData": "TgTqjruKS4OC2p8-DfiRwm3S***Dl-W1zHGpgKPwRzO0=",
        "threeDSMethodData": "eyJ0aHJlZURTT***VydmMjQ5OCJ9",
        "threeDSMethodURL": "https://unkown.com",
        "id": "32364e8dbe0e405db42b9a7652dd90b6",
        "threeDSVersion": "2.1.0",
        "channelId": "EP",
        "threeDSServerTransID": "071754d6-ae10-4607-9118-b829a8002498"
   },
}

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

The merchant should have 3DS provider to get the value of "threeds".

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": "202201010354003",
    * "method": "CreditCard",
    * "order_amount": "12.01",
    * "order_currency": "BRL",
    * "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",
    * "user_ip":"127.0.0.1",
    * "token":"${token}",
    * "issuer":"visa",
      "installments":"1",
    * "timestamp": "2022-01-01 03:54:01",
      "timeout_express":"1c",
      "customer" : {
          "identify": {
              "type": "CPF",
              "number": "50284414727"
          },
          "name": "Test User Name",
          "email": "test@pagsmile.com",
          "phone": "75991435892"
      },
      "address": {
          "zip_code": "38082365",
      },
      "threeds": { //The "threeds" parameters are required to apply 3DS.
          "version":"2.1.0",
          "cavv":"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA",
          "eci":"05",
          "server_trans_id":"1111-2222-3333-4444",
          "acs_trans_id":"7777-8797-4645-1233",
          "ds_trans_id":"7777-8797-4645-1233",
          "status":"Cardholder authenticated",
          "status_code":"Y",
          "status_reason_code":"15",
          "liability_shift":"true"
      }
}'

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.

PreviousTokenization NextAuthorization

Last updated 1 month ago

Was this helpful?

Payin by CreditCard

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

This endpoint allows you to create a card payment.

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

CreditCard or DiscoverCard

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 - check -

order_currency*

string

BRL, HKD, JPY, USD, EUR or GBP

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

customer.name

string

User's name

token*

string

use to get toekn

issuer*

string

issuer of CreditCard

user_ip*

string

user's IP address

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 -

customer.email

string

User's email

customer.phone

string

User's phone

address.zip_code

string

zip code

website_url

string

merchant website URL

- Max. 128 chars -

address.street

string

street

- Required if zip_code not provide -

address.street_number

string

street number

- Required if zip_code not provide -

address.city

string

city

- Required if zip_code not provide -

address.state

string

state - Required if zip_code not provide -

return_url

string

Redirect to Merchant's url when user finished checkout

installments

string

installments for CreditCard

threeds.server_trans_id

string

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call

threeds.version

string

Version used in the transaction

threeds.cavv

string

Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

threeds.status_code

string

3DSecure - Status code recieved from authorization/authentication response, (Possible values: U, N, Y, A, C, D, R, I)

threeds.eci

string

ECI value recieved from authorization/authentication response

threeds.status

string

3DSecure - Status text received from 3D secure vendor

threeds.status_reason_code

string

String EMVCO Indicator of the reason for the 3DS status code provided during the authentication, (Possible values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16)

threeds.liability_shift

string

liability shift - indicate whether the chargeback liability shifted to the card issuer

threeds.acs_trans_id

string

This field contains a universally unique transaction identifier assigned by the ACS to identify a single transaction.

threeds.ds_trans_id

string

A universally unique transaction identifier is assigned by the DS to identify a single transaction.

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)

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900084",
    "out_trade_no": "202201010354003",
    "web_url": "",
    "trade_status": "PROCESSING"
    "pay_url": "https://checkout-test.pagsmile.com/checkout?prepay_id=", //Only available when method=DiscoverCard
    "check_url": "https://checkout-test.pagsmile.com/checkout?prepay_id=", //For 3DS. Only available when method=DiscoverCard
    "form_data": { //Only available when 3DS is applied
        "sessionData": "TgTqjruKS4OC2p8-DfiRwm3S***Dl-W1zHGpgKPwRzO0=",
        "threeDSMethodData": "eyJ0aHJlZURTT***VydmMjQ5OCJ9",
        "threeDSMethodURL": "https://unkown.com",
        "id": "32364e8dbe0e405db42b9a7652dd90b6",
        "threeDSVersion": "2.1.0",
        "channelId": "EP",
        "threeDSServerTransID": "071754d6-ae10-4607-9118-b829a8002498"
   },
}

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

The merchant should have 3DS provider to get the value of "threeds".

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": "202201010354003",
    * "method": "CreditCard",
    * "order_amount": "12.01",
    * "order_currency": "BRL",
    * "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",
    * "user_ip":"127.0.0.1",
    * "token":"${token}",
    * "issuer":"visa",
      "installments":"1",
    * "timestamp": "2022-01-01 03:54:01",
      "timeout_express":"1c",
      "customer" : {
          "identify": {
              "type": "CPF",
              "number": "50284414727"
          },
          "name": "Test User Name",
          "email": "test@pagsmile.com",
          "phone": "75991435892"
      },
      "address": {
          "zip_code": "38082365",
      },
      "threeds": { //The "threeds" parameters are required to apply 3DS.
          "version":"2.1.0",
          "cavv":"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA",
          "eci":"05",
          "server_trans_id":"1111-2222-3333-4444",
          "acs_trans_id":"7777-8797-4645-1233",
          "ds_trans_id":"7777-8797-4645-1233",
          "status":"Cardholder authenticated",
          "status_code":"Y",
          "status_reason_code":"15",
          "liability_shift":"true"
      }
}'

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