Get Payment Initiations by scheduleId

1min
Get payment initiations
GET
Request
Path Params
scheduleId
required
String
scheduled PIX id, it will be returned when POST /scheduled is called
Header Parameters
Authorization
required
String
JWT bearer token
management token
Curl
Node.js
JS
Python
Ruby
curl --location --globoff 'https://api-testing.klavi.ai/payment/management/v1/scheduled/{scheduleId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://api-testing.klavi.ai/payment/management/v1/scheduled/{scheduleId}' \
--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
    "schedule": {
        "type": "MONTHLY",
        "startDate": "2024-05-20",
        "quantity": 7,
        "dayOfMonth": 15
    }, // Required
    "scheduleId": "19b0af8a-ff3b-4ac0-b388-d5941099e1c1" // Required
}]
[{
    "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
    "schedule": {
        "type": "MONTHLY",
        "startDate": "2024-05-20",
        "quantity": 7,
        "dayOfMonth": 15
    }, // Required
    "scheduleId": "19b0af8a-ff3b-4ac0-b388-d5941099e1c1" // Required
}]
﻿
﻿
﻿
Updated 30 May 2024
Did this page help you?
Get a Payment Initiation
Release History
Docs powered by Archbee
TABLE OF CONTENTS
GET
scheduled
Get Payment Initiations by scheduleId

﻿
