Get a payment initiation order

1 min
Get a payment initiation order
GET
Request
Response
Path Params
appId
String
required
App ID
id
String
required
Payment initiation id, it will be returned when POST /orders is called
Header Parameters
Authorization
String
required
Bearer access token, it returned by the /auth
Curl
Node.js
JS
Python
Ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api-testing.klavi.ai/payment/management/v1/merchants/{appId}/orders/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

require "uri"
require "json"
require "net/http"

url = URI("https://api-testing.klavi.ai/payment/management/v1/merchants/{appId}/orders/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body
Responses
200
409
{
    "id": "fcb72e3a-b346-4f71-b044-971dc23232c9",
    "createAt": "2023-01-23T14:17:06.45Z",
    "updateAt": "2023-01-23T14:17:06.45Z",
    "error": {
        "code": "NAO_INFORMADO",
        "title": "Não informado",
        "detail": "Erro não informado na iniciadora ou detentora de conta."
    },
    "status": "CANCELED",
    "externalId": "971dc23232c9",
    "appId": "0b59d801-08e0-4e84-9ecd-569f34e32279",
    "provider": {
        "tradeName": "Klavi",
        "avatar": "https://media.licdn.com/dms/image/C4D0BAQGwqthFsnjhpw/company-logo_200_200/0/1647885722250?e=1681948800&v=beta&t=A7-Ks2EcodobZmHhOutvZ6IS3OgjfHDclmuS7sSjRfs"
    },
    "participantId": "c8f0bf49-4744-4933-8960-7add6e590841",
    "user": {
        "taxId": "12345678901",
        "name": "dang"
    },
    "method": "PIX_MANU_AUTO",
    "amount": "4800",
    "date": "2023-01-23",
    "redirectURL": "https://app.sandbox.inic.dev/pag-receipt",
    "debtor": {
        "number": "",
        "accountType": "",
        "ispb": "",
        "issuer": "",
        "bank": {
            "id": "c8f0bf49-4744-4933-8960-7add6e590841",
            "name": "Mock Bank",
            "avatar": "https://cdn.raidiam.io/directory-ui/brand/obbrazil/0.2.0.112/favicon.svg"
        }
    },
    "creditor": {
        "taxId": "38231713000139",
        "name": "Klavi",
        "number": "********",
        "accountType": "CACC",
        "ispb": "60701190",
        "issuer": "****",
        "bank": {
            "name": "Mock Bank",
        }
    },
    "ibge": "IBGE", // Optional
    "metadata": {}, // Optional
    "endToEndId": "E44471172202401220923Uaeb155278c", // Optional
    "consentId": "urn:raidiambank:8a10ef4f-fad4-469d-ba54-8403bfeba960", // Optional
    "paymentId": "7dd18dc8-e7a7-4d98-8b95-f6db9cea4663", // Optional, bank payment id
    "scheduleId": "7a87bda2-bd41-4bfa-a3eb-5f0a0d73cc96" // Optional
}
{
    "id": "fcb72e3a-b346-4f71-b044-971dc23232c9",
    "createAt": "2023-01-23T14:17:06.45Z",
    "updateAt": "2023-01-23T14:17:06.45Z",
    "error": {
        "code": "NAO_INFORMADO",
        "title": "Não informado",
        "detail": "Erro não informado na iniciadora ou detentora de conta."
    },
    "status": "CANCELED",
    "externalId": "971dc23232c9",
    "appId": "0b59d801-08e0-4e84-9ecd-569f34e32279",
    "provider": {
        "tradeName": "Klavi",
        "avatar": "https://media.licdn.com/dms/image/C4D0BAQGwqthFsnjhpw/company-logo_200_200/0/1647885722250?e=1681948800&v=beta&t=A7-Ks2EcodobZmHhOutvZ6IS3OgjfHDclmuS7sSjRfs"
    },
    "participantId": "c8f0bf49-4744-4933-8960-7add6e590841",
    "user": {
        "taxId": "12345678901",
        "name": "dang"
    },
    "method": "PIX_MANU_AUTO",
    "amount": "4800",
    "date": "2023-01-23",
    "redirectURL": "https://app.sandbox.inic.dev/pag-receipt",
    "debtor": {
        "number": "",
        "accountType": "",
        "ispb": "",
        "issuer": "",
        "bank": {
            "id": "c8f0bf49-4744-4933-8960-7add6e590841",
            "name": "Mock Bank",
            "avatar": "https://cdn.raidiam.io/directory-ui/brand/obbrazil/0.2.0.112/favicon.svg"
        }
    },
    "creditor": {
        "taxId": "38231713000139",
        "name": "Klavi",
        "number": "********",
        "accountType": "CACC",
        "ispb": "60701190",
        "issuer": "****",
        "bank": {
            "name": "Mock Bank",
        }
    },
    "ibge": "IBGE", // Optional
    "metadata": {}, // Optional
    "endToEndId": "E44471172202401220923Uaeb155278c", // Optional
    "consentId": "urn:raidiambank:8a10ef4f-fad4-469d-ba54-8403bfeba960", // Optional
    "paymentId": "7dd18dc8-e7a7-4d98-8b95-f6db9cea4663", // Optional, bank payment id
    "scheduleId": "7a87bda2-bd41-4bfa-a3eb-5f0a0d73cc96" // Optional
}
﻿
﻿
Get all payment initiation orders
Release History