Redirect Payment
Redirect Payment
When sending a request over to Liquido, you should specify the paymentFlow as REDIRECT
HTTP Request
POST
/v1/payments/charges/card
Request Headers
{
"Content-Type": "application/json",
"Authorization": "Bearer {{access_token}}",
"x-api-key": "{{api_key}}"
}
create a credit card redirect payment
Request Body
{
"idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab9",
"amount": 100,
"currency": "COP",
"country": "CO",
"paymentMethod": "CREDIT_CARD",
"paymentFlow": "REDIRECT",
"payer": {
"name": "username",
"email": "username@liquido.com",
"document": {
"documentId": "42243309114",
"type": "CC"
},
"phone": "+57 3123456789",
"billingAddress": {
"zipCode": "111111",
"state": "Cundinamarca",
"city": "Bogotá",
"street": "Apartamento 502, Torre I",
"number": "Calle 34 # 56 - 78"
}
},
"orderInfo": {
"orderId": "test-order-id",
"shippingInfo": {
"name": "shipping test name",
"phone": "shipping phone",
"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"
}
}
},
"description": "this is a test pay",
"callbackUrl": "https://api.client.com/callback/",
"subMerchantId": "UUID",
"merchantRedirectInfo": {
"merchantPageUrl": "https://www.merchantpageexample.com/123456"
}
}
Content-Type: application/json
{
"transferStatusCode": 200,
"paymentFlow": "REDIRECT",
"idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab9",
"referenceId": "1ec983fa-1a37-679b-809b-067861d87ab9",
"paymentMethod": "CREDIT_CARD",
"amount": 100,
"currency": "COP",
"country": "CO",
"finalAmount": 100,
"finalCurrency": "COP",
"createTime": "2022-03-01 17:53:18 GMT-08:00",
"finalStatusTime": "2022-03-01 17:53:18 GMT-08:00",
"payer": {
"name": "username",
"email": "username@liquido.com",
"document": {
"documentId": "42243309114",
"type": "CC"
},
"phone": "+57 3123456789",
"billingAddress": {
"zipCode": "111111",
"state": "Cundinamarca",
"city": "Bogotá",
"street": "Apartamento 502, Torre I",
"number": "Calle 34 # 56 - 78"
}
},
"transferStatus": "IN_PROGRESS",
"description": "this is a test pay",
"callbackUrl": "https://api.client.com/callback/",
"redirectUrl": "https://www.redirect.liquido.com?uid=cb2d0f2b-c28d-4201-a7c8-8d87be57bdf5",
"subMerchantId": "UUID",
"merchantRedirectInfo": {
"merchantPageUrl": "https://www.merchantpageexample.com/123456"
}
}
Request Headers Parameters
Key | Value |
---|---|
Authorization | "bearer" + " " + {{access_token}} |
x-api-key | {{api_key}} |
Request Body Parameters
Parameter | Required | Type | Description |
---|---|---|---|
idempotencyKey | String | Unique key to ensure idempotent requests. given by the merchant in their system. | |
amount | Long | The transfer amount, The minimum settlement granularity of the current currency, such as 100=1BRL | |
country | String | country code | |
currency | String | The currency code of the transferred fund | |
paymentMethod | String | payment method, enum value as CREDIT_CARD | |
paymentFlow | String | payment flow, enum value as REDIRECT | |
payer | JSON | payer info | |
capture | Boolean | set to false to create an authorization | |
installments | Integer | number of installments | |
orderInfo | JSON | order 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. | |
subMerchantId | String | The sub merchant ID. Required for PSPs. | |
merchantRedirectInfo | JSON | The merchant redirect info. | |
riskData | JSON | The risk data of the payment. MERCHANT_APP_NAME or MERCHANT_WEBSITE must be provided in risk Data. Please see here for further details. |
Create A Credit Card Payment With Risk Data
Please see here for further details.
Response Body Parameters
Parameter | Type | Description |
---|---|---|
transferStatus | String | Transfer status, SETTLED, IN_PROGRESS, AUTHORIZED, FAILED |
transferStatusCode | Integer | Transfer status code, 200 transaction SETTLED, IN_PROGRESS or AUTHORIZED, other 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 CREDIT_CARD |
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. |
createdTime | String | Payment ticket created time |
finalStatusTime | String | Transfer final status update time, final status include SETTLED, FAILED |
paymentFlow | String | REDIRECT |
redirectUrl | String | The URL where you must redirect your customer to complete the payment. |
subMerchantId | String | The sub merchant ID. |
merchantRedirectInfo | JSON | The merchant redirect info. |
merchantRedirectInfo Object Parameters
Parameter | Required | Type | Description |
---|---|---|---|
merchantPageUrl | String | It is a URL that redirects to merchant page. It should be include when you need Liquido to redirect your customers back to your page after customers finish payments. This URL can only be set when ‘paymentFlow’ is ‘REDIRECT’ in the payment request. |