Creating a Payment

To create a payment, you’ll need to make a POST request to our simple payment endpoint with the required information. Here’s how to structure your request:

Flow Chart

You can check the Auth endpoint documentation here for full details on how to authorize and get a token.

Request Structure

1
{
2
  "type": "CHARGE",
3
  "payoutMethodType": "CARD",
4
  "dueDate": "2024-05-27T16:52:46.020Z",
5
  "description": "Order description",
6
  "reference": "Order reference",
7
  "orderCurrency": "ARS",
8
  "fixedOrderCurrency": "ARS",
9
  "collectionCurrency": "ARS",
10
  "payoutCurrency": "ARS",
11
  "destinationBankAccountId": "baa_7300e2e1-81bc-40f4-8ea8-fcb940e2e9ac",
12
  "products": [
13
    {
14
      "id": "prd_83afd72d-0701-46d1-bf8a-c549f48ce148",
15
      "name": "Product name",
16
      "quantity": 12.345,
17
      "price": {
18
        "id": "prc_83afd72d-0701-46d1-bf8a-c549f48ce1485",
19
        "value": 100.25,
20
        "name": "Price name",
21
        "externalId": "ext_83afd72d-0701-46d1-bf8a-c549f48ce148"
22
      },
23
      "unit": "Unit",
24
      "description": "Product description",
25
      "externalId": "ext_83afd72d-0701-46d1-bf8a-c549f48ce148",
26
      "image": "http://my-img.com/1"
27
    }
28
  ],
29
  "customer": [
30
    {
31
      "countrySymbol": "AR",
32
      "bankAccount": {
33
        "countrySymbol": "AR",
34
        "currencySymbol": "ARS",
35
        "name": "Bank account name",
36
        "entity": "Bank name",
37
        "type": "SAVINGS",
38
        "accountNumber": "012342134-123",
39
        "isDefault": true
40
      },
41
      "externalId": "ext_a627a569-51c4-4fc4-ace6-a43482f1b08b",
42
      "firstName": "John",
43
      "lastName": "Doe",
44
      "email": "john.doe@example.com",
45
      "phone": "0116644624",
46
      "addressLine1": "Street address",
47
      "addressLine2": "Additional address",
48
      "city": "City",
49
      "state": "State",
50
      "postalCode": "1419",
51
      "businessType": "PERSON",
52
      "taxIdType": "CUIT",
53
      "taxIdNumber": "123456789",
54
      "documentType": "DNI",
55
      "documentNumber": "123456789"
56
    }
57
  ],
58
  "payment": {
59
    "paymentProviderIds": [
60
      "ppi_2ba6a556-4afb-4798-9785-3aab4b9024da",
61
      "ppi_8940cd2e-bd17-4ef8-9012-9f78c7ea12f9"
62
    ],
63
    "paymentProviderMethods": [
64
      {
65
        "method": "PSE"
66
      }
67
    ],
68
    "successUrl": "https://your-domain.com/payment-success"
69
  },
70
  "amount": 100
71
}

Required Fields

Basic Information

• type: The type of order (“CHARGE” or “PAYMENT”)
• payoutMethodType: The method for either payout or payin (“CARD” or “TRANSFER”)
• dueDate: The expiration date and time for the payment
• description: Description of the order
• reference: Reference for the order
• amount: Total amount of the order

Currency Information

• orderCurrency: ISO code of the order’s currency (ARS, CLP, COP, MXN, USD, PEN, BRL)
• fixedOrderCurrency: ISO code of the currency in which the order is fixed
• collectionCurrency: ISO code of the currency for collection
• payoutCurrency: ISO code of the payment currency for the payout

Bank Account

• destinationBankAccountId: ID of the bank account where the collected amount will be deposited

Products

At least one product is required with the following information:

• id: Product identifier
• name: Product name
• quantity: Amount of products
• price: Price information including:
  • id: Price identifier
  • value: Price value
  • name: Price name
  • externalId: External reference ID
• unit: Unit of measurement
• description: Product description
• externalId: External reference ID
• image: Product image URL

Customer Information

Customer information is required with:

• Personal details (name, email, phone)
• Address information
• Document details (tax ID, document type/number)
• Bank account information

Payment Configuration

• paymentProviderIds: Array of payment provider IDs
• paymentProviderMethods: Array of payment methods
• successUrl: URL to redirect after successful payment

Available Payment Methods

// TODO: Add endpoint to get available payment methods per country

The following payment methods are supported:

• PSE (Pagos Seguros en Línea)
• BANCOLOMBIA_QR
• BANCOLOMBIA_TRANSFER
• PCOL
• BANCOLOMBIA_BNPL
• DAVIPLATA
• SU_PLUS
• NEQUI

Response

Upon successful creation, the endpoint will return a response with the payment details that can be used to process the payment through the selected payment provider.

Example Usage

1
const response = await fetch('https://api.userow.com/rest/api/v1/payment', {
2
  method: 'POST',
3
  headers: {
4
    'Content-Type': 'application/json',
5
    'Authorization': 'Bearer YOUR_API_KEY'
6
  },
7
  body: JSON.stringify({
8
    // Your payment payload here
9
  })
10
});
11
12
const paymentData = await response.json();

Error Handling

The API will return appropriate error responses with details about what went wrong. Common error scenarios include:

• Invalid payment provider IDs
• Missing required fields
• Invalid currency codes
• Invalid bank account information
• Invalid customer information

Make sure to handle these errors appropriately in your implementation.

You can also check the full endpoint documentation for simple payments