Skip to main content

Get All Open Finance Payments

GET 
/open-finance/payments

Get all open finance payments with filters.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [id, created_at, amount, payment_date, status]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    status string

    Possible values: [PENDING, WAITING, COMPLETED, FAILED, REJECTED, SCHEDULED, CANCELLED, ERROR]

    Payment status.

    created_at_start date-time

    Filter by created at start.

    created_at_end date-time

    Filter by created at end.

    participant_id string

    Participant UUID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Payments returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Payments data.

  • Array [
    • id stringrequired

    Payment UUID.

    user_id stringrequired

    User UUID.

    open_finance_participant_id stringrequired

    Participant UUID.

    payment_consent_id stringrequired

    Payment consent UUID.

    status stringrequired

    Possible values: [PENDING, WAITING, COMPLETED, FAILED, REJECTED, SCHEDULED, CANCELLED, ERROR]

    Payment status.

    amount numberrequired

    Payment amount in cents.

    payment_date date-timerequired

    Payment date.

    payment_type stringrequired

    Possible values: [PIX_KEY, PIX_ACCOUNT, QR_CODE_DYNAMIC, QR_CODE_STATIC]

    Payment type.

    end_to_end_id string

    End to end ID.

    rejection_reason_code string

    Rejection reason code.

    rejection_reason_detail string

    Rejection reason detail.

    failed_code string

    Failed code.

    failed_message string

    Failed message.

    third_part_creditor_name stringrequired

    Third part creditor name.

    third_part_creditor_document stringrequired

    Third part creditor document.

    third_part_creditor_person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Third part creditor person type.

    third_part_payment_creditor_account_ispb stringrequired

    Third part payment creditor account ISPB.

    third_part_payment_creditor_account_number stringrequired

    Third part payment creditor account number.

    third_part_payment_creditor_branch stringrequired

    Third part payment creditor branch.

    third_part_payment_creditor_account_type stringrequired

    Third part payment creditor account type.

    third_part_payment_pix_key string

    Third part payment pix key.

    third_part_payment_emv string

    Third part payment EMV.

    third_part_logged_user_document stringrequired

    Third part logged user document.

    third_part_logged_user_document_type stringrequired

    Possible values: [CPF, CNPJ]

    Third part logged user document type.

    third_part_business_entity_document string

    Third part business entity document.

    third_part_business_entity_document_type string

    Possible values: [CPF, CNPJ]

    Third part business entity document type.

    created_at date-timerequired

    Payment created at.

    updated_at date-timerequired

    Payment updated at.

  • ]
Loading...