Docs
English
English
  • SimpleFi
    • On-site payments
    • Online payments
    • Available tokens
  • Merchant management
    • Authentication
    • Merchant settings
    • Payment requests
    • Status notifications
    • Static QR
  • API Reference
    • Authentication
    • Errors
    • Creating a payment request
    • Querying the status of a payment
    • Canceling a payment request
    • Refunding a payment
    • Notification Webhook
    • Linking Business to Network
  • Implementation details by method
    • Checkout Redirect
    • Dynamic QR
Powered by GitBook
On this page
  1. API Reference

Creating a payment request

PreviousErrorsNextQuerying the status of a payment

Last updated 7 months ago

Payment requests are created based on an amount in pesos and contain information about the exchange rate of the order in each available currency for making the payment. To initiate a payment, it is necessary to first create the payment request.

The route for creating them receives an amount in pesos and the accepted currencies, and the backend calculates the exchange rate for each currency and stores it in the database. The SimpleFi system listens to the blockchains of all accepted currencies and updates payment requests when the corresponding payments are found.

To create a payment request:

  • The 'reference' field can be used freely to create a reference for this payment request.

  • The 'coins' attribute contains an array in the format [{'ticker': 'USDC', 'chain_id': 10}, {...}], where the ticker of each currency you want to offer as an option must be specified. All indicated currencies that do not have a configured address in the Business will be ignored. The API will respond with quotes for all tokens that have a configured address in the business.

  • The 'notification_url' field is optional. It allows you to specify a different URL than the one configured in the business to receive notifications associated with this transaction.

Obtaining the dynamic QR

It is possible to obtain a QR code linked to a specific payment request. This QR code redirects to the checkout, linking the payment with the order created in the SimpleFi system or the payment network system.

  • POSTCreate Payment Request
  • Obtaining the dynamic QR
  • POSTCreate Payment Request With Qr

Create Payment Request

post
Authorizations
Body
ars_amountany ofOptional
numberOptional
or
nullOptional
amountany ofOptional
numberOptional
or
nullOptional
currencyany ofOptional
string · enumOptionalPossible values:
or
nullOptional
itemsany ofOptional
or
nullOptional
card_paymentany ofOptionalDefault: false
booleanOptional
or
nullOptional
referenceobject · ReferenceRequired
memoany ofOptional
stringOptional
or
nullOptional
coinsany ofOptional
or
nullOptional
notification_urlany ofOptional
stringOptional
or
nullOptional
merchant_idany ofOptional
anyOptional
or
nullOptional
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /payment_requests HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "ars_amount": 1,
  "amount": 1,
  "currency": "ARS",
  "items": [
    {
      "id": null,
      "quantity": 1
    }
  ],
  "card_payment": false,
  "reference": {},
  "memo": "text",
  "coins": [
    {
      "ticker": "BTC",
      "chain_id": 1
    }
  ],
  "notification_url": "text",
  "merchant_id": null
}
{
  "id": "text",
  "order_id": 1,
  "ars_amount": 1,
  "ars_paid": 1,
  "amount": 1,
  "amount_paid": 1,
  "currency": "ARS",
  "items": [
    {
      "id": "text",
      "quantity": 1,
      "name": "text",
      "price": 1,
      "currency": "ARS"
    }
  ],
  "usd_amount": 1,
  "reference": {},
  "memo": "text",
  "notification_url": "text",
  "status": "pending",
  "status_detail": "not_paid",
  "approved_at": "2025-06-17T06:21:52.175Z",
  "expiration_time": "2025-06-17T06:21:52.175Z",
  "delivered": true,
  "transactions": [
    {
      "id": "text",
      "price_details": {
        "currency": "ARS",
        "currency_amount": 1,
        "currency_final_amount": 1,
        "base_amount": 1,
        "final_amount": 1,
        "paid_amount": 1,
        "discount_rate": 1,
        "rate": 1
      },
      "coin": "BTC",
      "chain_id": 1,
      "address": "text",
      "status": "not_paid",
      "payment_request_id": "text",
      "memo": "text",
      "additional_info": {},
      "payments": [
        {
          "hash": "text",
          "from": "text",
          "chain_id": 1,
          "block": 1,
          "amount": 1,
          "paid_by": "text",
          "paid_at": "2025-06-17T06:21:52.175Z",
          "linked_at": "2025-06-17T06:21:52.175Z"
        }
      ],
      "date_created": "2025-06-17T06:21:52.175Z",
      "last_modified": "2025-06-17T06:21:52.175Z"
    }
  ],
  "card_payment": {
    "provider": "stripe",
    "session_url": "text",
    "price_details": {
      "currency": "ARS",
      "amount": 1,
      "final_amount": 1,
      "usd_final_amount": 1,
      "paid_amount": 1,
      "discount_rate": 1,
      "rate": 1
    },
    "status": "not_paid",
    "date_created": "2025-06-17T06:21:52.175Z",
    "last_modified": "2025-06-17T06:21:52.175Z"
  },
  "payments": [
    {
      "hash": "text",
      "from": "text",
      "chain_id": 1,
      "block": 1,
      "amount": 1,
      "paid_by": "text",
      "paid_at": "2025-06-17T06:21:52.175Z",
      "linked_at": "2025-06-17T06:21:52.175Z",
      "coin": "BTC"
    }
  ],
  "merchant_id": "text",
  "date_created": "2025-06-17T06:21:52.175Z",
  "last_modified": "2025-06-17T06:21:52.175Z",
  "checkout_url": "text",
  "conflict": true
}

Create Payment Request With Qr

post
Authorizations
Body
ars_amountany ofOptional
numberOptional
or
nullOptional
amountany ofOptional
numberOptional
or
nullOptional
currencyany ofOptional
string · enumOptionalPossible values:
or
nullOptional
itemsany ofOptional
or
nullOptional
card_paymentany ofOptionalDefault: false
booleanOptional
or
nullOptional
referenceobject · ReferenceRequired
memoany ofOptional
stringOptional
or
nullOptional
coinsany ofOptional
or
nullOptional
notification_urlany ofOptional
stringOptional
or
nullOptional
merchant_idany ofOptional
anyOptional
or
nullOptional
Responses
201
Successful Response
422
Validation Error
application/json
post
POST /payment_requests/qr HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "ars_amount": 1,
  "amount": 1,
  "currency": "ARS",
  "items": [
    {
      "id": null,
      "quantity": 1
    }
  ],
  "card_payment": false,
  "reference": {},
  "memo": "text",
  "coins": [
    {
      "ticker": "BTC",
      "chain_id": 1
    }
  ],
  "notification_url": "text",
  "merchant_id": null
}

No content