Simulate a Virtual Account Payment

This endpoint allows you to simulate an incoming payment to a virtual account. Available only in the Stage environment. It is designed for merchants to test their integration's end-to-end flow, including receiving payment notifications and verifying transaction statuses, without requiring actual bank transfers.

Environment Restriction

This endpoint is available in the Stage environment only and is intended exclusively for testing purposes.

Payer Identity

Use the same beneficiary data — name, document type, and document ID — that was provided when creating the virtual account. There are no separate test identities required; the endpoint validates the payer data against the information registered during account creation.

Body Params
string
required

A unique identifier for the simulated payin transaction. This value acts as the ID for the payin generated by this simulation and must be different for each request. We recommend using UUID4 format.

paymentMethod
object
required
string
enum
required

The country where the virtual account is located (ISO 3166-1 alpha-3).

Allowed:
string
enum
required

The currency of the payment (ISO 4217).

Allowed:
number
required

The amount to simulate for the payment.

string
required

The account number that Localpayment associates with the merchant, unique for each one.

beneficiary
object
required

Information about the entity receiving the funds.

payer
object
required

Information about the simulated payer. Use the same data — name, document type, and document ID — provided for the beneficiary when creating the virtual account.

Headers
string
required

Bearer access token for authentication. Obtained from the Get Access Token endpoint.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json