Introduction

Sections

Theme switcher

Execute bank ramp on

Header Parameters

x-api-keystring Required

API key used to authenticate and authorize requests to the CryptoMate API

Body Parameters

wallet_idstring Required

Virtual wallet identifier

amountnumber Required

The amount of fiat currency to deposit

source_currencystring Required

The fiat currency to deposit. Supported currencies: "usd", "eur", "mxn", "brl"

Enum values:
usdeurmxnbrl

Response

201
Object
Ramp on request created and awaiting for fiat currency to be transfered.

Response Attributes

idstring

Unique identifier for the ramp on transaction

statestring

Current state of the operation

amountnumber

The amount of fiat currency to be deposited

currencystring

The fiat currency denomination

payment_railstring

Payment rail method. Possible values: PIX | WIRE | ACH | SEPA | SPEI

deposit_messagestring

Reference message to include with the bank deposit

bank_numberstring

Bank account number for the deposit

bank_codestring

Bank routing or SWIFT code

bank_namestring

Name of the receiving bank

bank_addressstring

Physical address of the bank

bank_beneficiary_namestring

Name of the account beneficiary

bank_beneficiary_addressstring

Address of the beneficiary

br_codestring

Brazilian PIX code (for BRL transactions)

qr_codestring

QR code data for payment (when applicable)

400
Object
Source currency error

Response Attributes

errorstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot