API docs by Redocly

PagoLoco API (1.0.0)

Download OpenAPI specification:

API for managing payments.

Idempotency

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a payment fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single payment is created.

To perform an idempotent request, provide an Idempotence-Key header with a unique value (e.g., a UUID) in your request. The server stores the result of the first request with a given key and returns the same response for subsequent requests with that same key.

Merchant

Get Merchant Balance

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Payments

Create a Pay In

Authorizations:
apiKeyAuth
header Parameters
Idempotence-Key
required
string <= 254 characters
Example: 7b8f9e2e-2a2a-4a2a-8a2a-2a2a2a2a2a2a

A unique string used to ensure that requests are processed only once.

Request Body schema: application/json
required
amount
required
string

Amount as a string to avoid precision issues.

currency
required
string = 3 characters
paymentMethod
required
string (PaymentMethod)
Value: "bank_transfer"
object (PayerDto)
returnUrl
string <uri>
object <= 20 properties

Max keys = 20 Max key length = 40 Max value length = 500 Max metadata size <= 4 kB Types: string, number, boolean Flat object only

Responses

Callbacks

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "ARS",
  • "paymentMethod": "bank_transfer",
  • "payer": {
    },
  • "returnUrl": "http://example.com",
  • "metadata": {
    }
}

Callback payload samples

Callback
POST: Pay-in succeeded callback
Content type
application/json
{
  • "id": "string",
  • "status": "succeeded",
  • "amount": "string",
  • "currency": "ARS",
  • "input_amount": "string",
  • "fact_amount": "string",
  • "metadata": {
    }
}

Get a Pay In

Authorizations:
apiKeyAuth
path Parameters
publicId
required
string

Public ID of the payment

Responses

Response samples

Content type
application/json
{
  • "payment": {
    },
  • "instructions": {
    }
}

Create a Pay Out

Authorizations:
apiKeyAuth
header Parameters
Idempotence-Key
required
string <= 254 characters
Example: 7b8f9e2e-2a2a-4a2a-8a2a-2a2a2a2a2a2a

A unique string used to ensure that requests are processed only once.

Request Body schema: application/json
required
amount
required
string
currency
required
string = 3 characters
paymentMethod
required
string (PaymentMethod)
Value: "bank_transfer"
required
object (PayeeDto)
returnUrl
string <uri>
object <= 20 properties

Max keys = 20 Max key length = 40 Max value length = 500 Max metadata size <= 4 kB Types: string, number, boolean Flat object only

Responses

Callbacks

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "ARS",
  • "paymentMethod": "bank_transfer",
  • "payee": {
    },
  • "returnUrl": "http://example.com",
  • "metadata": {
    }
}

Callback payload samples

Callback
POST: Payout succeeded callback
Content type
application/json
{
  • "id": "string",
  • "status": "succeeded",
  • "amount": "string",
  • "currency": "ARS",
  • "input_amount": "string",
  • "fact_amount": "string",
  • "metadata": {
    }
}

Get a Pay Out

Authorizations:
apiKeyAuth
path Parameters
publicId
required
string

Public ID of the payment

Responses

Response samples

Content type
application/json
{
  • "payment": {
    }
}