Skip to main content
GET
Get payment by ID

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id
string

Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.

Path Parameters

id
string<uuid>
required

Payment identifier (UUID).

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

OK

amount
string
required
createdAt
string
required
id
string
required
status
string
required
type
string
required
updatedAt
string
required
canceledAt
string
cancellationReason
string
darf
object
description
string
digitableLine
string
dueDate
string
errorMessage
string
failedAt
string
midazOperationId
string
payee
object
providerId
string
rejectedAt
string
rejectionReason
string
settledAmount
string
settledAt
string