Follow the standard PaymentsOS integration procedure, and then apply the relevant extra specifications described below.
- API Version
- Payment Methods
- Setup Procedures
- Integration Procedures
- Errors in a Redirection Flow
Minimum required API version: 1.0.0
The following table lists all supported payment methods.
|Payment Method||Payment Method Type||Notes|
|BANK REFERENCED||Cash||Payment offices: Davivienda, Banco de Bogotá, Bancolombia.|
|OTHERS CASH||Cash||Local name: Matrix (Su Red). Payment offices: PagaTodo, Gana Gana, Gana, Acertemos, Apuestas Cúcuta 75, Su Chance, La Perla, Apuestas Unidas, JER.|
|PSE Bank Transfers||Bank Transfer|
The following table provides an overview of all supported and non-supported features.
The PaymentsOS test environment does not support the requests listed (this is a limitation of the PayU Latam sandbox environment).
The following table lists all supported requests. Use the bodybuilder to create a sample request body for each request type.
|Charge||Not Applicable||Asynchronous or Synchronous||The request can be synchronous or asynchronous, depending on your setup.|
|Refund||Partial is supported||Asynchronous||Partial refunds require that you send unique partial refund requests.|
Partial Refund Limitations
While partial refunds are supported, the following limitations apply:
You can send any amount for the partial refund as long as the value doesn’t exceed the initial or actual amount.
You can send as many as partial refund request as you require. The sum of the partial refund amounts cannot not exceed the total value of the transaction.
A partial refund request will always get a status of
pendingin the response. Partial refunds are processed manually by a PayU representative. The refund may take 2 to 6 calendar days to be processed. Once done, depending on the acquirer, the amount will appear in the extract in the next 1 to 30 days after the partial refund is processed.
If a partial refund is pending or is being processed, you cannot send a new request until the last one is processed.
Creating a Provider Configuration
When creating a new provider configuration in the PaymentsOS Control Center, select PayU Latam as the provider.
The following table lists the setup procedures that are specific to this provider.
|In the PaymentsOS Control Center, configure the following credentials: ||Required|
|In the PaymentsOS Control Center, register webhooks to be notified when a transaction changes its status.|
|In your PayU Colombia account, enable the validate unique. This will validate that each payment reference sent to the PayU Latam system is unique.||Required|
|In your PayU Colombia account, enable asynchronous refunds (refunds will initially have a status of pending)||Required|
|In your PayU Colombia account, enable refund notifications. Make sure to include the transaction_type field in the notification (this step is required for PaymentsOS to remain in sync with the refund status).||Required|
|In your PayU Colombia account, enable the 'Process without a cvv2 security code' feature if you intend to use it.||Optional|
|Contact PayU Latam Support to get a list of the minimum payment amounts required by the payment methods that you intend to use. |
To avoid unnecessary request failures, we recommend that you include some 'minimum value' validation for the transaction
The following sections list the integration procedures that are specific to this provider.
Handling the Charge Request Response for Cash Transactions
If the charge request is successful, then the provider will return a charge response containing:
- The expiration date of the Payment Receipt.
provider_data.documentobject with href links to the Payment Receipt in HTML format and possibly the Payment Receipt in PDF format.
Note that the
provider_data.additional_information field may contain a barcode, for receipt tracking purposes.
Now direct your customer to one, or both of the transaction payment receipts, so that they can print the receipt. Your customer should then take the payment receipt to the relevant Payment Office and pay for their purchase, before the expiration date.
When the provider notifies us that your customer has paid, we will update the transaction status. If no payment notification is received by the expiration date then the transaction will be considered as failed.
Permission to use the PSE Payment Method
PSE certification is required, before being allowed to use the PSE payment method. To receive certification, you'll need to conform to the specifications setup by the ACH organization, which is responsible for the PSE payment method.
Creating a PSE Bank Transfer Capture Page
The PSE Bank Transfer Capture page is used by your customer, to capture their PSE Bank Transfer details. Create this page on your site according to the specifications described in the PayU PSE (Colombia) Certification Guide (Download as PDF or Download as HTML).
Redirecting your Customer to Capture the PSE Bank Transfer
When you send a post charge request, we will return a charge resource containing a
charge.redirection.url, and a status of
Redirect your customer to this URL (the PSE Bank Transfer Capture page on your site), so that they can capture the bank transfer.
For detail of how to create the PSE Bank Transfer Capture page on your site, and how your customer should capture a PSE bank transfer, see the Permission to use the PSE Payment Method section above.
Once the PSE bank transfer has been captured, we'll redirect your customer's browser back to your site, using the merchant_site_url (that you provided in the post charge request). We've included the following URL parameters in the
merchant_site_url, to provide you with the context of the page that you'll need to load:
status (of the charge).
Example - Charge request Pending:
<merchant_site_url> ?payment_id=dd1fbe34-4636-4a61-8cb1-27ac8a175284 &charge_id=aec1c306-e0f7-452b-8fb5-5b34489e9d10 &status=Pending
The status of your Charge request may still be 'pending' when we redirect your customer back to your site (while the provider is processing the request).
Example - Charge request failed:
<merchant_site_url> ?payment_id=dd1fbe34-4636-4a61-8cb1-27ac8a175284 &charge_id=aec1c306-e0f7-452b-8fb5-5b34489e9d10 &error=provider_error
Errors in a Redirection Flow
In a redirection flow, customers finalize a transaction on a third-party site and are then directed back to your web page (the
merchant_site_url) where you inform them of the status of their payment. Of course, there’s always a chance of an unexpected error (such as a provider communication timeout) in this process. If an error does occur, we’ll let you know about it by appending the type of error (
provider_error) to the
merchant_site_url. If available, we will also include the ID of the original payment request and related transaction request (action).
Here’s an example.
Follow the steps in the PayU integration testing page.
To test requests in the PayU Latam sandbox environment, make sure your account has been configured to operate in test mode. You can then simulate specific response statuses for each request type, as listed below.
To simulate a status of
Approved, pass in
"holder_name": "APPROVED"in the Create Token request.
To simulate a status of
Pending, pass in
"holder_name": "PENDING_TRANSACTION_REVIEW"in the Create Token request.
To simulate a status of
Failed, pass in
"holder_name": "REJECTED"in the Create Token request.
Test Procedures for Bank Transfers
Use the following test values in the
post charge request:
"bank_transfer_financial_institution_code": "1022", "bank_transfer_financial_institution_name": "BANCO UNION COLOMBIANO", "user_type": "N", "national_identify_number_type": "CC",
Follow a step by step procedure to test PSE bank transfers in the PayU Sandbox environment. For details see the PSE Test Guide (PDF).
You can use the following cards for testing:
|AMEX Credit Card||377813000000001|
|DINERS Credit Card||36032400000007|
|CODENSA Credit Card||5907121111111115|
|CRM Credit Card||6271800000000002|
|MASTER Credit Card||5471300000000003|
|MASTER Credit Card2||2221000000000009|
|VISA Credit Card||4097440000000004|
|VISA Debit Card||4509420000000008|