The ITP object

Attributes

id string(36)
Unique identifier for the object.

---

code string(36)
Unique identifier for the object in your system.

---

amount integer(>0)
Amount in cents to be paid.

---

paidAmount integer(>0)
Amount in cents that was paid.

---

url string(256)
.

---

source BankAccount
This object represents a source bank account of the payment.

---

payer Payer
This object represents a payer of the payment.

---

split Split
This object represents a list of recipients who will receive part of the payment.

---

status enum
The status of the payment. Can be CREATED, PROCESSED, EXPIRED, PAID or FAILED.

Status	Description	Final Status
CREATED	Indicates that the payment was received.	No
PROCESSED	Indicates that the payment was processed by provider but needs confirmation.	No
ERROR	Indicates that an error has occurred.	Yes
PAID	Indicates that the payment was confirmed.	Yes
FAILED	Indicates that the payment was not processed.	Yes

---

createdAt datetime
Time at which the object was created.

---

processedAt datetime
Time at which the object was processed.

---

paidAt datetime
Time at which the object was paid.

---

failedAt datetime
Time at which the object failed.

---

metadata Metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Example

JSON

{
  	"id": "6a0b14a9-023c-4198-9ada-6e4684213340",
  	"code": "804a46a7-7012-4159-8782-1090e85e4afa",
    "type": "STATIC",
    "amount": 4990,
    "paidAmount": null,
    "url": "https://url.com",
    "payer": {
      "name": "Bruce Wayne",
      "taxId": "37515868066"
    },
    "split": [
      {
        "value": 990,
        "recipientId": "009cb956-3b58-4731-927f-20225600b35b"
      }
    ],
  	"status": "PROCESSED",
    "createdAt": "2022-06-06T11:48:21Z",
    "processedAt": "2022-06-06T11:48:26Z",
    "expiresAt": "2022-06-07T11:48:26Z",
    "paidAt": null,
    "failedAt": null,
    "metadata": [
      {
        "name": "CUSTOM_FIELD_NAME", 
        "value": "CUSTOM_FIELD_VALUE"
      }
    ]
}