The reference number generated by Paycash single payment can be paid only once.
For cash payments at offline collection points in Colombia, the payer is required to provide two numbers to the cashier to finish payments. One is the generated reference number(referencia) and the other is the agreement code(convenio).
Reference number is included in the response which locates in ‘referenceNumber’ response field.
Agreement code may differ with different offline collection points, please check the details in Agreement Codes.
{"idempotencyKey":"co-20221001-0001","amount":50000,"currency":"COP","country":"CO","paymentMethod":"PAY_CASH","paymentFlow":"DIRECT","payer":{"name":"username","email":"username@liquido.com","billingAddress":{"zipCode":"03400","state":"CDMX","city":"Álamos","street":"Simón Bolívar","number":"12121"}},"orderInfo":{"orderId":"test-order-id","shippingInfo":{"name":"shipping test name","email":"thiago@example.com","address":{"street":"street name","number":"building number","complement":"unit, apt, etc.","district":"district, neighborhood, etc.","city":"city name","state":"state, state code","zipCode":"zip code, postal code","country":"CO"}}},"callbackUrl":"https://api.client.com/callback/","description":"this is a test pay","expirationDate":"2022-10-31","recurring":false,"subMerchantId":"UUID"}
Content-Type: application/json
{"transferStatusCode":200,"idempotencyKey":"co-20221001-0001","referenceId":"co-20221001-0001","paymentMethod":"PAY_CASH","amount":50000,"currency":"COP","finalAmount":50000,"finalCurrency":"COP","country":"CO","createTime":"2022-10-01 09:44:29 UTC","scheduledTime":"2022-10-01 09:44:33 UTC","payer":{"name":"username","email":"username@liquido.com","billingAddress":{"street":"Simón Bolívar","number":"12121","city":"Álamos","state":"CDMX","zipCode":"03400"}},"transferStatus":"IN_PROGRESS","description":"this is a test pay","callbackUrl":"https://api.client.com/callback/","transferDetails":{"payCash":{"referenceNumber":"2701665308673817","expirationDate":"2022-10-31","recurring":false}},"subMerchantId":"UUID"}
{"eventType":"CHARGE_SUCCEEDED","data":{"chargeDetails":{"transferStatusCode":200,"idempotencyKey":"co-20221001-0001","referenceId":"co-20221001-0001","paymentMethod":"PAY_CASH","amount":50000,"currency":"COP","finalAmount":50000,"finalCurrency":"COP","country":"CO","createTime":"2022-10-01 09:44:29 UTC","scheduledTime":"2022-10-01 09:44:33 UTC","payer":{"name":"username","email":"username@liquido.com","billingAddress":{"street":"Simón Bolívar","number":"12121","city":"Álamos","state":"CDMX","zipCode":"03400"}},"transferStatus":"SETTLED","description":"this is a test pay","callbackUrl":"https://api.client.com/callback/","transferDetails":{"payCash":{"referenceNumber":"2701665308673817","expirationDate":"2022-10-31","recurring":false,"paymentTime":"2022-10-06 00:21:20"}},"subMerchantId":"UUID"}}}
Transfer status code, 200 transaction SETTLED or IN_PROGRESS, other FAILED
transferErrorMsg
String
Transfer error message if failed
referenceId
String
Unique key to payment ticket, generated by Liquido.
idempotencyKey
String
Unique key to ensure idempotent requests. given by the merchant in their system
amount
Long
The transfer amount
country
String
country code
currency
String
The currency code of the transferred fund
finalAmount
Long
The final amount that is used for creating the charge order. EX: for charge orders with FX conversion, this field represents the converted amount from the original requested amount.
finalCurrency
String
The currency code of the finalAmount.
paymentMethod
String
payment method, enum value as BANK_TRANSFER, PAY_CASH
payer
JSON
payer info
transferDetails
JSON
transaction details info
description
String
description of payment
callbackUrl
String
URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
createTime
String
Payment ticket created time
scheduledTime
String
Payment ticket scheduled time
finalStatusTime
String
Transfer final status update time, final status include SETTLED, FAILED
fullname(Input specification: Only a combination of uppercase and lowercase letters, numbers and spaces is allowed. Spanish and Portuguese letters, and other special characters are not allowed).
email
String
email.
phone
String
Mobile phone number. Should include “+57” as a prefix.