Skip to main content

Create Open Finance Payment

POST 
/v1/open-finance/payments

Create a new Open Finance payment after OAuth authorization.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

Body

required
    state stringrequired

    OAuth state parameter.

    authorization_code stringrequired

    OAuth authorization code.

Responses​

The payment created 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.

    created_at date-timerequired

    Payment created at.

    updated_at date-timerequired

    Payment updated at.

Loading...