v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB

Out Payment

Shows out payment details

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">out_payment:read</code>

get/out_payment/{id}

Response

idstring uuid

A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.

status'success' | 'pending' | 'deleted' | 'delayed'

Status of the out payment.

type'normal' | 'instant'

Type of out payment.

method'transfer' | 'mb'

Method used for the out payment.

keystring

Merchant reference key for the out payment.

valuenumber double

Amount to be transferred.

schedule_atstring

Scheduled date and time for the out payment (YYYY-MM-DD HH:MM:SS).

created_atstring

Date and time when the out payment was created.

timestampstring

Timestamp of the last update or event for this out payment.

Example response

{
  "schedule_at": "2022-09-15 20:28:58",
  "transactions": {
    "id": "4fb3ac57-c7fe-4157-aeb7-4362ae24deec",
    "key": "01J1PKR2RPHJNJQGFWGDYXY0KM",
    "created_at": "2025-05-30T17:21:47Z",
    "date": "2025-05-30T17:21:46Z",
    "values": {
      "requested": 12.55,
      "paid": 12.55,
      "fixed_fee": 0.07,
      "variable_fee": 0.09,
      "tax": 0.04,
      "transfer": 12.35
    },
    "transfer_date": "2025-06-02T00:00:00Z",
    "transfer_batch": "584",
    "method": "transfer",
    "document_number": "MARCEL0208220628294020250530172147",
    "descriptive": "blue t-shirts"
  },
  "created_at": "2022-09-15 20:28:58",
  "timestamp": "1749054192"
}