List Payouts | CrissCross

curl -G https://api.crisscross.money/v1/payout \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     --data-urlencode merchantIds=3fa85f64-5717-4562-b3fc-2c963f66afa6,7c9e6679-7425-40de-944b-e07fc1f90ae7

[
  {
    "transactionId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
    "currentState": "COMPLETED",
    "previousStates": [
      "PENDING",
      "PROCESSING"
    ],
    "transactionStates": [
      {
        "state": "PENDING",
        "timestamp": "2024-06-10T08:30:00Z",
        "notes": "Payout created"
      },
      {
        "state": "PROCESSING",
        "timestamp": "2024-06-11T12:00:00Z",
        "notes": "Payout sent to processor"
      },
      {
        "state": "COMPLETED",
        "timestamp": "2024-06-12T15:45:00Z",
        "notes": "Payout completed successfully"
      }
    ],
    "merchantReference": "Order-987654321",
    "processor": "Stripe",
    "merchantName": "Acme Corp",
    "amount": 1500.75,
    "currency": "USD",
    "paymentLocation": "USA",
    "paymentMethodId": "banktransfer",
    "transactionType": "PAYOUT",
    "processorReference": "ch_1J2Y3Z4a5b6c7d8e9f0g",
    "financialTransactionReference": "FTX-20240612-0001",
    "currentAttemptId": "attempt-20240612-01",
    "batchPayoutId": "batch-20240612-01",
    "identifiers": {
      "invoiceId": "INV-20240612-1234",
      "customerId": "CUST-7890"
    },
    "paymentAttributes": {
      "bankName": "First National Bank",
      "accountNumber": "****5678"
    }
  }
]

Lists payouts across one or more merchants. Returns the full state history of each payout.

Authentication

AuthorizationBearer

OAuth 2.0 access token issued by the CrissCross authorisation server.

Query parameters

merchantIdslist of stringsRequired

Comma-separated list of merchant IDs to list payouts for.

Response

Payouts retrieved successfully.

transactionIdstring

Unique payout identifier.

currentStatestring

Current state name.

previousStateslist of strings

Ordered list of prior state names.

transactionStateslist of maps from strings to any

Detailed history of state transitions.

merchantReferencestring

Your reference for the payout.

processorstring

Payout processor used.

merchantNamestring

Merchant display name.

amountdouble

Payout amount.

currencystring

3-character ISO currency code.

paymentLocationstring

3-letter ISO country code.

paymentMethodIdstring

Payment method identifier (e.g. banktransfer).

transactionTypestring

Transaction type (e.g. PAYOUT).

processorReferencestring

Processor-side reference.

financialTransactionReferencestring

Financial transaction reference returned by the processor.

currentAttemptIdstring

Identifier of the current delivery attempt.

batchPayoutIdstring

Batch identifier when part of a batch payout.

identifiersmap from strings to strings

paymentAttributesmap from strings to strings

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error