RecurringPaymentRequest

orderIdPayment-OrderId (string)required

An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.

Example: 14379133960355

amountint32

The amount to collected by this subsequent payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).

Example: 110

transactionTypePayment-TransactionType (string)

Same as the transactionType parameter from create payment. If not sent, it will default in the same transaction type used in the initial payment.

Enum Value	Description
SALE	Automatically captures funds when the customer authorizes the payment
AUTH	Places a hold on funds without immediate capture, allowing for later capture
PAYOUT	Sends funds to the customer
VERIF	Verifies the payment method without placing a hold or capturing funds

Possible values: [SALE, AUTH, PAYOUT, VERIF]

Default value: (same as initial payment)

Example: SALE

descriptionPayment-Description (string)

An arbitrary string attached to the payment. Often useful for displaying to users.

Example: Test Shop - #84370745531439

customer object

emailstring

The customer's email address.

Example: john.doe@example.com

namestring

The customer's full name or business name.

Example: John Doe

phonestring

The customer's phone number in E.164 format.

Example: null

billingDetails object

Billing information associated with the payment method at the time of the transaction.

namestring

The customer's billing full name.

Example: John Doe

emailstring

The customer's billing email address.

Example: john.doe@example.com

phonestring

The customer's billing phone number in E.164 format.

Example: null

companystring

Billing company name.

Example: null

taxIdstring

Company tax ID.

Example: null

address object

countryCountry (string)

Two-letter country code (ISO 3166-1 alpha-2).

Example: ES

citystring

City, district, suburb, town, or village.

Example: Málaga

line1string

Address line 1 (e.g., street, PO Box, or company name).

Example: Fake Street 123

line2string

Address line 2 (e.g., apartment, suite, unit, or building).

Example: null

zipstring

ZIP or postal code.

Example: 1234

statestring

State, county, province, or region.

Example: Málaga

shippingDetails object

Shipping information associated with the payment.

namestring

The shipping customer's full name.

Example: John Doe

emailstring

The shipping customer's email address.

Example: john.doe@example.com

phonestring

The shipping customer's phone number in E.164 format.

Example: null

companystring

Name of the company where the shipment is going.

Example: null

taxIdstring

Company tax ID.

Example: null

address object

countryCountry (string)

Two-letter country code (ISO 3166-1 alpha-2).

Example: ES

citystring

City, district, suburb, town, or village.

Example: Málaga

line1string

Address line 1 (e.g., street, PO Box, or company name).

Example: Fake Street 123

line2string

Address line 2 (e.g., apartment, suite, unit, or building).

Example: null

zipstring

ZIP or postal code.

Example: 1234

statestring

State, county, province, or region.

Example: Málaga

callbackUrlPayment-CallbackUrl (string)

The URL to which a payment result should be sent asynchronously.

Example: https://example.com/checkout/callback

metadataobject

A set of key-value pairs that you can attach to a resource. This can be useful for storing additional information about the resource in a structured format.

Example: {"systemId":"12345"}

RecurringPaymentRequest

{
  "orderId": "14379133960355",
  "amount": 110,
  "transactionType": "SALE",
  "description": "Test Shop - #84370745531439",
  "customer": {
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": null
  },
  "billingDetails": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": null,
    "company": null,
    "taxId": null,
    "address": {
      "country": "ES",
      "city": "Málaga",
      "line1": "Fake Street 123",
      "line2": null,
      "zip": "1234",
      "state": "Málaga"
    }
  },
  "shippingDetails": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": null,
    "company": null,
    "taxId": null,
    "address": {
      "country": "ES",
      "city": "Málaga",
      "line1": "Fake Street 123",
      "line2": null,
      "zip": "1234",
      "state": "Málaga"
    }
  },
  "callbackUrl": "https://example.com/checkout/callback",
  "metadata": {
    "systemId": "12345"
  }
}