Confirm a Batch

POST/batches/{batchId}/confirm

This endpoint will confirm the batch and send all Transfers to providers.

Path Parameters

batchIdstringrequired

Body application/json

payment_method"crypto_page" | "prefunding" | "crypto_address" | "payment_initiation" | "bank_transfer" | "card" | "customer_account"

The method to use to pay the transfer. If payment_method was specified when creating the transfer (quote time), the same value must be provided here — otherwise the request will be rejected with invalid.payment_method.

success_urlstring

Webpage to redirect the customer to on successful payment. We inject some information into the URL as URL parameters.

cancel_urlstring

Webpage to redirect the customer to on cancelled payment. We inject some information into the URL as URL parameters.

amount_to_paynumber

the amount to pay in the sending currency of the transfer

cryptocurrency"BTC" | "ETH" | "USDT" | "testBTC" | "USDT_TRC20" | "USDT_POLY" | "USDT_SOL" | "sats" | "USDC" | "USDC_POLY" | "USDC_ARB" | "USDC_SOL" | "PYUSD" | "PYUSD_SOL"

the cryptocurrency used to pay

card_idstring<uuid>

Response

The Batch has been confirmed by the Merchant.

idstring<uuid>

Batch Identifier

external_idstring

Batch Reference provided by API caller

status"created" | "processing" | "rejected" | "waiting_confirmation" | "confirmed" | "expired" | "partial_submitted" | "submitted" | "partial_completed" | "completed"

Batch Status

reasonobject[]
Show reason properties
csvLinenumber

CSV line number for the Batch error

messageobject[]

The error message

Show message properties
messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
paymentobject

Payment

Show payment properties
idstring<uuid>

Payment Identifier

statusstring

Payment status

reasonstring<uuid>

Failed/Declined Reason

urlstring

CDN of payment page

crypto_addressstring

Cryptocurrency token address

crypto_currencystring

Cryptocurrency value

crypto_networkstring

The blockchain to use to pay

expires_atstring<date-time>

The expiration of the address

card_issuer_countrystring

The issuer country of card if payment is made via card

reference_numberstring

Payment reference number

ibanstring

IBAN

total_transfersnumber

Total number of transfers in the batch

total_sending_amountobject[]
Show total_sending_amount properties
currencystring<iso-4217>

The currency

amountnumber<double>

The total amount for the currency

total_receiving_amountobject[]
Show total_receiving_amount properties
currencystring<iso-4217>

The currency

amountnumber<double>

The total amount for the currency

total_feesobject[]
Show total_fees properties
currencystring<iso-4217>

The currency

amountnumber<double>

The total amount for the currency

expires_atstring<date-time>

Creation Timestamp

created_atstring<date-time>

Creation Timestamp

updated_atstring<date-time>

Update Timestamp

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
Request
curl -X POST "https://api.uat.triple-a.io/api/fiat-payout/v1/batches/<batchId>/confirm" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
  "payment_method": "crypto_page",
  "success_url": "string",
  "cancel_url": "string",
  "amount_to_pay": 100,
  "cryptocurrency": "BTC",
  "card_id": "00000000-0000-0000-0000-000000000000"
}'
Response
{
  "id": "00000000-0000-0000-0000-000000000000",
  "external_id": "string",
  "status": "created",
  "reason": [
    {
      "csvLine": 0,
      "message": [
        {
          "message": "string",
          "errors": [
            {
              "errorCode": null,
              "message": null
            }
          ]
        }
      ]
    }
  ],
  "payment": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "string",
    "reason": "00000000-0000-0000-0000-000000000000",
    "url": "string",
    "crypto_address": "string",
    "crypto_currency": "string",
    "crypto_network": "string",
    "expires_at": "1970-01-01T00:00:00.000Z",
    "card_issuer_country": "USA",
    "reference_number": "MFB-870989-FPP",
    "iban": "FR7630006000011234567890189"
  },
  "total_transfers": 0,
  "total_sending_amount": [
    {
      "currency": "string",
      "amount": 0.001
    }
  ],
  "total_receiving_amount": [
    {
      "currency": "string",
      "amount": 0.001
    }
  ],
  "total_fees": [
    {
      "currency": "string",
      "amount": 0.001
    }
  ],
  "expires_at": "1970-01-01T00:00:00.000Z",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}