Payment-attempts

Payment attempts represent preliminary steps in a payment flow before actual authorization, capture, or settlement occurs.

They are used to simulate or stage a payment prior to executing a real transaction. Each attempt defines the intended origins, destinations, and method, allowing systems to validate or prepare the flow before the user completes the checkout process.

Use the Payment Attempts API to create new or simulated attempts, list all attempts, or retrieve details of a specific attempt.

Endpoints
POST /payment-attempts
GET /payment-attempts
GET /payment-attempts/:id

Create Attempt

post
Authorizations
Header parameters
x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Body
externalIdstringRequired

External reference identifier for integrations.

identityIdstringRequired

Identifier linking the transaction to a specific user or organization.

identityExternalIdstringOptional

External reference identifier for the identity associated with the transaction.

accountNumberstringRequired

The account number involved in the transaction.

totalAmountstringRequired

The total amount of the transaction.

currencystringRequired

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

descriptionstringOptional

A brief description of the transaction.

productstringOptional

The product or service related to the transaction. purchaseCurrency:Currency

typestring · enumRequired

Indicates the purpose of the payment. This field defines how the payment should be processed within the system, based on its intent—such as funding an account, withdrawing funds, transferring between users, collecting funds, or applying fees. Go to the payment types page for the complete list of supported values.

Possible values:
purchaseAmountstringOptional

The amount paid in the transaction.

purchaseCurrencystringOptional

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

Responses
201Success
application/json
post
POST /payment-attempts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 567

{
  "identityId": "679c482ee4420cb5b0966c9a",
  "accountNumber": "123456",
  "product": "ARS:ARS",
  "type": "PAYMENT",
  "purchaseAmount": "100",
  "purchaseCurrency": "ARS",
  "currency": "ARS",
  "origins": [
    {
      "name": "ETPAY",
      "type": "PAYMENT_INITATION",
      "amount": "100",
      "currency": "ARS",
      "paymentInitiation": {
        "origin": "ETPAY",
        "referenceId": "external_payment_id_1"
      }
    }
  ],
  "destinations": [
    {
      "type": "ACCOUNT",
      "amount": "100",
      "currency": "ARS",
      "identity": {
        "userId": "679c482ee4420cb5b0966c9a",
        "name": "Juan Pérez",
        "lastname": "Zúñiga",
        "nickname": "Juanpe",
        "dni": "12312252"
      },
      "account": {
        "accountNumber": "123456"
      }
    }
  ]
}
{
  "id": "text",
  "externalId": "text",
  "identityId": "text",
  "identityExternalId": "text",
  "accountNumber": "text",
  "totalAmount": "text",
  "currency": "text",
  "description": "text",
  "product": "text",
  "status": "text",
  "type": "PURCHASE",
  "purchaseAmount": "text",
  "purchaseCurrency": "text",
  "fees": [
    {
      "name": "text",
      "type": "FIXED",
      "value": "text",
      "amount": "text",
      "currency": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "expiresAt": "text",
  "capturedAt": "text",
  "authorizedAt": "text",
  "refundedAt": "text",
  "origins": [
    {
      "externalId": "text",
      "name": "text",
      "type": "PAYMENT_LINK",
      "amount": "text",
      "currency": "text",
      "settlement": "text",
      "fee": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text",
        "currency": "text"
      },
      "identity": {},
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "amountOut": "text",
      "card": {
        "holder": "text",
        "scheme": "text",
        "type": "text",
        "mask": "text",
        "country": "text",
        "tokenized": "text"
      }
    }
  ],
  "destinations": [
    {
      "externalId": "text",
      "name": "text",
      "type": "PAYMENT_LINK",
      "amount": "text",
      "currency": "text",
      "settlement": "text",
      "fee": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text",
        "currency": "text"
      },
      "identity": {},
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "amountOut": "text",
      "card": {
        "holder": "text",
        "scheme": "text",
        "type": "text",
        "mask": "text",
        "country": "text",
        "tokenized": "text"
      }
    }
  ],
  "settlement": "text"
}

Get payment-attempts

get
Authorizations
Query parameters
identityIdstringOptional

identityId

accountNumberstringOptional

account number

typestring · enumOptional

Indicates the purpose of the payment. This field defines how the payment should be processed within the system, based on its intent—such as funding an account, withdrawing funds, transferring between users, collecting funds, or applying fees. Go to the payment types page for the complete list of supported values.

Possible values:
startDatestringOptional

start date filter

endDatestringOptional

start date filter

limitstringOptional

Specifies the maximum number of items to return in a single request.

nextstringOptional

A cursor indicating the position of the last retrieved item.

Header parameters
x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses
200Success
application/json
get
GET /payment-attempts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "data": [
    {
      "id": "text",
      "externalId": "text",
      "identityId": "text",
      "identityExternalId": "text",
      "accountNumber": "text",
      "totalAmount": "text",
      "currency": "text",
      "description": "text",
      "product": "text",
      "status": "text",
      "type": "PURCHASE",
      "purchaseAmount": "text",
      "purchaseCurrency": "text",
      "fees": [
        {
          "name": "text",
          "type": "FIXED",
          "value": "text",
          "amount": "text",
          "currency": "text"
        }
      ],
      "createdAt": "text",
      "updatedAt": "text",
      "expiresAt": "text",
      "capturedAt": "text",
      "authorizedAt": "text",
      "refundedAt": "text",
      "origins": [
        {
          "externalId": "text",
          "name": "text",
          "type": "PAYMENT_LINK",
          "amount": "text",
          "currency": "text",
          "settlement": "text",
          "fee": {
            "name": "text",
            "type": "FIXED",
            "value": "text",
            "amount": "text",
            "currency": "text"
          },
          "identity": {},
          "metadata": {
            "image": "text",
            "description": "text",
            "category": "text"
          },
          "amountOut": "text",
          "card": {
            "holder": "text",
            "scheme": "text",
            "type": "text",
            "mask": "text",
            "country": "text",
            "tokenized": "text"
          }
        }
      ],
      "destinations": [
        {
          "externalId": "text",
          "name": "text",
          "type": "PAYMENT_LINK",
          "amount": "text",
          "currency": "text",
          "settlement": "text",
          "fee": {
            "name": "text",
            "type": "FIXED",
            "value": "text",
            "amount": "text",
            "currency": "text"
          },
          "identity": {},
          "metadata": {
            "image": "text",
            "description": "text",
            "category": "text"
          },
          "amountOut": "text",
          "card": {
            "holder": "text",
            "scheme": "text",
            "type": "text",
            "mask": "text",
            "country": "text",
            "tokenized": "text"
          }
        }
      ],
      "settlement": "text"
    }
  ],
  "pagination": {
    "pagination": {
      "count": 1,
      "next": 1,
      "previous": 1,
      "total": 1
    },
    "results": [
      {}
    ]
  }
}

Get payment-attempt

get
Authorizations
Path parameters
idstringRequired

Unique identifier for the payment-attempt.

Header parameters
x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses
200Success
application/json
get
GET /payment-attempts/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "id": "text",
  "externalId": "text",
  "identityId": "text",
  "identityExternalId": "text",
  "accountNumber": "text",
  "totalAmount": "text",
  "currency": "text",
  "description": "text",
  "product": "text",
  "status": "text",
  "type": "PURCHASE",
  "purchaseAmount": "text",
  "purchaseCurrency": "text",
  "fees": [
    {
      "name": "text",
      "type": "FIXED",
      "value": "text",
      "amount": "text",
      "currency": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "expiresAt": "text",
  "capturedAt": "text",
  "authorizedAt": "text",
  "refundedAt": "text",
  "origins": [
    {
      "externalId": "text",
      "name": "text",
      "type": "PAYMENT_LINK",
      "amount": "text",
      "currency": "text",
      "settlement": "text",
      "fee": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text",
        "currency": "text"
      },
      "identity": {},
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "amountOut": "text",
      "card": {
        "holder": "text",
        "scheme": "text",
        "type": "text",
        "mask": "text",
        "country": "text",
        "tokenized": "text"
      }
    }
  ],
  "destinations": [
    {
      "externalId": "text",
      "name": "text",
      "type": "PAYMENT_LINK",
      "amount": "text",
      "currency": "text",
      "settlement": "text",
      "fee": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text",
        "currency": "text"
      },
      "identity": {},
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "amountOut": "text",
      "card": {
        "holder": "text",
        "scheme": "text",
        "type": "text",
        "mask": "text",
        "country": "text",
        "tokenized": "text"
      }
    }
  ],
  "settlement": "text"
}
PreviousOrigins and destinationsNextPayments

Last updated