Skip to main content

Payin Object

A Payin represents a fiat-to-stablecoin collection from an end-user.

ENDPOINTS
POST/v1/payinsGET/v1/payinsGET/v1/payins/{id}PATCH/v1/payins/{id}/cancel
THE PAYIN OBJECT
{
  "id": "ffb50d6c-09f1-4f08-9b91-cbce466bed52",
  "created_at": "2024-08-15T18:35:29.613Z",
  "updated_at": "2024-08-15T18:35:29.613Z",
  "finished_at": null,
  "customer_id": "2af83836-43ea-407b-ab4e-9c64ee817b28",
  "action": {
    "type": "REDIRECT",
    "redirect_url": "https://api.minteo.finance/v1/payins/redirect/ffb50d6c-09f1-4f08-9b91-cbce466bed52"
  },
  "status": "PENDING",
  "status_code": "PAYIN_CREATED",
  "destination_wallet_id": "2af83836-43ea-407b-ab4e-9c64ee817b28",
  "amount": "127000",
  "token": "COPM",
  "purpose": "Top-up on behalf of John Doe",
  "final_url": "https://yoursite.com/payin-completed",
  "payment": {
    "method": "PSE",
    "bank": "BANCO_FALABELLA"
  },
  "third_party": {
    "full_name": "John Doe",
    "legal_identifier_type": "CC",
    "legal_identifier": "1099075610",
    "country_iso": "CO",
    "email": "john@example.com",
    "phone_number": "3001234567"
  },
  "public_data": {
    "destination_wallet": {
      "chain": "POLYGON",
      "address": "0x1234567891234567890123456789012345678901"
    }
  },
  "activities": [
    {
      "type": "PAYIN_CREATED",
      "status": "SUCCEEDED",
      "last_update_at": "2024-08-15T18:35:29.613Z"
    }
  ]
}

Attributes​

iduuid

The Payin's ID.

tokenstring

Stablecoin token for this Payin.

purposestring

Purpose of the Payin.

amountstring

Amount to be collected from the end-user, to be tokenized.

Minimum amount for COPM: 10,000 COP.

final_urlstring

URL to redirect the end-user to, after the Payin's payment is completed. ID of the Payin will be appended as a query parameter to this URL.

statusstring

Current status of the Payin: PENDING, ABORTED, IN_PROGRESS, or FULFILLED.

actionobject

Action to be taken by the end-user right after the Payin is created.

paymentobject

Payment details for the Payin.

third_partyobject

Third Party (end-user) details for the Payin.

destination_wallet_iduuid

The ID of the Customer's wallet to send the stablecoin tokens to.

customer_iduuid

The ID of the Customer who created the Payin.

finished_atstringnullable

Date when the Payin was finished.

created_atstring

Creation date of this Payin.

updated_atstring

Last update date of this Payin.

activitiesarray

Activities related to the Payin. Each has type (Status Code), status (PENDING, SUCCEEDED, FAILED), and last_update_at.

public_dataJSONnullable

Public data associated with the payin.

status_codestringnullable

Status code of this payin regarding the status. See Status Codes below.

Status Codes​

PAYIN_CREATED
Payin created; waiting for the third party to complete the payment.
AWAIT_THIRD_PARTY_KYC
Waiting for the third party to complete the KYC.
AWAIT_INIT_PAYIN
Waiting for the payment gateway to initialize the payment.
AWAIT_GATEWAY_CONFIRM_PAYIN
Waiting for the payment gateway to confirm the payment.
GATEWAY_CONFIRM_PAYIN
Payment confirmed by the gateway.
AWAIT_BANK_CONFIRM_PAYIN
Waiting for the bank to confirm the payment.
AWAIT_TOKENIZATION
Waiting for the tokens to be tokenized.
AWAIT_TRANSFER_TOKENS
Waiting for the tokens to be transferred to the customer's wallet.
CANCELED
Payin canceled.
PAYMENT_FAILED
Payment failed. The payment gateway or the bank did not confirm the payment.
KYC_REJECTED
KYC rejected by the third party.
EXPIRED
Payin expired due to time window or inactivity.

Status Lifecycle​