| Parameter | Type | Required | Description |
|---|---|---|---|
customer.id | string | yes | Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer |
customer.name | string | yes | The full name of the customer making the payment. It should match the name on the customer's identification documents |
customer.email | string | no | The email address of the customer. This will be used for sending payment confirmations and notifications |
customer.phone | string(E.164) | no | The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used. https://www.twilio.com/docs/glossary/what-e164 |
customer.birthdate | string | no | The birthdate of the customer, provided in the format mm-dd-yyyy. This parameter may be required depending on the country regulations or the payment method |
customer.document.number | stringFormat: 99999999999 / 9999999999999 | yes | The official identification number of the customer. This is typically a national ID, or other government-issued document |
customer.document.type | string | yes | The type of document provided by the customer. Common types include national ID, or driver's license. List of documents allowed. |
customer.address.addres_1 | string | yes | The primary street address of the customer |
customer.address.addres_2 | string | yes | Additional address information, such as apartment number or suite |
customer.address.city | string | yes | The city in which the customer resides |
customer.address.country_code | string | yes | The ISO 3166-1 alpha-3 country code for the customer's address. List of country codes. |
customer.address.neightborhood | string | yes | The neighborhood or district of the customer's address |
customer.address.number | string | yes | The street number of the address |
customer.address.postal_code | string | yes | The postal or ZIP code for the customer's address |
customer.address.state | string | yes | The state or region of the customer's address |
transaction.id | string | yes | A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process |
transaction.currency | string | yes | The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., COP). List of currency codes Default: COP |
transaction.amount | decimal(10,2) | yes | The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)Eg: 300.10 |
transaction.expire | integer (11) | no | The time in seconds until the transaction expires and is no longer valid |
transaction.redirect_url | url | no | The URL to which the customer will be redirected after completing the payment. This parameter is optional and typically used for providing a success or failure page |
branch | stringmin: 1 | max: 255 | no | The specific branch or location identifier where the transaction is being processed, if applicable |
country | string | yes | The country code where the transaction is taking place. The format is ISO 3166-1 alpha-3 (e.g., COL). List of country codes. |
payment_method | array ["pse"] min:1 | max: 1 | yes | The method of payment being used for the transaction, such as bank transfer, credit card... |
notification_url | string | yes | The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format |
| Parameter | Description |
|---|---|
transaction_id | A unique identifier for the response generated by the payment system, used to track the transaction. Can be used to verify the payment status in the GET /transaction/{id} endpoint |
expires_in | The time in seconds until the transaction expires and is no longer valid |
url | The URL provided to the customer for completing the payment. |
.png)
