Skip to main content
GET
/
v1
/
scheduled-payments
/
{id}
cURL
curl --request GET \
  --url https://api.example.com/v1/scheduled-payments/{id} \
  --header 'x-access-id: <api-key>'
{
  "amount_in_cents": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "details": {
    "end_to_end_id": "<string>",
    "pix_type": "<string>",
    "receiver": {
      "account_number": "<string>",
      "account_type": "payment_account",
      "bank": "<string>",
      "bank_code": "<string>",
      "document": "<string>",
      "name": "<string>"
    },
    "sender": {
      "account_number": "<string>",
      "account_type": "payment_account",
      "bank": "<string>",
      "bank_code": "<string>",
      "document": "<string>",
      "name": "<string>"
    },
    "message": "<string>",
    "pix_key": "<string>"
  },
  "id": 123,
  "receiver": "<string>",
  "scheduled_date": "2023-12-25",
  "status": "pending",
  "type": "pix",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "executed_at": "2023-11-07T05:31:56Z",
  "transaction_id": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-access-id
string
header
required

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

Path Parameters

​
id
integer<int64>
required

Scheduled payment identifier

Response

Scheduled payment details retrieved

​
amount_in_cents
integer<int64>
required
​
created_at
string<date-time>
required
​
details
object
required
​
id
integer<int64>
required
​
receiver
string
required
​
scheduled_date
string<date>
required
​
status
enum<string>
required
Available options:
pending,
processing,
executed,
failed,
cancelled
​
type
string
required
Example:

"pix"

​
cancelled_at
string<date-time> | null
​
executed_at
string<date-time> | null
​
transaction_id
integer<int64> | null
​
updated_at
string<date-time> | null