Retrieve a Payment

HTTP Request¶

GET /v1/payments/charges/{{idempotencyKey}}

RequestResponse

Request Headers

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

Content-Type: application/json

{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "2022030214000008",
    "referenceId": "2022030214000008",
    "paymentMethod": "CARD",
    "amount": 300,
    "currency": "USD",
    "country": "EC",
    "finalAmount": 100,
    "finalCurrency": "USD",
    "createTime": "2022-03-01 21:16:42 GMT-08:00",
    "scheduledTime": "2022-03-01 21:16:42 GMT-08:00",
    "finalStatusTime": "2022-03-01 21:16:48 GMT-08:00",
    "payer": {
        "document":{
            "documentId":"1004922993",
            "type":"CI"
        },
        "name": "username",
        "email": "username@liquido.com",
        "phone": "+59381987654321",
        "billingAddress": {  
            "zipCode": "1001",
            "state": "Buenos Aires",
            "city": "Buenos Aires",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "5940",
            "complement": "casa",
            "country": "EC"
        }
    },
    "transferDetails": {
        "card": {
            "cardInfo": {
                "cardHolderName": "Captured",
                "expirationMonth": 1,
                "expirationYear": 2028,
                "brand": "MASTERCARD",
                "bin": "510510",
                "last4": "5100"
            }
        }
    }
    "transferStatus": "SETTLED",
    "description": "this is a test pay",
    "callbackUrl": "http://api.client.com/callback/",
    "subMerchantId": "UUID"
}

HTTP Headers Details¶

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

PATH and Query Parameters¶

Parameter	Type	Description
idempotencyKey	String	The idempotency key of the transaction

Response Body Details¶

Parameter	Type	Description
idempotencyKey	String	Unique key to ensure idempotent requests
amount	Long	The transfer amount
country	String	country code
currency	String	The currency 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.
createTime	String	The creation time of payin request
scheduledTime	String	Transfer ticket scheduled time
payer	JSON	payer info
transferDetails	JSON	transaction details info
finalStatusTime	String	The settled or failed time of payin transaction
transferStatus	String	Transfer status, SETTLED, IN_PROGRESS, FAILED, REFUNDING, REFUNDED, CANCELLED
transferStatusCode	Integer	Transfer status code, 200 transaction SETTLED, IN_PROGRESS, FAILED, REFUNDED, REFUNDING.
transferErrorMsg	String	Transfer error message if failed
subMerchantId	String	The sub merchant ID.

Payer Object Parameters¶

Parameter	Type	Description
name	String	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.
document	JSON	Wallet holder identity proof.
billingAddress	JSON	Billing address info.

document Object Parameters¶

Parameter	Type	Description
documentId	String	identity number
type	String	enum of CI

billingAddress Object Parameters¶

Parameter	Type	Description
zipCode	String	zip code
state	String	state.
city	String	city name.
district	String	district name.
street	String	street name.
number	String	street number.
complement	String	complement info.
country	String	country code.

transferDetails Object Parameters¶

Parameter	Type	Description
card	JSON	card detail info

card Object in transferDetails Parameters¶

Parameter	Type	Description
cardInfo	JSON	card detail info

CardInfo Object in response Parameters¶

Parameter	Type	Description
cardHolderName	String	Cardholder's full name.
bin	String	first 6 digit number of the card
last4	String	last 4 digit number of the card
brand	String	Credit card brand. such as VISA, MASTERCARD
expirationMonth	Integer	1 or 2 digit number(s) representing the card's expiration month.
expirationYear	Integer	4 digit numbers representing the card's expiration year.