List Batches

GET/batches

This endpoint allows API users to retrieve a list of batches they made.

Query Parameters

pageinteger

Specify the page number

per_pageinteger

Specify the number of items per page

batch_idstring

Specify batch id

statusarray

Specify one or more status, comma separated

Response

OK

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

Request
curl -X GET "https://api.uat.triple-a.io/api/fiat-payout/v1/batches?page=<page>&per_page=<per_page>&batch_id=<batch_id>&status=<status>" \
  -H "Authorization: Bearer <token>"
Response
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "external_id": "string",
    "status": "created",
    "reason": [
      {
        "csvLine": 0,
        "message": [
          {
            "message": "string",
            "errors": [
              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"
  }
]