Get a Payment Initiation

3min

Get a payment initiation inform
GET
Request Params
Path Params
id
required
String
ayment initiation id, it will be returned when POST /payments is called
Header Parameters
Authorization
required
String
JWT bearer token
Curl
Node.js
JS
Python
Ruby
curl --location --globoff 'https://api-testing.klavi.ai/payment/customer/v1/payments/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://api-testing.klavi.ai/payment/customer/v1/payments/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
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
}
{
    "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
}
﻿
Request example
Curl
curl -L -X GET 'api-testing.klavi.ai/payment/customer/v1/payments/fcb72e3a-b346-4f71-b044-971dc23232c9' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 6IkpXVCJ9.eyJwYWdhdGV3YXkifQ.FKX8rT3jIFfeOLYTgTrzlSbOjMIMPAZipkH4VdhL-NB' 
curl -L -X GET 'api-testing.klavi.ai/payment/customer/v1/payments/fcb72e3a-b346-4f71-b044-971dc23232c9' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 6IkpXVCJ9.eyJwYWdhdGV3YXkifQ.FKX8rT3jIFfeOLYTgTrzlSbOjMIMPAZipkH4VdhL-NB' 
﻿
Response
Just added the following fields on the basis of Get a Payment Initiation﻿'s response:
Attribute
Type
Description
endToEndId
String
It is a unique identifier, generated in the initiating payment institution and received in the account holding institution, permeating the entire payment journey Pix.
minLength: 32
maxLength: 32
pattern: ^([E])([0-9]{8})([0-9]{4})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])(2[0-3]|[01][0-9])([0-5][0-9])([a-zA-Z0-9]{11})$
example: E9040088820210128000800123873170
consentId
String
Unique identifier of the consent created for the initiation of the requested payment
maxLength: 256
pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$
example: urn:bancoex:C1DD33123
paymentId
String
Unique code or identifier provided by the account holding institution to represent the initiation of individual payment. The paymentId must be different from endToEndId. This is the identifier that should be used to query the status of the payment initiation made.
minLength: 1
maxLength: 100
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$
example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl
﻿

Updated 29 May 2024

Did this page help you?

Create a Payment Initiation with Whitelabel

Await for Payment Status

Docs powered by Archbee

TABLE OF CONTENTS

Attribute	Type	Description
endToEndId	String	It is a unique identifier, generated in the initiating payment institution and received in the account holding institution, permeating the entire payment journey Pix. minLength: 32 maxLength: 32 pattern: ^([E])([0-9]{8})([0-9]{4})(0[1-9]\|1[0-2])(0[1-9]\|[1-2][0-9]\|3[0-1])(2[0-3]\|[01][0-9])([0-5][0-9])([a-zA-Z0-9]{11})$ example: E9040088820210128000800123873170
consentId	String	Unique identifier of the consent created for the initiation of the requested payment maxLength: 256 pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$ example: urn:bancoex:C1DD33123
paymentId	String	Unique code or identifier provided by the account holding institution to represent the initiation of individual payment. The paymentId must be different from endToEndId. This is the identifier that should be used to query the status of the payment initiation made. minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$ example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl