Skip to main content
GET
/
api
/
v2
/
ramps
/
{id}
Get Ramp by id
curl --request GET \
  --url https://sandbox.killb.app/api/v2/ramps/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "active": true,
  "fromCurrency": "MXN",
  "toCurrency": "MXN",
  "fromAmount": 123,
  "toAmount": 123,
  "quotationId": "<string>",
  "userId": "<string>",
  "cashInMethod": "SPEI",
  "cashOutMethod": "SPEI",
  "accountId": "<string>",
  "status": "CREATED",
  "type": "ON",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "accounts": [
    {
      "id": "<string>",
      "amount": 123
    }
  ],
  "isPreFunded": true,
  "paymentInfo": [
    {
      "network": "<string>",
      "Bank": "<string>",
      "Beneficiary": "<string>",
      "CLABE": "<string>",
      "concepto": "<string>"
    }
  ],
  "details": "<string>",
  "transferProof": "<string>",
  "externalId": "<string>",
  "isFastPay": true,
  "documents": [
    {
      "documentType": "<string>",
      "filePath": "<string>",
      "uploadedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

Response

id
string
required
active
boolean
required
fromCurrency
enum<string>
required
Available options:
MXN,
COP,
USD,
USDC,
USDT
toCurrency
enum<string>
required
Available options:
MXN,
COP,
USDC,
USDT,
HKD,
EUR,
USD,
PEN
fromAmount
number
required
toAmount
number
required
quotationId
string
required
userId
string
required
cashInMethod
enum<string>
required
Available options:
SPEI,
POLYGON,
ERC20,
PSE,
PRE_FUND,
PRE_FUND_POLYGON,
PRE_FUND_ERC20,
PRE_FUND_SOLANA,
PRE_FUND_TRON,
PRE_FUND_ARBITRUM,
TRANSFIYA,
SOLANA,
BSC,
TRON
cashOutMethod
enum<string>
required
Available options:
SPEI,
POLYGON,
ERC20,
PSE,
TRANSFIYA,
SOLANA,
BSC,
TRON,
WIRE,
ACH,
CCI,
SWIFT
accountId
string
required
status
enum<string>
required
Available options:
CREATED,
CASH_IN_REQUEST,
CONVERSION_REQUEST,
CASH_OUT_REQUEST,
CASH_IN_REQUESTED,
CONVERSION_REQUESTED,
CASH_OUT_REQUESTED,
CASH_IN_PENDING,
CONVERSION_PENDING,
CASH_OUT_PENDING,
CASH_IN_PROCESSING,
CONVERSION_PROCESSING,
CASH_OUT_PROCESSING,
CASH_IN_COMPLETED,
CONVERSION_COMPLETED,
CASH_OUT_COMPLETED,
COMPLETED,
CANCELED,
FAILED,
REJECTED,
ERROR
type
enum<string>
required
Available options:
ON,
OFF
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
accounts
object[]
isPreFunded
boolean
paymentInfo
(MXN · object | COP · object | Crypto · object)[]
details
string

complement information about a transfer, like: Code error

transferProof
string

Proof of transfer, like: TxHash, url, etc.

externalId
string

External id to avoid duplicate ramps

isFastPay
boolean
documents
object[]