Information request
This service provides information about the user's card or token to be processed. It is recommended to always integrate via the Gateway.
Request
- Name
auth- Type
- Authentication
- is Required
- REQUIRED
- Description
Site authentication. See more in Authentication
- 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_COExample:en_USFormat:regexPattern:^\w{2}\_[A-Z]{2}
- Name
instrument- Type
- Instrument
- is Required
- REQUIRED
- Description
Structure that contains information about the means of payment to be used in a transaction. This structure is variable according to the request that is generated. Each service requires that one or another data be used.
Request
curl -X "POST" https://checkout-test.placetopay.com/api/gateway/information \
-H "Content-Type: application/json" \
-d '{
"locale": "es_CO",
"auth": {
"login":"aabbccdd1234567890aabbccdd123456",
"tranKey":"ABC123example456trankey+789abc012def3456ABC=",
"nonce":"NjE0OWVkODgwYjNhNw==",
"seed":"2021-09-21T09:34:48-05:00"
},
"payment": {
"reference": "1122334455",
"description": "Prueba",
"amount": {
"currency": "USD",
"total": 100
}
},
"instrument": {
"card": {
"number": "4110760000000008",
},
"token" : {
"token" : "f517475fd94ae67c84fe06593aaff5798ebf3a75664c2b6816024eb297be321e",
},
...
},
"ipAddress": "127.0.0.1",
"userAgent": "Testing"
}'
Response
OK
- Name
status- Type
- Status
- is Required
- REQUIRED
- Description
Structure that contains the response information about a request or payment, and reports the current status of the same.
- Name
provider- Type
- string
- is Required
- REQUIRED
- Description
Indicates which provider will be used in the transaction
Example:EBUS
- Name
serviceCode- Type
- string
- is Required
- REQUIRED
- Description
Indicates the code of the service that will process the transaction
Example:EB_VS
- Name
cardTypes- Type
- array[CardType]
- is optional
- Description
Indicates the card types supported by the provider
- Name
cardType- Type
- CardType
- is optional
- Description
Indicates the type of the card. C = credit, R = debit, A = savings
Allowed values:CRA
- Name
requiereOtp- Type
- boolean
- is optional
- Description
Indicates if it is necessary to perform the OTP flow
- Name
requiereCvv2- Type
- boolean
- is optional
- Description
Indicates whether it is required to send CVV for transaction processing
- Name
threeDS- Type
- string
- is optional
- Description
Indicates if 3DS is necessary
Allowed values:optionalrequiredunsupported
- Name
credits- Type
- array[Credit]
- is optional
- Description
Indicates the credits available per supplier
- Name
requirePockets- Type
- boolean
- is optional
- Description
Indicates if a pocket is required for processing the transaction
- Name
pockets- Type
- array[Pocket]
- is optional
- Description
Structure containing the card pockets
- Name
requireAvs- Type
- boolean
- is optional
- Description
Indicates whether zip code information is required
- Name
zipCodeFormat- Type
- string
- is optional
- Description
Format to be used for postal code validation
Nullable:Yes
- Name
accountVerification- Type
- boolean
- is optional
- Description
Indicates whether it is necessary to perform the account verification flow
- Name
requirePin- Type
- boolean
- is optional
- Description
Indicates if a pin is necessary to process the transaction
- Name
requireRedirection- Type
- boolean
- is optional
- Description
Indicates if the payment method is of the redirect type
- Name
bankList- Type
- array[BankItem]
- is optional
- Description
List of banks available to process a payment with PSE
Response
{
"status": {
"status": "OK",
"reason": "00",
"message": "The request has been successfully processed",
"date": "2021-09-21T09:26:11-05:00"
},
"provider": "CREDIBANCO",
"serviceCode": "CR_VS",
"cardType": "C",
"cardTypes": [
"C",
"R",
"A"
],
"displayInterest": false,
"requireOtp": false,
"requireCvv2": true,
"threeDS": "optional",
"credits": [
{
"description": "Installments",
"code": "0",
"groupCode": "C",
"type": "00",
"installments": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36
]
}
]
}