Skip to main content
POST
/
apm-installments
curl --request POST \
  --url https://api-sandbox.y.uno/v1/apm-installments \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Code: <api-key>' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "country": "BR",
  "amount": {
    "currency": "BRL",
    "value": "25000"
  },
  "customer": {
    "id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f"
  },
  "payment_method": "NU_PAY_ENROLLMENT",
  "vaulted_token": "vaulted_token_uuid"
}
'
[
  {
    "installment": 1,
    "amount": {
      "currency": "BRL",
      "value": 25000
    },
    "rate": 1
  },
  {
    "installment": 3,
    "amount": {
      "currency": "BRL",
      "value": 25000
    },
    "rate": 1.05
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.y.uno/llms.txt

Use this file to discover all available pages before exploring further.

The apm-installments endpoint allows you to retrieve available installment plans for specific Alternative Payment Methods (APMs). This is particularly useful for integrations like NuPay, where you may want to present installment options to the customer before finalizing the payment.

​
Usage Scenarios

Depending on your integration flow, you will use this endpoint differently:
  • Enrollment Flow: Used when a customer has already enrolled their NuPay account. You’ll need to provide the vaulted_token and the customer id.
  • 2FA Mode (Direct): Used for direct integrations where you collect customer details (email/document) to initiate a two-factor authentication flow.
This endpoint is currently specific to certain APMs. For standard credit card installments, please refer to the Installments Plan documentation.

Authorizations

​
public-api-key
string
header
required
​
private-secret-key
string
header
required
​
X-Account-Code
string
header
required

Body

application/json
​
country
string
required

ISO 3166-1 alpha-2 country code (e.g., BR).

Example:

"BR"

​
amount
object
required
​
payment_method
enum<string>
required

The specific NuPay method.

Available options:
NU_PAY,
NU_PAY_ENROLLMENT
Example:

"NU_PAY_ENROLLMENT"

​
customer
object

Customer data. Can include id or email and document details.

​
vaulted_token
string

Required for enrollment flow.

Example:

"vaulted_token_uuid"

Response

200 - application/json

List of available installment plans.

​
installment
integer
​
amount
object
​
rate
number