Payment Intent API

The Payment Intent API allows users to purchase crypto using fiat currency (e.g., buy USDT by paying in EUR). Payments are made via bank transfer.

Once the payment is completed, the purchased crypto is sent to the wallet specified during order registration.

The API also supports KYC verification for new users if required.

Create a new Payment Intent

This method allow to register a new payment intent.

A Payment Intent records a user's intent to purchase a specified amount of crypto and pay for it using fiat. Either the crypto amount or the fiat amount is defined during the creation of the Payment Intent.

For example, if a user wants to buy €1000 worth of BTC, the system will automatically calculate the corresponding BTC amount. Similarly, if the user wants to purchase 0.01 BTC, the system will determine the required fiat amount to complete the purchase.

Therefore, it is not necessary to provide both values. If both the crypto and fiat amounts are sent via the API, the system will prioritize the fiat amount and recalculate the crypto amount accordingly.

The fiat or crypto amounts calculated by the system can be retrieved through the payment instructions API call. This allows users to review and confirm the final amounts before proceeding with the payment.

If the user is required to complete the KYC process before purchasing crypto, this API call will return a URL where they can complete the verification. Additionally, a callback URL can be specified so that, once the KYC process is successfully completed, the user is redirected back to continue the purchase process.

The API call will return three values:

1. A Payment Intent ID to reference in subsequent API calls.

2. A status:

   • 2 if the user needs to complete the KYC process.

   • 3 if everything is ready for payment.

3. A KYC URL (if required) where the user can complete the verification process.

To call the API, it is essential to include the x-api-key header.

Additionally, the storeId value, which is unique per client, must be specified for the API request to function correctly.

Both values are provided by AhoraCrypto.

POSThttps://api.ahoracrypto.com/payment/intent

Authorization

jwt

Header parameters

Body

application/json

phonePrefix*string

Country calling code (e.g., +1, +44)

phoneNumber*string

User phone number without country code

email*string

User email address

fiatCurrency*string

Fiat currency code (e.g., USD, EUR)

cryptoSymbol*string

Cryptocurrency symbol (e.g., USDT, BTC)

ipAddress*string

User IP address

country*string

ISO country code (2 characters, e.g., ES for Spain, US for United States, ...)

walletAddress*string

Cryptocurrency wallet address

network*string

Blockchain network for the transaction

storeId*string

Unique identifier assigned by the API provider. Contact support to get your store ID.

cryptoAmountnumber

Amount in cryptocurrency to be received. If not specified, the fiat amount will be used to calculate the crypto amount.

fiatAmountnumber

Amount in fiat currency to be paid. If not specified, the crypto amount will be used to calculate the necessary fiat amount to be paid.

callbackUrlstring

URL to redirect the user after KYC verification is done in case the user has to pass the KYC verification

firstNamestring

User first name

lastNamestring

User last name

documentTypenumber

Type of identification document

documentNumberstring

Identification document number

birthDatestring

User birth date in YYYY-MM-DD format

documentIssuedCountrystring

ISO country code of document issuance (2 characters, e.g., ES for Spain, US for United States, ...)

nationalitystring

ISO country code for nationality (2 characters, e.g., ES for Spain, US for United States, ...)

kycVideoUrlstring

URL of KYC verification video

documentFrontUrlstring

URL of identification document front image

documentBackUrlstring

URL of identification document back image

Response

200400401500

Create payment intent

Body

application/json

id*string

Payment intent identifier

status*integer

Payment intent status: 2 = KYC verification required, 3 = Ready for payment

kycUrlstring

URL for KYC verification process

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.ahoracrypto.com/payment/intent', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "phonePrefix": "text",
      "phoneNumber": "text",
      "email": "text",
      "fiatCurrency": "text",
      "cryptoSymbol": "text",
      "ipAddress": "text",
      "country": "text",
      "walletAddress": "text",
      "network": "text",
      "storeId": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "status": 0,
  "kycUrl": "text"
}

Get Payment Instructions

Once the Payment Intent has been registered and the payment is ready—either because the returned status was 3 (Ready for Payment) or the user has successfully completed the KYC process

To call the API, it is essential to include the x-api-key header.

We can retrieve the payment instructions by calling the following method:

GEThttps://api.ahoracrypto.com/payment/intent/{id}/instructions

Authorization

jwt

Path parameters

id*string

Response

200401403404500

Get payment instructions

Body

application/json

iban*string

International Bank Account Number

bic*string

Bank Identifier Code (SWIFT)

accountHolder*string

Name of the bank account holder

bankCountry*string

Country where the bank account is located (e.g. ES for Spain, US for United States, ...)

reference*string

Payment reference number the user has to indicate in the bank transfer

fiatAmountnumber (double)

Amount to be transferred

fiatCurrencystring

Fiat currency code (e.g. EUR, USD, ...)

cryptoAmountnumber (double)

Amount of crypto to be received

cryptoCurrencystring

Cryptocurrency symbol (e.g. USDT, BTC, ...)

walletAddressstring

Cryptocurrency wallet address to receive the crypto

networkstring

Blockchain network for the transaction

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.ahoracrypto.com/payment/intent/{id}/instructions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "iban": "text",
  "bic": "text",
  "accountHolder": "text",
  "bankCountry": "text",
  "reference": "text",
  "fiatAmount": 0,
  "fiatCurrency": "text",
  "cryptoAmount": 0,
  "cryptoCurrency": "text",
  "walletAddress": "text",
  "network": "text"
}