API REFERENCE
...
Payments
Scheduled payment
Get Payment Initiations
1min
Get payment initiations
GET
Request Params
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
Curl
Node.js
JS
Python
Ruby
1curl --location --globoff 'https://api-testing.klavi.ai/payment/customer/v1/scheduled/{scheduleId}' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json'
Responses
200
409
1[{
2 "id": "fcb72e3a-b346-4f71-b044-971dc23232c9",
3 "createAt": "2023-01-23T14:17:06.45Z",
4 "updateAt": "2023-01-23T14:17:06.45Z",
5 "error": {
6 "code": "NAO_INFORMADO",
7 "title": "Não informado",
8 "detail": "Erro não informado na iniciadora ou detentora de conta."
9 },
10 "status": "CANCELED",
11 "externalId": "971dc23232c9",
12 "appId": "0b59d801-08e0-4e84-9ecd-569f34e32279",
13 "provider": {
14 "tradeName": "Klavi",
15 "avatar": "https://media.licdn.com/dms/image/C4D0BAQGwqthFsnjhpw/company-logo_200_200/0/1647885722250?e=1681948800&v=beta&t=A7-Ks2EcodobZmHhOutvZ6IS3OgjfHDclmuS7sSjRfs"
16 },
17 "participantId": "c8f0bf49-4744-4933-8960-7add6e590841",
18 "user": {
19 "taxId": "12345678901",
20 "name": "dang"
21 },
22 "method": "PIX_MANU_AUTO",
23 "amount": "4800",
24 "date": "2023-01-23",
25 "redirectURL": "https://app.sandbox.inic.dev/pag-receipt",
26 "debtor": {
27 "number": "",
28 "accountType": "",
29 "ispb": "",
30 "issuer": "",
31 "bank": {
32 "id": "c8f0bf49-4744-4933-8960-7add6e590841",
33 "name": "Mock Bank",
34 "avatar": "https://cdn.raidiam.io/directory-ui/brand/obbrazil/0.2.0.112/favicon.svg"
35 }
36 },
37 "creditor": {
38 "taxId": "38231713000139",
39 "name": "Klavi",
40 "number": "********",
41 "accountType": "CACC",
42 "ispb": "60701190",
43 "issuer": "****",
44 "bank": {
45 "name": "Mock Bank",
46 }
47 },
48 "ibge": "IBGE", // Optional
49 "metadata": {}, // Optional
50 "endToEndId": "E44471172202401220923Uaeb155278c", // Optional
51 "consentId": "urn:raidiambank:8a10ef4f-fad4-469d-ba54-8403bfeba960", // Optional
52 "paymentId": "7dd18dc8-e7a7-4d98-8b95-f6db9cea4663", // Optional, bank payment id
53 "schedule": {
54 "type": "MONTHLY",
55 "startDate": "2024-05-20",
56 "quantity": 7,
57 "dayOfMonth": 15
58 }, // Required
59 "scheduleId": "19b0af8a-ff3b-4ac0-b388-d5941099e1c1" // Required
60}]
Updated 30 May 2024
Did this page help you?