Creating a payment request

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:

Create Payment Request

POST/payment_requests

Authorization

OAuth2PasswordBearerExtended

Body

application/json

ars_amountArs Amount

numbernull

amountAmount

numbernull

currencyany of

Fiatnull

itemsItems

array of CreateItemModelnull

card_paymentCard Payment

booleannull

reference*Reference

memoMemo

stringnull

coinsCoins

array of NewTransactionModelnull

notification_urlNotification Url

stringnull

merchant_idMerchant Id

anynull

Response

201422

Successful Response

Body

application/json

id*Id

order_id*Order Id

ars_amount*Ars Amount

ars_paid*Ars Paid

amount*Amount

amount_paid*Amount Paid

currency*Fiat

ARSUSD

itemsItems

array of ItemModelnull

usd_amount*Usd Amount

reference*Reference

memoMemo

stringnull

notification_urlNotification Url

stringnull

status*PaymentRequestStatus

pendingapprovedcanceledexpiredrefunded

status_detail*TransactionStatus

not_paidcorrectunderpaidoverpaid

expiration_time*Expiration Time

delivered*Delivered

transactions*Transactions

card_paymentany of

CardPaymentModelnull

payments*Payments

merchant_id*Merchant Id

date_created*Date Created

last_modified*Last Modified

checkout_url*Checkout Url

conflict*Conflict

Request

JavaScriptCurlPython

const response = await fetch('/payment_requests', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201422

{
  "id": "text",
  "order_id": 0,
  "ars_amount": 0,
  "ars_paid": 0,
  "amount": 0,
  "amount_paid": 0,
  "currency": "ARS",
  "items": [
    {
      "id": "text",
      "quantity": 0,
      "name": "text",
      "price": 0,
      "currency": "ARS"
    }
  ],
  "usd_amount": 0,
  "memo": "text",
  "notification_url": "text",
  "status": "pending",
  "status_detail": "not_paid",
  "expiration_time": "2024-12-26T23:07:06.028Z",
  "delivered": false,
  "transactions": [
    {
      "id": "text",
      "price_details": {
        "currency": "ARS",
        "currency_amount": 0,
        "currency_final_amount": 0,
        "base_amount": 0,
        "final_amount": 0,
        "paid_amount": 0,
        "discount_rate": 0,
        "rate": 0
      },
      "coin": "BCH",
      "chain_id": 0,
      "address": "text",
      "status": "not_paid",
      "payment_request_id": "text",
      "memo": "text",
      "payments": [
        {
          "hash": "text",
          "block": 0,
          "amount": 0,
          "paid_by": "text",
          "paid_at": "2024-12-26T23:07:06.028Z",
          "linked_at": "2024-12-26T23:07:06.028Z"
        }
      ],
      "date_created": "2024-12-26T23:07:06.028Z",
      "last_modified": "2024-12-26T23:07:06.028Z"
    }
  ],
  "card_payment": {
    "provider": "stripe",
    "session_url": "text",
    "price_details": {
      "currency": "ARS",
      "amount": 0,
      "final_amount": 0,
      "usd_final_amount": 0,
      "paid_amount": 0,
      "discount_rate": 0,
      "rate": 0
    },
    "status": "not_paid",
    "date_created": "2024-12-26T23:07:06.028Z",
    "last_modified": "2024-12-26T23:07:06.028Z"
  },
  "payments": [
    {
      "hash": "text",
      "block": 0,
      "amount": 0,
      "paid_by": "text",
      "paid_at": "2024-12-26T23:07:06.028Z",
      "linked_at": "2024-12-26T23:07:06.028Z",
      "coin": "BCH"
    }
  ],
  "merchant_id": "text",
  "date_created": "2024-12-26T23:07:06.028Z",
  "last_modified": "2024-12-26T23:07:06.028Z",
  "checkout_url": "text",
  "conflict": false
}

• 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.

Create Payment Request With Qr

POST/payment_requests/qr

Authorization

OAuth2PasswordBearerExtended

Body

application/json

ars_amountArs Amount

numbernull

amountAmount

numbernull

currencyany of

Fiatnull

itemsItems

array of CreateItemModelnull

card_paymentCard Payment

booleannull

reference*Reference

memoMemo

stringnull

coinsCoins

array of NewTransactionModelnull

notification_urlNotification Url

stringnull

merchant_idMerchant Id

anynull

Response

201422

Successful Response

Request

JavaScriptCurlPython

const response = await fetch('/payment_requests/qr', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}