Sign in
Payout Service

Get Payout Summary

Get payout summary - returns the current state of the payout.

get/v3/payouts/{payoutId}

Path parameters

payoutIdstring uuid required

Id of the payout

Response

Details of Payout

payoutIdstring uuid
statusstring
paymentsSubmittedinteger
paymentsAcceptedinteger
paymentsRejectedinteger
paymentsWithdrawninteger required

Example response

{
  "rejectedPayments": [
    {
      "currencyType": "USD",
      "reason": "The payee has not been onboarded",
      "amount": 1234,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "payorPaymentId": "paymenIdVal123123",
      "reasonCode": "PAYMENT_VALUE_TOO_HIGH",
      "remoteSystemId": "Remote_System_Id_101234",
      "lineNumber": 10,
      "message": "Payment cannot be processed because of the Payee's OFAC or Compliance Status",
      "remoteId": "remoteIdVal123",
      "sourceAccountName": "Chase"
    },
    {
      "currencyType": "USD",
      "reason": "The payee has not been onboarded",
      "amount": 1234,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "payorPaymentId": "paymenIdVal123123",
      "reasonCode": "PAYMENT_VALUE_TOO_HIGH",
      "remoteSystemId": "Remote_System_Id_101234",
      "lineNumber": 10,
      "message": "Payment cannot be processed because of the Payee's OFAC or Compliance Status",
      "remoteId": "remoteIdVal123",
      "sourceAccountName": "Chase"
    }
  ],
  "schedule": {
    "scheduledFor": "2000-01-23T04:56:07.000+00:00",
    "scheduleStatus": "SCHEDULED",
    "notificationsEnabled": true,
    "scheduledByPrincipalId": "8946953b-1e3b-49cf-9da4-b704cbb78f3e",
    "scheduledAt": "2000-01-23T04:56:07.000+00:00"
  },
  "paymentsRejected": 0,
  "paymentsSubmitted": 10,
  "paymentsWithdrawn": 0,
  "fxSummaries": [
    {
      "invertedRate": 1.12,
      "creationTime": "2000-01-23T04:56:07.000+00:00",
      "rate": 1.12,
      "expiryTime": "2000-01-23T04:56:07.000+00:00",
      "sourceCurrency": "USD",
      "totalPaymentAmount": 1234,
      "paymentCurrency": "USD",
      "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalSourceAmount": 1234,
      "fundingStatus": "FUNDED",
      "status": "QUOTED"
    },
    {
      "invertedRate": 1.12,
      "creationTime": "2000-01-23T04:56:07.000+00:00",
      "rate": 1.12,
      "expiryTime": "2000-01-23T04:56:07.000+00:00",
      "sourceCurrency": "USD",
      "totalPaymentAmount": 1234,
      "paymentCurrency": "USD",
      "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalSourceAmount": 1234,
      "fundingStatus": "FUNDED",
      "status": "QUOTED"
    }
  ],
  "accounts": [
    {
      "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "currency": "USD",
      "totalPayoutCost": 1231200,
      "sourceAccountName": "AccountName"
    },
    {
      "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "currency": "USD",
      "totalPayoutCost": 1231200,
      "sourceAccountName": "AccountName"
    }
  ],
  "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "acceptedPayments": [
    {
      "currencyType": "USD",
      "amount": 1234,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "payorPaymentId": "paymenIdVal123123",
      "railsId": "WU",
      "paymentMemo": "Payment memo",
      "remoteSystemId": "Remote_System_Id_101234",
      "remoteId": "remoteIdVal123",
      "sourceAccountName": "Chase"
    },
    {
      "currencyType": "USD",
      "amount": 1234,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "payorPaymentId": "paymenIdVal123123",
      "railsId": "WU",
      "paymentMemo": "Payment memo",
      "remoteSystemId": "Remote_System_Id_101234",
      "remoteId": "remoteIdVal123",
      "sourceAccountName": "Chase"
    }
  ],
  "status": "COMPLETED",
  "paymentsAccepted": 10
}

Changes