Quick Start

Get your API keys

Your API requests are authenticated using Bearer Tokens. Any request that doesn't include a Bearer Tokens will return an error.

You can generate a Bearer Token using the Authentication methods.

Authentication

Make your first request

To make your first request, send an authenticated request to the payments endpoint. This will return a payment, which is nice.

Get Payment Status

GET https://stage.api.payments.depay.us/payments/{order_id}/status

Allows users to inquire about the Payment status.

Query Parameters

Name
Type
Description

order_id*

string

Order identifier. This field corresponds to the id field within the order object retrieved from the QR information retrieval endpoint. Required.

Headers

Name
Type
Description

Authentication*

string

Bearer Token

{
    "id": "2da163d9-2f28-45bb-b160-13c0bd3872c2",
    "status": "COMLPETED",
    "creation_date": "2024-09-24T18:53:09.172Z",
    "update_date": "2024-12-16T08:10:00.000Z",
    "local_amount": "1000.0000",
    "local_currency": "BRL",
    "user_amount": "4.9594",
    "user_currency": "ARS",
    "external_reference": "a4e33400-2cb7-4823-b7f3-9a33e8136e20",
    "statuses": [
        {
            "status": "CREATED",
            "created_at": "2024-12-16T07:50:01.352Z"
        },
        {
            "status": "PROCESSING",
            "created_at": "2024-12-16T08:10:00.483Z"
        },
        {
            "status": "COMLPETED",
            "created_at": "2024-12-16T08:10:00.483Z"
        }
    ]
}
PreviousWelcome!NextAPI Reference