Create a Batch

POST/batches

This endpoint allows merchants to prepare (create) a batch on behalf of a sender (merchant’s clients) to transfer local currency funds to a recipient.

Body multipart/form-data

external_idstring

Transfer Reference provided by API caller

filestring<binary>required

The actual file to be uploaded

sending_currencystring<iso-4217-ext>required

Sending Currency which is defined by /currencies.

Response

Created

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

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" \
  -H "Content-Type: multipart/form-data" \
  -H "Authorization: Bearer <token>" \
  -d '{
  "external_id": "string",
  "file": "batch.csv",
  "sending_currency": "BTC"
}'
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"
}