Placetopay Docs

POST/gateway/information

Information request

This service provides information about the user's card that is going to be processed, such as what services will be used for it and the types of credit, if applicable, that are available for it. If there are no types of credit, an arrangement is returned. empty and if there are, each type of credit must be iterated with the installments found in the arrangement.

Request

Name
locale
Type
string
is optional
Description
Determine the language of the response
Example:es-CO
Name
auth
Type
Autenticación
is optional
Description
Structure that contains the site authentication information generated according to the WSSE UsernameToken Profile 1.1
Name
instrument
Type
Instrument
is optional
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.
Name
payment
Type
Payment
is optional
Description
Structure that contains the information about the payment of the transaction required to the web service
Name
subscription
Type
Subscription
is optional
Description
Structure that contains information about a subscription or transaction that does not require a specific amount

Request

POST

/gateway/information

curl -X "POST" https://api-co-dev.placetopay.ws/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": "Test",
        "amount": {
            "currency": "USD",
            "total": 100
        }
    },
    "instrument": {
        "card": {
            "number": "4110760000000008",
        },
    },
    "ipAddress": "127.0.0.1",
    "userAgent": "Testing"
}'

Response

Name
status
Type
Status
is Required
REQUIRED
Description
Structure that contains information about a request or payment, informing its current status.
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
Name
requireBalance
Type
boolean
is optional
Description
Indicates whether it is necessary to consume the get balance service
Name
hasForwarding
Type
boolean
is optional
Description
Indicates if the payment method has configured transaction forwarding

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
            ]
            }
        ],
        "requireBalance": false,
    }

POST/gateway/interests

Interest Calculation (Ecuador only)

This service should be consumed if the card requires interest to be displayed (displayInterest set to true) and as an example of this way the values are displayed in the redirection service.

Request

Name
locale
Type
string
is optional
Description
Name
auth
Type
Autenticación
is optional
Description
Structure that contains the site authentication information generated according to the WSSE UsernameToken Profile 1.1
Name
instrument
Type
Instrument
is optional
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.
Name
payment
Type
Payment
is optional
Description
Structure that contains the information about the payment of the transaction required to the web service

Request

POST

/gateway/interests

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/interests \
-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"
    },
    "payer": {
        "name": "John",
        "email": "[email protected]"
    },
    "payment": {
        "reference": "1122334455",
        "amount": {
            "currency": "USD",
            "total": 100
        }
    },
    "instrument": {
        "card": {
            "number": "4110760000000008",
            "expiration": "12/20",
            "cvv": "123"
        },
        "credit": {
            "code": "1",
            "type": "02",
            "groupCode": "P",
            "installment": "24"
        }
    },
    "ipAddress": "127.0.0.1",
    "userAgent": "Testing"
}'

Response

Name
status
Type
Status
is optional
Description
Structure that contains information about a request or payment, informing its current status.
Name
provider
Type
string
is optional
Description
Name
values
Type
InterestValues
is optional
Description
Structure that contains the interest calculation information for a type of credit and amount
Name
conversion
Type
AmountConversion
is optional
Description
Structure to define the conversion factor and values.

Response

    {
        "status": {
            "status": "OK",
            "reason": "00",
            "message": "The request has been successfully processed",
            "date": "2021-09-22T16:08:19-05:00"
        },
        "provider": "INTERDIN",
        "values": {
            "original": 1,
            "installment": 0.04,
            "interest": 0.03,
            "total": 1.03
        },
        "conversion": {
            "from": {
            "currency": "COP",
            "total": 3000
            },
            "to": {
            "currency": "USD",
            "total": 1
            },
            "factor": 0.0003333333333333333
        }
    }

POST/gateway/balance

Get Balance

This service allows you to query balance information. It should be consumed if the payment method requires it (When the 'requireBalance' flag is 'true' in response from the information service).

Request

Name
locale
Type
string
is optional
Description
Name
auth
Type
Autenticación
is optional
Description
Structure that contains the site authentication information generated according to the WSSE UsernameToken Profile 1.1
Name
instrument
Type
Instrument
is optional
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.
Name
payment
Type
Payment
is optional
Description
Structure that contains the information about the payment of the transaction required to the web service

Request

POST

/gateway/balance

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/balance \
-H "Content-Type: application/json" \
-d '{
    "locale": "en_CR",
    "auth": {
        "login":"aabbccdd1234567890aabbccdd123456",
        "tranKey":"ABC123example456trankey+789abc012def3456ABC=",
        "nonce":"NjE0OWVkODgwYjNhNw==",
        "seed":"2021-09-21T09:34:48-05:00"
    },
    "payment": {
        "reference": "1122334455",
        "description": "Test"
        "amount": {
            "currency": "CRC",
            "total": 1000
        }
    },
    "instrument": {
         "card": {
            "number": "4111111111111111",
            "expiration": "12/30"
        },
    },
    "ipAddress": "127.0.0.1",
    "userAgent": "Testing"
}'

Response

Name
status
Type
Status
is optional
Description
Structure that contains information about a request or payment, informing its current status.
Name
total
Type
number
is optional
Description
Example:4973.19

Response

    {
        "status": {
            "status": "OK",
            "reason": "00",
            "message": "The request has been successfully processed",
            "date": "2021-09-22T16:08:19-05:00"
        },
        "provider": 42356.32
    }