Type NP

This integration is not available for all merchants. Check availability with your manager.

What's different from a regular order?

For this payment method, you add extra fields in customer, externalUserId. The rest of the fields (amount, currency, successUrl, failUrl, etc.) remain the same as in a regular order creation.

External user ID is required for this payment method.

Additional Fields for common order

Field	Type	Description
`customer`	object	Buyer's data (email, phone, address, etc.)

Customer fields

Field	Type	Description
`country`	string	Country code for payment
`document`	string	Buyer's document
`documentType`	string	Buyer's document type
`email`	string	Buyer's email
`firstName`	string	First name
`lastName`	string	Last name

Supported currencies and countries

Country	Currency	Country Code
Argentina	`ARS`	`AR`
Mexico	`MXN`	`MX`
Colombia	`COP`	`CO`

Example payload

{
    "purpose": "Payment for order #1234",
    "amount": "1000.5",
    "externalId": "external_id",
    "externalUserId": "external_user_id",
    "successUrl": "https://example.com",
    "failUrl": "https://example.com",
    "callbackUrl": "https://example.com",
    "currency": "ARS",
    "isFeeOnUser": false,
    "customer": {
      "lastName": "Doe",
      "firstName": "John",
      "country": "AR",
      "email": "john.doe@example.com",
      "document": "YYY180222YY6",
      "documentType": "RFC"
    }
  }

Example response

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "1000.5",
  "currency": "ARS",
  "paymentType": null,
  "shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "fingerprint": null,
  "ipAddress": null,
  "gatewayTransactionId": null,
  "merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "externalId": "external_id",
  "externalUserId": "external_user_id",
  "paymentLink": "https://example.com/payment",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "metadata": null,
  "callbackUrl": "https://example.com",
  "payedAt": null,
  "updatedAt": "2023-03-21T12:34:56Z",
  "createdAt": "2023-03-21T12:34:56Z"
}

Type NP

Before you start

How to authorize your requests

How to create regular orders