Payment Recovery

Recovery of unpaid payments.¶

HTTP Request¶

POST /v1/whatsapp/message/send/PAYMENT_RECOVERY

Payment Recovery Request¶

RequestResponseHttp Status Code 400 ResponseHttp Status Code 500 Response

Request Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer {{access_token}}",
  "x-api-key": "{{api_key}}"
}

Request Body

{
  "orderId": "123456",
  "phone": "11987654321",
  "countryCallingCode": "+55",
  "customerName": "Austin Bu",
  "headerImage": "https://static.wikia.nocookie.net/c__/images/6/6b/Quote.jpg/revision/latest?cb=20110107214657&path-prefix=cavestory",
  "currency": "BRL",
  "amountInCents": "10000",
  "createTime": "2023-10-16 10:30:30",
  "notificationUrl": "https://www.liquido.com"
}

Content-Type: application/json

{
  "msgId": "gBGGFRBQmGUvAglCIxywFV5mRRY"
}

Content-Type: application/json

{
  "errors":[
    {
      "code": "601",
      "errorMessage": 
      "This phone number does not have an associated whatsapp account."
    }
  ]
}

Content-Type: application/json

{
  "errors":[
    {
      "code": "500",
      "errorMessage": "Server internal error."
    }
  ]
}

Request Headers Parameters¶

Key	Value
Authorization	"Bearer" + " " + {{access_token}}
x-api-key	{{api_key}}

Request Body Parameters¶

Parameter	Type	Description
orderId	String	Order Id.
phone	String	Phone number without country code. "11987654321"
countryCallingCode	String	Country calling code. such as "+1" in USA.
customerName	String	Customer full name.
headerImage	String	Product image.
currency	String	Currency, such as "BRL".
amountInCents	Long	Amount, in cents.
createTime	String	Payment creation time.
notificationUrl	String	The url to notify merchant payment result.