Payouts

Get payout details

Retrieve detailed information about a specific payout transaction including FX breakdown

get/payments/v2/payouts/{id}

Request

Base URL
https://api-sandbox.payretailers.com
URL
https://api-sandbox.payretailers.com/payments/v2/payouts/{id}
Auth
- HTTP basic
- or API key in header X-API-Key

Path parameters

idstring uuid required

Unique payout identifier

Response

Payout details retrieved successfully

idstring uuid

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED'

amountnumber double

currencystring

payoutQuoteIdstring uuid

Associated quote ID if quote was used

Example response

{
  "payoutQuoteId": "3a9e2f81-371d-40f0-b234-3a4d57f54a77",
  "fxBreakdown": {
    "exchangeRate": 5.39485,
    "components": {
      "merchantSpreadPercent": 1.5,
      "pspSpreadPercent": 2,
      "localTaxPercent": 0.38,
      "operationFeePercent": 0.5
    },
    "contexts": {
      "base": {
        "currency": "USD",
        "payoutAmount": 1000,
        "merchantSpreadAmount": 15,
        "pspSpreadAmount": 20,
        "localTaxAmount": 3.8,
        "operationFee": 5,
        "netPayoutAmount": 956.2
      },
      "local": {
        "currency": "USD",
        "payoutAmount": 1000,
        "merchantSpreadAmount": 15,
        "pspSpreadAmount": 20,
        "localTaxAmount": 3.8,
        "operationFee": 5,
        "netPayoutAmount": 956.2
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.