Payment Docs
Card Methods

Type DL

How to make a payment with DL type connected terminal.

Before you start

How to authorize your requests

How to create regular orders

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, as well as externalUserId. The rest of the fields (amount, currency, successUrl, failUrl, etc.) remain the same as in a regular order creation.

The externalUserId field is required for this payment method.


Additional fields for a regular order

FieldTypeDescription
customerobjectBuyer's data (email, phone, address, etc.)

Nigeria

Customer object fields

FieldTypeDescription
countrystringCountry code for the payment
phonestringBuyer's phone number
documentstringBuyer's document number
documentTypestringBuyer's document type
emailstringBuyer's email
firstNamestringFirst name
lastNamestringLast name

Example request

{
  "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": "NGN",
  "isFeeOnUser": false,
  "customer": {
    "lastName": "Doe",
    "firstName": "John",
    "country": "NG",
    "phone": "254700000001",
    "email": "john.doe@example.com",
    "document": "A123456789",
    "documentType": "ID"
  }
}

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"
}

Kenya (M-Pesa Mobile Money)

Customer object fields

FieldTypeDescription
countrystringCountry code for the payment
emailstringBuyer's email
firstNamestringFirst name
lastNamestringLast name

Example request

{
  "purpose": "Payment for order #1234",
  "amount": "100",
  "externalId": "external_id",
  "externalUserId": "external_user_id",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "callbackUrl": "https://example.com",
  "currency": "KES",
  "isFeeOnUser": false,
  "customer": {
    "lastName": "Doe",
    "firstName": "John",
    "country": "KE",
    "email": "john.doe@example.com"
  }
}

Example response

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "100",
  "currency": "KES",
  "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"
}

On this page