Session

The visual experience with which users interact to complete a payment is identified as a session.

POST/api/session

Create a session

This endpoint allows you to create a new session. In the session the user can complete a payment or subscription.

Request

Structure that contains all the information about the transaction to be processed.

Name
auth
Type
Authentication
is Required
REQUIRED
Description
Site authentication. See more in Authentication
Name
login
Type
string
is optional
Description
Site identifier.
Min length:1
Name
tranKey
Type
string
is optional
Description
Generated tranKey credential. See more in Authentication
Min length:1
Name
nonce
Type
string
is optional
Description
Random value for each Base64 encoded request.
Min length:1
Name
seed
Type
string
is optional
Description
Current date, which is generated in ISO 8601 format.
Min length:1
Name
payment
Type
PaymentRequest
is Required
REQUIRED
Description
Requested payment information.
Name
reference
Type
string
is Required
REQUIRED
Description
Unique payment reference, consisting of up to 32 alphanumeric characters and permitted symbols e.g.: PAYMENT_0001_ABC, Venta_1234-ABCD#2024/03/15$500, Ord: 1001/2023
Example:12345
Name
description
Type
string
is Required
REQUIRED
Description
Description of the process to be performed, allowing up to 250 alphanumeric, accented characters, and common symbols e.g.: Cita con el Dr. Pérez a las 10:00 am. 5/12/2024, por $100.00
Example:Consumo mes de Mayo
Name
amount
Type
Amount
is Required
REQUIRED
Description
Information on the amount to be collected
Name
currency
Type
string
is optional
Description
Alphabetical code of the currency to be used (ISO 4217 alpha code) e.g.: USD
Example:COP
Name
total
Type
number
is optional
Description
Total value in the indicated base currency
e.g.: 1000 equals one thousand dollars
Example:2000
Name
taxes
Type
array[Taxes]
is optional
Description
Structure to define taxes in the payment process.
Name
kind
Type
string
is optional
Description
Tax type identifier

One of: valueAddedTax exciseDuty ice airportTax stateTax reducedStateTax municipalTax.
Allowed values:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Example:valueAddedTax
Name
amount
Type
number
is optional
Description
Full amount of tax
e.g.: 200
Name
base
Type
number
is optional
Description
Base amount on which the tax is calculated
e.g.: 1000
Name
details
Type
array[Details]
is optional
Description
Structure to define additional details of the amount in the payment process.
Name
kind
Type
string
is optional
Description
Detail Type Identifier. One of: discount additional vatDevolutionBase shipping handlingFee insurance giftWrap subtotal fee tip airline interests
Allowed values:discountadditionalvatDevolutionBaseshippinghandlingFeeinsurancegiftWrapsubtotalfeetipairlineinterests
Example:discount
Name
amount
Type
number
is optional
Description
Total amount of detail

e.g.: 200
Name
allowPartial
Type
boolean
is optional
Description
Defines if the amount to be charged can be paid in several transactions. When set to true the user will be able to complete the payment in multiple transactions.
Default value:false
Name
shipping
Type
Person
is optional
Description
Structure to relate shipping information.
Name
document
Type
string
is optional
Description
Identification document

e.g.: 1017111222
Example:1122334455
Min length:1
Name
documentType
Type
string
is optional
Description
Document type identifier. View options in Document Types

e.g.: CC for "Cédula de Ciudadanía" in Colombia.
Example:CC
Min length:1
Name
name
Type
string
is optional
Description
Name of the person or company

e.g.: Juan José
Example:John
Min length:1
Name
surname
Type
string
is optional
Description
Last name of the person. Does not apply when the type of document corresponds to that of a company

e.g.: Peréz Pinzon
Example:Doe
Min length:1
Name
company
Type
string
is optional
Description
Name of the company to which the person belongs

e.g.: Placetopay
Example:Evertec
Name
email
Type
string
is optional
Description
Email of the user or company

e.g.: [email protected]
Example:[email protected]
Min length:1
Name
mobile
Type
string
is optional
Description
User or company phone number

e.g.: +573214445566
Example:+573111111111
Min length:1
Name
address
Type
address
is optional
Description
Structure to attach address or address information
Name
country
Type
string
is optional
Description
The country in which the address is located. ISO 3166-1 alpha-2 code.
Example:CO
Max length:2
Min length:2
Name
state
Type
string
is optional
Description
State/province/department. ISO 3166-2 code
Example:ANT
Max length:3
Name
city
Type
string
is optional
Description
City of residence
Example:Medellín
Min length:1
Name
postalCode
Type
string
is optional
Description
Postal code of the address
Example:55555
Min length:1
Name
street
Type
string
is optional
Description
Home address
Example:Calle 12 #33a-12, Apto 101
Min length:1
Name
phone
Type
string
is optional
Description
Home phone number
Example:+573111111111
Min length:1
Name
items
Type
array[Item]
is optional
Description
Structure to relate products or items in the process.
Name
sku
Type
string
is optional
Description
Item SKU.
e.g.: SKU-12345
Example:SKU-12345
Name
name
Type
string
is optional
Description
Article name.
e.g.: Manta de lana
Example:product_1
Min length:1
Name
category
Type
string
is optional
Description
Article category. One of: digital physical
Allowed values:digitalphysical
Example:physical
Min length:1
Name
qty
Type
number
is optional
Description
Number of articles of this type.
e.g.: 23
Example:1
Name
price
Type
number
is optional
Description
Total cost of the article.
e.g.: 1400
Example:1400
Name
tax
Type
number
is optional
Description
Item Tax Amount.
e.g.: 100
Name
fields
Type
array[NameValuePair]
is optional
Description
Structure to relate additional information in the process. See more in Additional Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
recurring
Type
object
is optional
Description
Structure to indicate the frequency of a recurring charge.
Name
periodicity
Type
string
is optional
Description
Frequency of collection
D Día, M Mes, Y Año
Allowed values:DMY
Example:D
Name
interval
Type
number
is optional
Description
Interval associated with the periodicity
e.g.: for 15 days.
Example:1
Max length:127
Min length:1
Name
nextPayment
Type
string
is optional
Description
next payment date
e.g.: 2019-08-24
Example:2019-08-24
Format:date
Name
maxPeriods
Type
number
is optional
Description
Maximum number of periods. Use -1 in case there is no limit
e.g.: 12 for a maximum of 12 charges
Example:1
Max length:32767
Min length:-1
Name
dueDate
Type
string
is optional
Description
Recurrence Due Date
e.g.: 2019-09-24
Example:2019-09-24
Format:date
Name
notificationUrl
Type
string
is optional
Description
URL in which the service will notify each time a charge is made
e.g.: https://merchant.com/notification
Example:https://checkout.placetopay.com
Name
subscribe
Type
boolean
is optional
Description
When true is sent, a subscription payment session is generated.

In the payment process, the user can choose whether or not to save his payment method to be used in future charges..
Default value:false
Name
dispersion
Type
array[DispersionDetail]
is optional
Description
When defined, a scatter payment session is generated. The generated payment can be divided into different destinations according to the given conditions.
Name
amount
Type
Amount
is optional
Description
I ride to "scatter" in this destination.
Name
currency
Type
string
is optional
Description
Alphabetical code of the currency to be used (ISO 4217 alpha code) e.g.: USD
Example:COP
Name
total
Type
number
is optional
Description
Total value in the indicated base currency
e.g.: 1000 equals one thousand dollars
Example:2000
Name
taxes
Type
array[Taxes]
is optional
Description
Structure to define taxes in the payment process.
Name
kind
Type
string
is optional
Description
Tax type identifier

One of: valueAddedTax exciseDuty ice airportTax stateTax reducedStateTax municipalTax.
Allowed values:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Example:valueAddedTax
Name
amount
Type
number
is optional
Description
Full amount of tax
e.g.: 200
Name
base
Type
number
is optional
Description
Base amount on which the tax is calculated
e.g.: 1000
Name
details
Type
array[Details]
is optional
Description
Structure to define additional details of the amount in the payment process.
Name
kind
Type
string
is optional
Description
Detail Type Identifier. One of: discount additional vatDevolutionBase shipping handlingFee insurance giftWrap subtotal fee tip airline interests
Allowed values:discountadditionalvatDevolutionBaseshippinghandlingFeeinsurancegiftWrapsubtotalfeetipairlineinterests
Example:discount
Name
amount
Type
number
is optional
Description
Total amount of detail

e.g.: 200
Name
agreement
Type
string|number
is optional
Description
Id of the destination of this amount. It can be the id of a site.

e.g.: 122
Name
agreementType
Type
string
is optional
Description
Type of destination of this amount. MERCHANT for sites, AIRLINE for airlines.
Allowed values:MERCHANTAIRLINE
Example:MERCHANT
Name
modifiers
Type
array[Modifiers]
is optional
Description
Structure to define modifiers in the collection.

Applies to tax laws in specific countries.
Name
type
Type
string
is optional
Description
Modifier type identifier. Only FEDERAL_GOVERNMENT is currently supported.
Allowed values:FEDERAL_GOVERNMENT
Example:FEDERAL_GOVERNMENT
Name
code
Type
number
is optional
Description
Modifier code.

For FEDERAL_GOVERMENT represents the law number for discount. 17934 Gastronomic Services 18083 IMESI Brazil - Argentina 19210 Financial Inclusion 18910 Family Allowances 18999 Real Estate Reimbursement
Allowed values:1793418083192101891018999
Example:17934
Name
additional
Type
object
is optional
Description
Structure for appending information to the modifier
Name
invoice
Type
string
is optional
Description
Required when modifiers.[].type is FEDERAL_GOVERMENT. Indicates the invoice number.

e.g.: 123456789
Example:123456789
Max length:9
Name
processorFields
Type
array[NameValuePair]
is optional
Description
Structure that may vary over time depending on the information available for the means of payment. See more in Processor Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
expiration
Type
string
is optional
Description
Expiration date of a session. The user must finish the process before this date. The expiration time must be at least 5 minutes from the time of creation. See more in Expiration date
e.g.: 2024-09-03T12:23:39-05:00
Format:date-time
Name
ipAddress
Type
string
is Required
REQUIRED
Description
IP address of the user who will perform the process.
e.g.: 134.10.163.36
Example:134.10.163.36
Name
userAgent
Type
string
is Required
REQUIRED
Description
User Agent of the user's browser that will carry out the process.

e.g.: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
Example:PlacetoPay Sandbox
Name
returnUrl
Type
string
is Required
REQUIRED
Description
Return URL, to this url the user is redirected once the session ends. Occurs when the user clicks on Return to commerce.

e.g.: https://merchant.com/return
Example:https://commerce.test/return
Name
locale
Type
string
is optional
Description
Language in which the request and the session will be processed. See more in Location

e.g.: en_US, es_CO
Example:en_US
Format:regex
Pattern:^\w{2}\_[A-Z]{2}
Name
buyer
Type
Person
is optional
Description
User data buyer, refers to the user who is buying a product or service.

When a session is created: It can be sent if you know the user who is making the purchase, as it helps to complete the session information. If this data is sent, the user will have their personal data pre-filled and will be able to change them at Checkout.
Name
document
Type
string
is optional
Description
Identification document

e.g.: 1017111222
Example:1122334455
Min length:1
Name
documentType
Type
string
is optional
Description
Document type identifier. View options in Document Types

e.g.: CC for "Cédula de Ciudadanía" in Colombia.
Example:CC
Min length:1
Name
name
Type
string
is optional
Description
Name of the person or company

e.g.: Juan José
Example:John
Min length:1
Name
surname
Type
string
is optional
Description
Last name of the person. Does not apply when the type of document corresponds to that of a company

e.g.: Peréz Pinzon
Example:Doe
Min length:1
Name
company
Type
string
is optional
Description
Name of the company to which the person belongs

e.g.: Placetopay
Example:Evertec
Name
email
Type
string
is optional
Description
Email of the user or company

e.g.: [email protected]
Example:[email protected]
Min length:1
Name
mobile
Type
string
is optional
Description
User or company phone number

e.g.: +573214445566
Example:+573111111111
Min length:1
Name
address
Type
address
is optional
Description
Structure to attach address or address information
Name
country
Type
string
is optional
Description
The country in which the address is located. ISO 3166-1 alpha-2 code.
Example:CO
Max length:2
Min length:2
Name
state
Type
string
is optional
Description
State/province/department. ISO 3166-2 code
Example:ANT
Max length:3
Name
city
Type
string
is optional
Description
City of residence
Example:Medellín
Min length:1
Name
postalCode
Type
string
is optional
Description
Postal code of the address
Example:55555
Min length:1
Name
street
Type
string
is optional
Description
Home address
Example:Calle 12 #33a-12, Apto 101
Min length:1
Name
phone
Type
string
is optional
Description
Home phone number
Example:+573111111111
Min length:1
Name
payer
Type
Person
is optional
Description
Data of the user payer, refers to the owner of the means of payment or user who paid the requested amount.

When a session is created: It should only be used when you want to "force" the data of the user who will complete the process. If this data is sent, the user will have their personal data pre-filled but will not be able to change them.
Name
document
Type
string
is optional
Description
Identification document

e.g.: 1017111222
Example:1122334455
Min length:1
Name
documentType
Type
string
is optional
Description
Document type identifier. View options in Document Types

e.g.: CC for "Cédula de Ciudadanía" in Colombia.
Example:CC
Min length:1
Name
name
Type
string
is optional
Description
Name of the person or company

e.g.: Juan José
Example:John
Min length:1
Name
surname
Type
string
is optional
Description
Last name of the person. Does not apply when the type of document corresponds to that of a company

e.g.: Peréz Pinzon
Example:Doe
Min length:1
Name
company
Type
string
is optional
Description
Name of the company to which the person belongs

e.g.: Placetopay
Example:Evertec
Name
email
Type
string
is optional
Description
Email of the user or company

e.g.: [email protected]
Example:[email protected]
Min length:1
Name
mobile
Type
string
is optional
Description
User or company phone number

e.g.: +573214445566
Example:+573111111111
Min length:1
Name
address
Type
address
is optional
Description
Structure to attach address or address information
Name
country
Type
string
is optional
Description
The country in which the address is located. ISO 3166-1 alpha-2 code.
Example:CO
Max length:2
Min length:2
Name
state
Type
string
is optional
Description
State/province/department. ISO 3166-2 code
Example:ANT
Max length:3
Name
city
Type
string
is optional
Description
City of residence
Example:Medellín
Min length:1
Name
postalCode
Type
string
is optional
Description
Postal code of the address
Example:55555
Min length:1
Name
street
Type
string
is optional
Description
Home address
Example:Calle 12 #33a-12, Apto 101
Min length:1
Name
phone
Type
string
is optional
Description
Home phone number
Example:+573111111111
Min length:1
Name
subscription
Type
SubscriptionRequest
is optional
Description
When sent, a subscription session is generated.

The user registers a means of payment so that later charges are made on that means of payment.
Name
reference
Type
Reference
is optional
Description
Unique reference of the process. Maximum of 32 characters

e.g.: PAYMENT_0001_ABC
Example:12345
Name
description
Type
Description
is optional
Description
Description of the process to be carried out

e.g.: Consumption for the month of May
Example:Consumption for the month of May
Name
fields
Type
array[NameValuePair]
is optional
Description
Structure to relate additional information in the process. See more in Additional Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
fields
Type
array[NameValuePair]
is optional
Description
Structure to relate additional information in the process. See more in Additional Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
paymentMethod
Type
string
is optional
Description
It is used to restrict the payment methods available at checkout. Multiple codes can be sent separated by commas. See more in Payment methods

e.g.: visa,master,pse
Example:visa
Name
cancelUrl
Type
string
is optional
Description
Cancellation URL, the user is redirected to this url when he decides not to continue with the process. Occurs when the user clicks on I don't want to continue

e.g.: https://merchant.com/cancel
Example:https://commerce.test/cancel
Name
skipResult
Type
boolean
is optional
Description
If true is sent, when the user finishes the process the session result page will not be displayed, instead they will be redirected to the returnUrl. See more in Skip result
Default value:false
Name
noBuyerFill
Type
boolean
is optional
Description
By default, the data sent as buyer is pre-filled in the Checkout interface to speed up the payment process, if this parameter is sent as true then this pre-fill will not be done.
Default value:false
Name
type
Type
string
is optional
Description
Parameter used for pre-authorization type sessions

Only checkin is supported to generate a pre-authorization session
Allowed values:checkin
Example:checkin
Name
metadata
Type
metadata
is optional
Description
Key-value structure used to send additional information and determine specific behaviors during session processing.
Name
initiatorIndicator
Type
string
is optional
Description
Indicates that the session will be processed by an agent using the cardholder's data
Allowed values:AGENTCARDHOLDER_COFCARDHOLDER_RECURRING_VARIABLE_AMOUNTCARDHOLDER_RECURRING_FIXED_AMOUNTCARDHOLDER_WITH_INSTALLMENTSMERCHANT_COFMERCHANT_RECURRING_VARIABLE_AMOUNTMERCHANT_RECURRING_FIXED_AMOUNTMERCHANT_WITH_INSTALLMENTS
Name
EBTDeliveryIndicator
Type
string
is optional
Description
(Required for EBT payments): Defines the delivery type
Allowed values:DIRECT_DELIVERYCUSTOMER_PICKUPCOMMERCIAL_SHIPPINGOTHERNOT_AVAILABLE
Name
openingDate
Type
string
is optional
Description
Account creation date (format: 'YYYY-MM-DD'). Required for PSE in merchants with “Financial Services” category.
Name
beneficiaryId
Type
string
is optional
Description
Beneficiary ID linked to the receiving account in a PSE transaction. Required for merchants in the “Financial Services” category

Request

POST

/api/session

curl -X "POST" https://checkout-test.placetopay.com/api/session \
  -H "Content-Type: application/json" \
  -d '{
      "locale": "es_CO",
      "auth": {
        "login":"c51ce410c124a10e0db5e4b97fc2af39",
        "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
        "nonce":"NjE0OWVkODgwYjNhNw==",
        "seed":"2021-09-21T09:34:48-05:00"
      },
      "payment": {
          "reference": "1122334455",
          "description": "Prueba",
          "amount": {
            "currency": "USD",
            "total": 100
          }
      },
      "expiration": "2021-12-30T00:00:00-05:00",
      "returnUrl": "https://dnetix.co/p2p/client",
      "ipAddress": "127.0.0.1",
      "userAgent": "PlacetoPay Sandbox"
  }'

Response

Name
status
Type
Status
is optional
Description
Structure that contains the response information about a request or payment, and reports the current status of the same.
Name
status
Type
string
is optional
Description
Status of a request or payment
Allowed values:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
Example:APPROVED
Min length:1
Name
reason
Type
string|number|null
is optional
Description
Reason Code Provided.
Example:00
Name
message
Type
string|null
is optional
Description
Description of the reason code.
Example:The petition has been successfully approved
Min length:1
Name
date
Type
string
is optional
Description
Date and time when the payment status is generated.
Example:2022-07-27T14:51:27-05:00
Format:date-time
Min length:1
Name
requestId
Type
integer
is optional
Description
Name
processUrl
Type
string
is optional
Description

Response

{
  "status": {
    "status": "OK",
    "reason": "PC",
    "message": "The request has been processed successfully",
    "date": "2021-11-30T15:08:27-05:00"
  },
  "requestId": 1,
  "processUrl": "https://checkout-co.placetopay.com/session/1/cc9b8690b1f7228c78b759ce27d7e80a",
}

POST/api/session/:requestId

Query a session

This endpoint allows you to obtain the information of the session, if there are transactions in the session, the details of the same are shown.

Params

Name
requestId
Type
requestId
is Required
REQUIRED
Description

Request

Name
auth
Type
Authentication
is Required
REQUIRED
Description
Site authentication. See more in Authentication
Name
login
Type
string
is optional
Description
Site identifier.
Min length:1
Name
tranKey
Type
string
is optional
Description
Generated tranKey credential. See more in Authentication
Min length:1
Name
nonce
Type
string
is optional
Description
Random value for each Base64 encoded request.
Min length:1
Name
seed
Type
string
is optional
Description
Current date, which is generated in ISO 8601 format.
Min length:1

Request

POST

/api/session/:requestId

curl -X "POST" https://checkout-test.placetopay.com/api/session/000000 \
  -H "Content-Type: application/json" \
  -d '{
      "auth": {
        "login": "c51ce410c124a10e0db5e4b97fc2af39",
        "tranKey": "VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
        "nonce": "NjE0OWVkODgwYjNhNw==",
        "seed": "2021-09-21T09:34:48-05:00"
      }
    }'

Response

Name
requestId
Type
string|number|integer
is optional
Description
Request id
Example:1
Name
status
Type
Status
is optional
Description
Structure that contains the response information about a request or payment, and reports the current status of the same.
Name
status
Type
string
is optional
Description
Status of a request or payment
Allowed values:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
Example:APPROVED
Min length:1
Name
reason
Type
string|number|null
is optional
Description
Reason Code Provided.
Example:00
Name
message
Type
string|null
is optional
Description
Description of the reason code.
Example:The petition has been successfully approved
Min length:1
Name
date
Type
string
is optional
Description
Date and time when the payment status is generated.
Example:2022-07-27T14:51:27-05:00
Format:date-time
Min length:1
Name
request
Type
RedirectRequest
is optional
Description
Structure that contains all the information about the transaction to be processed.
Name
auth
Type
Authentication
is Required
REQUIRED
Description
Site authentication. See more in Authentication
Name
login
Type
string
is optional
Description
Site identifier.
Min length:1
Name
tranKey
Type
string
is optional
Description
Generated tranKey credential. See more in Authentication
Min length:1
Name
nonce
Type
string
is optional
Description
Random value for each Base64 encoded request.
Min length:1
Name
seed
Type
string
is optional
Description
Current date, which is generated in ISO 8601 format.
Min length:1
Name
payment
Type
PaymentRequest
is Required
REQUIRED
Description
Requested payment information.
Name
reference
Type
string
is Required
REQUIRED
Description
Unique payment reference, consisting of up to 32 alphanumeric characters and permitted symbols e.g.: PAYMENT_0001_ABC, Venta_1234-ABCD#2024/03/15$500, Ord: 1001/2023
Example:12345
Name
description
Type
string
is Required
REQUIRED
Description
Description of the process to be performed, allowing up to 250 alphanumeric, accented characters, and common symbols e.g.: Cita con el Dr. Pérez a las 10:00 am. 5/12/2024, por $100.00
Example:Consumo mes de Mayo
Name
amount
Type
Amount
is Required
REQUIRED
Description
Information on the amount to be collected
Name
currency
Type
string
is optional
Description
Alphabetical code of the currency to be used (ISO 4217 alpha code) e.g.: USD
Example:COP
Name
total
Type
number
is optional
Description
Total value in the indicated base currency
e.g.: 1000 equals one thousand dollars
Example:2000
Name
taxes
Type
array[Taxes]
is optional
Description
Structure to define taxes in the payment process.
Name
kind
Type
string
is optional
Description
Tax type identifier

One of: valueAddedTax exciseDuty ice airportTax stateTax reducedStateTax municipalTax.
Allowed values:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Example:valueAddedTax
Name
amount
Type
number
is optional
Description
Full amount of tax
e.g.: 200
Name
base
Type
number
is optional
Description
Base amount on which the tax is calculated
e.g.: 1000
Name
details
Type
array[Details]
is optional
Description
Structure to define additional details of the amount in the payment process.
Name
kind
Type
string
is optional
Description
Detail Type Identifier. One of: discount additional vatDevolutionBase shipping handlingFee insurance giftWrap subtotal fee tip airline interests
Allowed values:discountadditionalvatDevolutionBaseshippinghandlingFeeinsurancegiftWrapsubtotalfeetipairlineinterests
Example:discount
Name
amount
Type
number
is optional
Description
Total amount of detail

e.g.: 200
Name
allowPartial
Type
boolean
is optional
Description
Defines if the amount to be charged can be paid in several transactions. When set to true the user will be able to complete the payment in multiple transactions.
Default value:false
Name
shipping
Type
Person
is optional
Description
Structure to relate shipping information.
Name
document
Type
string
is optional
Description
Identification document

e.g.: 1017111222
Example:1122334455
Min length:1
Name
documentType
Type
string
is optional
Description
Document type identifier. View options in Document Types

e.g.: CC for "Cédula de Ciudadanía" in Colombia.
Example:CC
Min length:1
Name
name
Type
string
is optional
Description
Name of the person or company

e.g.: Juan José
Example:John
Min length:1
Name
surname
Type
string
is optional
Description
Last name of the person. Does not apply when the type of document corresponds to that of a company

e.g.: Peréz Pinzon
Example:Doe
Min length:1
Name
company
Type
string
is optional
Description
Name of the company to which the person belongs

e.g.: Placetopay
Example:Evertec
Name
email
Type
string
is optional
Description
Email of the user or company

e.g.: [email protected]
Example:[email protected]
Min length:1
Name
mobile
Type
string
is optional
Description
User or company phone number

e.g.: +573214445566
Example:+573111111111
Min length:1
Name
address
Type
address
is optional
Description
Structure to attach address or address information
Name
country
Type
string
is optional
Description
The country in which the address is located. ISO 3166-1 alpha-2 code.
Example:CO
Max length:2
Min length:2
Name
state
Type
string
is optional
Description
State/province/department. ISO 3166-2 code
Example:ANT
Max length:3
Name
city
Type
string
is optional
Description
City of residence
Example:Medellín
Min length:1
Name
postalCode
Type
string
is optional
Description
Postal code of the address
Example:55555
Min length:1
Name
street
Type
string
is optional
Description
Home address
Example:Calle 12 #33a-12, Apto 101
Min length:1
Name
phone
Type
string
is optional
Description
Home phone number
Example:+573111111111
Min length:1
Name
items
Type
array[Item]
is optional
Description
Structure to relate products or items in the process.
Name
sku
Type
string
is optional
Description
Item SKU.
e.g.: SKU-12345
Example:SKU-12345
Name
name
Type
string
is optional
Description
Article name.
e.g.: Manta de lana
Example:product_1
Min length:1
Name
category
Type
string
is optional
Description
Article category. One of: digital physical
Allowed values:digitalphysical
Example:physical
Min length:1
Name
qty
Type
number
is optional
Description
Number of articles of this type.
e.g.: 23
Example:1
Name
price
Type
number
is optional
Description
Total cost of the article.
e.g.: 1400
Example:1400
Name
tax
Type
number
is optional
Description
Item Tax Amount.
e.g.: 100
Name
fields
Type
array[NameValuePair]
is optional
Description
Structure to relate additional information in the process. See more in Additional Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
recurring
Type
object
is optional
Description
Structure to indicate the frequency of a recurring charge.
Name
periodicity
Type
string
is optional
Description
Frequency of collection
D Día, M Mes, Y Año
Allowed values:DMY
Example:D
Name
interval
Type
number
is optional
Description
Interval associated with the periodicity
e.g.: for 15 days.
Example:1
Max length:127
Min length:1
Name
nextPayment
Type
string
is optional
Description
next payment date
e.g.: 2019-08-24
Example:2019-08-24
Format:date
Name
maxPeriods
Type
number
is optional
Description
Maximum number of periods. Use -1 in case there is no limit
e.g.: 12 for a maximum of 12 charges
Example:1
Max length:32767
Min length:-1
Name
dueDate
Type
string
is optional
Description
Recurrence Due Date
e.g.: 2019-09-24
Example:2019-09-24
Format:date
Name
notificationUrl
Type
string
is optional
Description
URL in which the service will notify each time a charge is made
e.g.: https://merchant.com/notification
Example:https://checkout.placetopay.com
Name
subscribe
Type
boolean
is optional
Description
When true is sent, a subscription payment session is generated.

In the payment process, the user can choose whether or not to save his payment method to be used in future charges..
Default value:false
Name
dispersion
Type
array[DispersionDetail]
is optional
Description
When defined, a scatter payment session is generated. The generated payment can be divided into different destinations according to the given conditions.
Name
amount
Type
Amount
is optional
Description
I ride to "scatter" in this destination.
Name
currency
Type
string
is optional
Description
Alphabetical code of the currency to be used (ISO 4217 alpha code) e.g.: USD
Example:COP
Name
total
Type
number
is optional
Description
Total value in the indicated base currency
e.g.: 1000 equals one thousand dollars
Example:2000
Name
taxes
Type
array[Taxes]
is optional
Description
Structure to define taxes in the payment process.
Name
kind
Type
string
is optional
Description
Tax type identifier

One of: valueAddedTax exciseDuty ice airportTax stateTax reducedStateTax municipalTax.
Allowed values:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Example:valueAddedTax
Name
amount
Type
number
is optional
Description
Full amount of tax
e.g.: 200
Name
base
Type
number
is optional
Description
Base amount on which the tax is calculated
e.g.: 1000
Name
details
Type
array[Details]
is optional
Description
Structure to define additional details of the amount in the payment process.
Name
kind
Type
string
is optional
Description
Detail Type Identifier. One of: discount additional vatDevolutionBase shipping handlingFee insurance giftWrap subtotal fee tip airline interests
Allowed values:discountadditionalvatDevolutionBaseshippinghandlingFeeinsurancegiftWrapsubtotalfeetipairlineinterests
Example:discount
Name
amount
Type
number
is optional
Description
Total amount of detail

e.g.: 200
Name
agreement
Type
string|number
is optional
Description
Id of the destination of this amount. It can be the id of a site.

e.g.: 122
Name
agreementType
Type
string
is optional
Description
Type of destination of this amount. MERCHANT for sites, AIRLINE for airlines.
Allowed values:MERCHANTAIRLINE
Example:MERCHANT
Name
modifiers
Type
array[Modifiers]
is optional
Description
Structure to define modifiers in the collection.

Applies to tax laws in specific countries.
Name
type
Type
string
is optional
Description
Modifier type identifier. Only FEDERAL_GOVERNMENT is currently supported.
Allowed values:FEDERAL_GOVERNMENT
Example:FEDERAL_GOVERNMENT
Name
code
Type
number
is optional
Description
Modifier code.

For FEDERAL_GOVERMENT represents the law number for discount. 17934 Gastronomic Services 18083 IMESI Brazil - Argentina 19210 Financial Inclusion 18910 Family Allowances 18999 Real Estate Reimbursement
Allowed values:1793418083192101891018999
Example:17934
Name
additional
Type
object
is optional
Description
Structure for appending information to the modifier
Name
invoice
Type
string
is optional
Description
Required when modifiers.[].type is FEDERAL_GOVERMENT. Indicates the invoice number.

e.g.: 123456789
Example:123456789
Max length:9
Name
processorFields
Type
array[NameValuePair]
is optional
Description
Structure that may vary over time depending on the information available for the means of payment. See more in Processor Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
expiration
Type
string
is optional
Description
Expiration date of a session. The user must finish the process before this date. The expiration time must be at least 5 minutes from the time of creation. See more in Expiration date
e.g.: 2024-09-03T12:23:39-05:00
Format:date-time
Name
ipAddress
Type
string
is Required
REQUIRED
Description
IP address of the user who will perform the process.
e.g.: 134.10.163.36
Example:134.10.163.36
Name
userAgent
Type
string
is Required
REQUIRED
Description
User Agent of the user's browser that will carry out the process.

e.g.: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
Example:PlacetoPay Sandbox
Name
returnUrl
Type
string
is Required
REQUIRED
Description
Return URL, to this url the user is redirected once the session ends. Occurs when the user clicks on Return to commerce.

e.g.: https://merchant.com/return
Example:https://commerce.test/return
Name
locale
Type
string
is optional
Description
Language in which the request and the session will be processed. See more in Location

e.g.: en_US, es_CO
Example:en_US
Format:regex
Pattern:^\w{2}\_[A-Z]{2}
Name
buyer
Type
Person
is optional
Description
User data buyer, refers to the user who is buying a product or service.

When a session is created: It can be sent if you know the user who is making the purchase, as it helps to complete the session information. If this data is sent, the user will have their personal data pre-filled and will be able to change them at Checkout.
Name
document
Type
string
is optional
Description
Identification document

e.g.: 1017111222
Example:1122334455
Min length:1
Name
documentType
Type
string
is optional
Description
Document type identifier. View options in Document Types

e.g.: CC for "Cédula de Ciudadanía" in Colombia.
Example:CC
Min length:1
Name
name
Type
string
is optional
Description
Name of the person or company

e.g.: Juan José
Example:John
Min length:1
Name
surname
Type
string
is optional
Description
Last name of the person. Does not apply when the type of document corresponds to that of a company

e.g.: Peréz Pinzon
Example:Doe
Min length:1
Name
company
Type
string
is optional
Description
Name of the company to which the person belongs

e.g.: Placetopay
Example:Evertec
Name
email
Type
string
is optional
Description
Email of the user or company

e.g.: [email protected]
Example:[email protected]
Min length:1
Name
mobile
Type
string
is optional
Description
User or company phone number

e.g.: +573214445566
Example:+573111111111
Min length:1
Name
address
Type
address
is optional
Description
Structure to attach address or address information
Name
country
Type
string
is optional
Description
The country in which the address is located. ISO 3166-1 alpha-2 code.
Example:CO
Max length:2
Min length:2
Name
state
Type
string
is optional
Description
State/province/department. ISO 3166-2 code
Example:ANT
Max length:3
Name
city
Type
string
is optional
Description
City of residence
Example:Medellín
Min length:1
Name
postalCode
Type
string
is optional
Description
Postal code of the address
Example:55555
Min length:1
Name
street
Type
string
is optional
Description
Home address
Example:Calle 12 #33a-12, Apto 101
Min length:1
Name
phone
Type
string
is optional
Description
Home phone number
Example:+573111111111
Min length:1
Name
payer
Type
Person
is optional
Description
Data of the user payer, refers to the owner of the means of payment or user who paid the requested amount.

When a session is created: It should only be used when you want to "force" the data of the user who will complete the process. If this data is sent, the user will have their personal data pre-filled but will not be able to change them.
Name
document
Type
string
is optional
Description
Identification document

e.g.: 1017111222
Example:1122334455
Min length:1
Name
documentType
Type
string
is optional
Description
Document type identifier. View options in Document Types

e.g.: CC for "Cédula de Ciudadanía" in Colombia.
Example:CC
Min length:1
Name
name
Type
string
is optional
Description
Name of the person or company

e.g.: Juan José
Example:John
Min length:1
Name
surname
Type
string
is optional
Description
Last name of the person. Does not apply when the type of document corresponds to that of a company

e.g.: Peréz Pinzon
Example:Doe
Min length:1
Name
company
Type
string
is optional
Description
Name of the company to which the person belongs

e.g.: Placetopay
Example:Evertec
Name
email
Type
string
is optional
Description
Email of the user or company

e.g.: [email protected]
Example:[email protected]
Min length:1
Name
mobile
Type
string
is optional
Description
User or company phone number

e.g.: +573214445566
Example:+573111111111
Min length:1
Name
address
Type
address
is optional
Description
Structure to attach address or address information
Name
country
Type
string
is optional
Description
The country in which the address is located. ISO 3166-1 alpha-2 code.
Example:CO
Max length:2
Min length:2
Name
state
Type
string
is optional
Description
State/province/department. ISO 3166-2 code
Example:ANT
Max length:3
Name
city
Type
string
is optional
Description
City of residence
Example:Medellín
Min length:1
Name
postalCode
Type
string
is optional
Description
Postal code of the address
Example:55555
Min length:1
Name
street
Type
string
is optional
Description
Home address
Example:Calle 12 #33a-12, Apto 101
Min length:1
Name
phone
Type
string
is optional
Description
Home phone number
Example:+573111111111
Min length:1
Name
subscription
Type
SubscriptionRequest
is optional
Description
When sent, a subscription session is generated.

The user registers a means of payment so that later charges are made on that means of payment.
Name
reference
Type
Reference
is optional
Description
Unique reference of the process. Maximum of 32 characters

e.g.: PAYMENT_0001_ABC
Example:12345
Name
description
Type
Description
is optional
Description
Description of the process to be carried out

e.g.: Consumption for the month of May
Example:Consumption for the month of May
Name
fields
Type
array[NameValuePair]
is optional
Description
Structure to relate additional information in the process. See more in Additional Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
fields
Type
array[NameValuePair]
is optional
Description
Structure to relate additional information in the process. See more in Additional Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
paymentMethod
Type
string
is optional
Description
It is used to restrict the payment methods available at checkout. Multiple codes can be sent separated by commas. See more in Payment methods

e.g.: visa,master,pse
Example:visa
Name
cancelUrl
Type
string
is optional
Description
Cancellation URL, the user is redirected to this url when he decides not to continue with the process. Occurs when the user clicks on I don't want to continue

e.g.: https://merchant.com/cancel
Example:https://commerce.test/cancel
Name
skipResult
Type
boolean
is optional
Description
If true is sent, when the user finishes the process the session result page will not be displayed, instead they will be redirected to the returnUrl. See more in Skip result
Default value:false
Name
noBuyerFill
Type
boolean
is optional
Description
By default, the data sent as buyer is pre-filled in the Checkout interface to speed up the payment process, if this parameter is sent as true then this pre-fill will not be done.
Default value:false
Name
type
Type
string
is optional
Description
Parameter used for pre-authorization type sessions

Only checkin is supported to generate a pre-authorization session
Allowed values:checkin
Example:checkin
Name
metadata
Type
metadata
is optional
Description
Key-value structure used to send additional information and determine specific behaviors during session processing.
Name
initiatorIndicator
Type
string
is optional
Description
Indicates that the session will be processed by an agent using the cardholder's data
Allowed values:AGENTCARDHOLDER_COFCARDHOLDER_RECURRING_VARIABLE_AMOUNTCARDHOLDER_RECURRING_FIXED_AMOUNTCARDHOLDER_WITH_INSTALLMENTSMERCHANT_COFMERCHANT_RECURRING_VARIABLE_AMOUNTMERCHANT_RECURRING_FIXED_AMOUNTMERCHANT_WITH_INSTALLMENTS
Name
EBTDeliveryIndicator
Type
string
is optional
Description
(Required for EBT payments): Defines the delivery type
Allowed values:DIRECT_DELIVERYCUSTOMER_PICKUPCOMMERCIAL_SHIPPINGOTHERNOT_AVAILABLE
Name
openingDate
Type
string
is optional
Description
Account creation date (format: 'YYYY-MM-DD'). Required for PSE in merchants with “Financial Services” category.
Name
beneficiaryId
Type
string
is optional
Description
Beneficiary ID linked to the receiving account in a PSE transaction. Required for merchants in the “Financial Services” category
Name
payment
Type
Transaction
is optional
Description
Name
status
Type
Status
is optional
Description
Structure that contains the response information about a request or payment, and reports the current status of the same.
Name
status
Type
string
is optional
Description
Status of a request or payment
Allowed values:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
Example:APPROVED
Min length:1
Name
reason
Type
string|number|null
is optional
Description
Reason Code Provided.
Example:00
Name
message
Type
string|null
is optional
Description
Description of the reason code.
Example:The petition has been successfully approved
Min length:1
Name
date
Type
string
is optional
Description
Date and time when the payment status is generated.
Example:2022-07-27T14:51:27-05:00
Format:date-time
Min length:1
Name
internalReference
Type
integer
is optional
Description
Internal referral at PlacetoPay.
Example:12345
Name
reference
Type
string
is optional
Description
Reference sent by the merchant for the transaction.
Example:12345
Name
paymentMethod
Type
string
is optional
Description
Code of the payment method used.
Example:visa
Name
paymentMethodName
Type
string
is optional
Description
Name of the payment method used.
Example:Visa
Name
issuerName
Type
string
is optional
Description
Issuer or processor name.
Example:JPMORGAN CHASE BANK, N.A.
Name
amount
Type
AmountConversion
is optional
Description
Structure to define the conversion factor and values.
Name
from
Type
AmountBase
is optional
Description
Structure that represents a quantity that defines the currency and the total.
Name
currency
Type
string
is optional
Description
Currency according to ISO 4217 (alphabetic code).
Example:COP
Name
total
Type
number|string
is optional
Description
Total value.
Example:10000
Name
to
Type
AmountBase
is optional
Description
Structure that represents a quantity that defines the currency and the total.
Name
currency
Type
string
is optional
Description
Currency according to ISO 4217 (alphabetic code).
Example:COP
Name
total
Type
number|string
is optional
Description
Total value.
Example:10000
Name
factor
Type
number|string
is optional
Description
Conversion factor
Example:1
Name
receipt
Type
string
is optional
Description
Transaction receipt number.
Example:052617800175
Name
franchise
Type
string
is optional
Description
Excess of the card used.
Example:PS_VS
Name
refunded
Type
boolean
is optional
Description
It is used to define if the transaction has been reversed
Default value:false
Name
authorization
Type
string
is optional
Description
Authorization code.
Example:965960
Name
processorFields
Type
array[NameValuePair]
is optional
Description
Structure that may vary over time depending on the information available for the means of payment. See more in Processor Fields
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1
Name
dispersion
Type
Transaction Dispersion
is optional
Description
Structure containing scattering information
Name
status
Type
Status
is optional
Description
Structure that contains the response information about a request or payment, and reports the current status of the same.
Name
status
Type
string
is optional
Description
Status of a request or payment
Allowed values:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
Example:APPROVED
Min length:1
Name
reason
Type
string|number|null
is optional
Description
Reason Code Provided.
Example:00
Name
message
Type
string|null
is optional
Description
Description of the reason code.
Example:The petition has been successfully approved
Min length:1
Name
date
Type
string
is optional
Description
Date and time when the payment status is generated.
Example:2022-07-27T14:51:27-05:00
Format:date-time
Min length:1
Name
agreement
Type
integer|null|string|number
is optional
Description
Transaction recipient identifier. For the main site of the transaction.
Example:186
Name
agreementType
Type
string|null
is optional
Description
Dispersion type
Allowed values:MERCHANTAIRLINE
Example:MERCHANT
Name
authorization
Type
string|null
is optional
Description
Authorization code.
Example:965960
Name
receipt
Type
string|null
is optional
Description
Transaction receipt number.
Example:052617800175
Name
amount
Type
AmountConversion
is optional
Description
Structure to define the conversion factor and values.
Name
from
Type
AmountBase
is optional
Description
Structure that represents a quantity that defines the currency and the total.
Name
currency
Type
string
is optional
Description
Currency according to ISO 4217 (alphabetic code).
Example:COP
Name
total
Type
number|string
is optional
Description
Total value.
Example:10000
Name
to
Type
AmountBase
is optional
Description
Structure that represents a quantity that defines the currency and the total.
Name
currency
Type
string
is optional
Description
Currency according to ISO 4217 (alphabetic code).
Example:COP
Name
total
Type
number|string
is optional
Description
Total value.
Example:10000
Name
factor
Type
number|string
is optional
Description
Conversion factor
Example:1
Name
refunded
Type
boolean
is optional
Description
It is used to define if the transaction has been reversed
Default value:false
Name
paymentMethod
Type
string
is optional
Description
Code of the payment method used.
Example:visa
Name
agreement
Type
integer|null|string|number
is optional
Description
Transaction recipient identifier. For the main site of the transaction.
Example:186
Name
agreementType
Type
string|null
is optional
Description
Dispersion type
Allowed values:MERCHANTAIRLINE
Example:MERCHANT
Name
discount
Type
object|null
is optional
Description
Name
base
Type
string|number
is optional
Description
Example:3000
Name
code
Type
string
is optional
Description
Example:17934
Name
type
Type
string
is optional
Description
Example:FRANCHISE
Name
amount
Type
number|string
is optional
Description
Example:1000
Name
subscription
Type
string|null
is optional
Description
Name
subscription
Type
SubscriptionResponse
is optional
Description
Structure containing information for the subscription payment method.
Name
status
Type
Status
is optional
Description
Structure that contains the response information about a request or payment, and reports the current status of the same.
Name
status
Type
string
is optional
Description
Status of a request or payment
Allowed values:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
Example:APPROVED
Min length:1
Name
reason
Type
string|number|null
is optional
Description
Reason Code Provided.
Example:00
Name
message
Type
string|null
is optional
Description
Description of the reason code.
Example:The petition has been successfully approved
Min length:1
Name
date
Type
string
is optional
Description
Date and time when the payment status is generated.
Example:2022-07-27T14:51:27-05:00
Format:date-time
Min length:1
Name
type
Type
string
is optional
Description
Defines type of subscription that is returned
Allowed values:tokencuenta
Example:token
Name
instrument
Type
array[NameValuePair]
is optional
Description
Name
keyword
Type
string
is optional
Description
Identifier or index of the data to be attached.
e.g.: cmsInvoiceId
Example:1111
Min length:1
Name
value
Type
string|object|array|number|boolean
is optional
Description
Value of the data to be attached.
e.g.: ID_2233
Example:lastDigits
Min length:1
Name
displayOn
Type
string
is optional
Description
Indicates under what conditions the attached data is displayed. See more in Additional Fields

One of: none, payment, receipt, both, approved.
Example:none
Min length:1

Response

{
  "requestId": 1,
  "status": {
    "status": "APPROVED",
    "reason": "00",
    "message": "The request has been successfully approved",
    "date": "2022-07-27T14:51:27-05:00"
  },
  "request": {
    "locale": "es_CO",
    "payer": {
      "document": "1122334455",
      "documentType": "CC",
      "name": "John",
      "surname": "Doe",
      "company": "Evertec",
      "email": "[email protected]",
      "mobile": "+5731111111111",
      "address": {
        "street": "Calle falsa 123",
        "city": "Medellín",
        "state": "Poblado",
        "postalCode": "55555",
        "country": "CO",
        "phone": "+573111111111"
      }
    },
    "buyer": {
      "document": "1122334455",
      "documentType": "CC",
      "name": "John",
      "surname": "Doe",
      "company": "Evertec",
      "email": "[email protected]",
      "mobile": "+5731111111111",
      "address": {
        "street": "Calle falsa 123",
        "city": "Medellín",
        "state": "Poblado",
        "postalCode": "55555",
        "country": "CO",
        "phone": "+573111111111"
      }
    },
    "payment": {
      "reference": "12345",
      "description": "Prueba de pago",
      "amount": {
        "currency": "COP",
        "total": 2000,
        "taxes": [
          {
            "kind": "valueAddedTax",
            "amount": 1000,
            "base": 0
          }
        ],
        "details": [
          {
            "kind": "discount",
            "amount": 1000
          }
        ]
      },
      "allowPartial": false,
      "shipping": {
        "document": "1122334455",
        "documentType": "CC",
        "name": "John",
        "surname": "Doe",
        "company": "Evertec",
        "email": "[email protected]",
        "mobile": "+5731111111111",
        "address": {
          "street": "Calle falsa 123",
          "city": "Medellín",
          "state": "Poblado",
          "postalCode": "55555",
          "country": "CO",
          "phone": "+573111111111"
        }
      },
      "items": [
        {
          "sku": "12345",
          "name": "product_1",
          "category": "physical",
          "qty": "1",
          "price": 1000,
          "tax": 0
        }
      ],
      "fields": [
        {
          "keyword": "_test_field_value_",
          "value": "_test_field_",
          "displayOn": "approved"
        }
      ],
      "recurring": {
        "periodicity": "D",
        "interval": "1",
        "nextPayment": "2019-08-24",
        "maxPeriods": 1,
        "dueDate ": "2019-09-24",
        "notificationUrl ": "https://checkout.placetopay.com"
      },
      "subscribe": false,
      "dispersion": [
        {
          "agreement": "1299",
          "agreementType": "MERCHANT",
          "amount": {
            "currency": "USD",
            "total": 200
          }
        }
      ],
      "modifiers": [
        {
          "type": "FEDERAL_GOVERNMENT",
          "code": 17934,
          "additional": {
            "invoice": "123345"
          }
        }
      ]
    },
    "subscription": {
      "reference": "12345",
      "description": "Example description",
      "fields": {
        "keyword": "1111",
        "value": "lastDigits",
        "displayOn": "none"
      }
    },
    "fields": [
      {
        "keyword": "_processUrl_",
        "value": "https://checkout.redirection.test/session/1/a592098e22acc709ec7eb30fc0973060",
        "displayOn": "none"
      }
    ],
    "paymentMethod": "visa",
    "expiration": "2019-08-24T14:15:22Z",
    "returnUrl": "https://commerce.test/return",
    "cancelUrl": "https://commerce.test/cancel",
    "ipAddress": "127.0.0.1",
    "userAgent": "PlacetoPay Sandbox",
    "skipResult": false,
    "noBuyerFill": false,
    "type": "checkin"
  },
  "payment": [
    {
      "status": {
        "status": "APPROVED",
        "reason": "00",
        "message": "The request has been successfully approved",
        "date": "2022-07-27T14:51:27-05:00"
      },
      "internalReference": 12345,
      "reference": "12345",
      "paymentMethod": "visa",
      "paymentMethodName": "Visa",
      "issuerName": "JPMORGAN CHASE BANK, N.A.",
      "amount": {
        "from": {
          "currency ": "COP",
          "total ": 10000
        },
        "to": {
          "currency ": "COP",
          "total ": 10000
        },
        "factor": 1
      },
      "receipt": "052617800175",
      "franchise": "PS_VS",
      "refunded": false,
      "authorization": "965960",
      "processorFields": [
        {
          "keyword": "1111",
          "value": "lastDigits",
          "displayOn": "none"
        }
      ],
      "dispersion": null,
      "agreement": null,
      "agreementType": null,
      "discount": {
        "base": 3000,
        "code": "17934",
        "type": "FRANCHISE",
        "amount": 1000
      },
      "subscription": null
    }
  ],
  "subscription": {
    "status": {
      "status": "OK",
      "reason": "00",
      "message": "The request has been successfully approved",
      "date": "2022-07-27T14:51:27-05:00"
    },
    "type": "token",
    "instrument": [
      {
        "keyword": "token",
        "value": "a3bfc8e2afb9ac5583922eccd6d2061c1b0592b099f04e352a894f37ae51cf1a",
        "displayOn": "none"
      },
      {
        "keyword": "subtoken",
        "value": "8740257204881111",
        "displayOn": "none"
      },
      {
        "keyword": "franchise",
        "value": "visa",
        "displayOn": "none"
      },
      {
        "keyword": "franchiseName",
        "value": "Visa",
        "displayOn": "none"
      },
      {
        "keyword": "issuerName",
        "value": "JPMORGAN CHASE BANK, N.A.",
        "displayOn": "none"
      },
      {
        "keyword": "lastDigits",
        "value": "1111",
        "displayOn": "none"
      },
      {
        "keyword": "validUntil",
        "value": "2029-12-31",
        "displayOn": "none"
      },
      {
        "keyword": "installments",
        "value": null,
        "displayOn": "none"
      }
    ]
  }
}