docs.api.sandbox.convrt.cc Open in urlscan Pro
54.167.3.85  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (12)

 * Body
 * Headers (9)




Public


Documentation Settings

ENVIRONMENT
Convrt-Sandbox

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Convrt API
Introduction
Environments
Auth
Transactions
Webhooks


CONVRT API

We provide a diverse range of payment solutions aimed at empowering businesses,
expediting transactions, and fostering growth. A standout feature in our
portfolio is our merchant account and transaction management API. This manual
presents a series of endpoints responsible for managing merchants' transactions.
For inquiries or further information, please reach out to our support team at
mail to: suporte@onlineips.net.br.


ENVIRONMENTS

The default environment for this documentation is sandbox, in order to use the
production environment change the value of the BASE_URL variable. Below are the
values of the base url of each environment:

Sandbox: https://api.sandbox.convrt.cc

Production: https://api.convrt.cc


AUTH

The following endpoint is responsible for auth management.




POSTLOGIN

https://api.sandbox.convrt.cc/v1/account/api-client-login

This request is used to autheticate.

Bodyraw (json)
json


{
  "clientId": "eeefa7fb-fc54-498a-87f9-18b0f4854ea9",
  "clientSecret": "0kNOYmOClhf7nFhdsWfPKcZN+WzDNemSYt9mfVlM4DY=",



Example Request
Logged in successfully

curl


curl --location 'https://api.sandbox.convrt.cc/v1/account/api-client-login' \
--data '{
    "clientId": "587c417d-be30-461d-9344-443baf26d2d2",
    "clientSecret": "zh*r%Jg&EoY7wM%v_C_H9,:-KMwD"
}'

201 Created
Example Response
 * Body
 * Headers (12)

View More
json


{
  "expiresIn": 1692632571613,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjU4N2M0MTdkLWJlMzAtNDYxZC05MzQ0LTQ0M2JhZjI2ZDJkMiIsImFjY291bnRJZCI6IjZjYzVmMjcyLTMyODgtNDBmNy04NGFmLTQwOTA1NTY3NGFlMyIsImlhdCI6MTY5MjYzMjU3MTYxM30.SdGlQ8Wd2j7ytbGLv1eOMwot52llCzaEqsO601u1wq4"
}

Content-Type

application/json

Content-Length

282

Connection

keep-alive

Date

Mon, 21 Aug 2023 14:42:51 GMT

x-amzn-RequestId

5f8e3bcc-b71f-4e0f-b69f-b7a2f420fc35

Access-Control-Allow-Origin

*

x-amz-apigw-id

KA-seGE4oAMFYSA=

X-Amzn-Trace-Id

Root=1-64e377e9-3327a7f046ecec7658990b3e;Sampled=0;lineage=7bde04f9:0

X-Cache

Miss from cloudfront

Via

1.1 836d15812518886911b1ae2be813f462.cloudfront.net (CloudFront)

X-Amz-Cf-Pop

IAD79-C1

X-Amz-Cf-Id

RO4vS7ig-IexoJW2epoRhOtUShKn_w5HjP3gMzy_ElcZQwS5TCQHkw==

TRANSACTIONS

The following endpoint is responsible for transactions management.


PAYIN

In this section you will find all endpoints available for PayIn.


SANDBOX

The following requests will not be available in production.




PUTPAY ORDER (SANDBOX)

https://api.sandbox.convrt.cc/v1/charge/:orderId/pay

This endpoint is used to process a payment for a specific order identified by
the orderId in the URL. The request should be a HTTP PUT request to the
specified URL.

The request body for this endpoint has an undefined type and was null in the
last call. No specific parameters are required in the request body.

There are 3 main errors this endpoint can have:

   

 * Order not found for given id: If the orderId on the URL does not correspond
   to any existing order.

   

 * The order has expired: If the order expiration time has already passed.

   

 * Order status needs to be open: If trying to pay a order that is not with the
   open status.

   


RESPONSE

   
 * value (boolean): Indicates whether the payment processing was successful. A
   value of true signifies a successful payment process.
   

HEADERS
Authorization

Bearer

It is a required parameter in the request, to allow access to the resource.

PATH VARIABLES
orderId

501d1ebd-a290-4119-9417-fa8d83987802

This variable refers to a order identifier

Example Request
Invalid order id

curl


curl --location --request PUT 'https://api.sandbox.convrt.cc/v1/charge/invalid/pay' \
--header 'Authorization: Bearer '

400 Bad Request
Example Response
 * Body
 * Headers (9)

View More
json


{
  "code": "val-001",
  "message": "Validation Error",
  "shortMessage": "validationError",
  "details": [
    {
      "property": "orderId",
      "constraints": {
        "isUuid": "orderId must be a UUID"
      }
    }
  ]
}

content-type

application/json; charset=utf-8

vary

origin

access-control-allow-credentials

true

access-control-expose-headers

WWW-Authenticate,Server-Authorization

cache-control

no-cache

content-length

165

Date

Fri, 01 Sep 2023 18:55:11 GMT

Connection

keep-alive

Keep-Alive

timeout=5