Skip to content

Retrieve a Payment

HTTP Request

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

Request Headers
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "2022030214000008",
    "referenceId": "2022030214000008",
    "paymentMethod": "CREDIT_CARD",
    "amount": 300,
    "currency": "MXN",
    "country": "MX",
    "finalAmount": 100,
    "finalCurrency": "MXN",
    "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": {
        "name": "username",
        "email": "",
        "document" : "1222112121",
        "phone": "+52 1234567890",
        "billingAddress": {  
            "zipCode": "03400",
            "state": "CDMX",
            "city": "Álamos",
            "street": "Simón Bolívar",
            "number": "12121"
    "transferDetails": {
        "card": {
            "cardInfo": {
                "cardHolderName": "card_holder_name",
                "expirationMonth": 06,
                "expirationYear": 2029,
                "bin": "424242",
                "last4": "4242",
                "brand": "VISA"
            "cardToken": {
                "token": "card_8736453a-dad0-4f26-85f0-95e8787d0237",
                "type": "CARD"
            "paymentTime": "2022-09-06 00:21:20"
    "transferStatus": "SETTLED",
    "description": "this is a test pay",
    "callbackUrl": "",
    "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
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.

Object Parameters

Parameter Required 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.
document String CURP
phone String Mobile phone number. Should include “+52” as a prefix.
billingAddress JSON Billing address info.
Parameter Required Type Description
zipCode String zip code.
state String state.
city String city name.
street String street name.
number String street number.
Parameter Type Description
card JSON card detail info
payCash JSON payCash detail info
Parameter Type Description
cardInfo JSON card detail info
cardToken JSON card token info, can use it to create a card payment instead of card info
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.
Parameter Type Description
token String token value.
type String token type enum, such as CARD
Parameter Type Description
referenceNumber String The payer uses this number to pay for the transaction
expirationDate String Expire date in Mexico time,format "yyyy-MM-dd"
recurring Boolean Multiple times to pay or single
paymentTime String Actual payment time in Mexico time, format "yyyy-MM-dd HH:mm:ss"
Back to top