Skip to main content

Get Open Finance Payment by ID

GET 
/v1/open-finance/payments/:id

Get an open finance payment by id.

Request​

Path Parameters

    id stringrequired

    Payment 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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses​

Payment returned successfully.

Schema
    id stringrequired

    Payment UUID.

    status stringrequired

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

    Payment status.

    amount numberrequired

    Payment amount in cents.

    end_to_end_id string

    End to end ID.

    rejection_reason_code string

    Rejection reason code.

    rejection_reason_detail string

    Rejection reason detail.

    created_at date-timerequired

    Payment created at.

    updated_at date-timerequired

    Payment updated at.

Loading...