VEvelopaymentsapi
Payouts

Get Payout Summary

Changed on

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

get/v3/payouts/{payoutId}

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Path parameters

payoutIdstring uuid required

Id of the payout

Response

Details of Payout

payoutIdstring uuid

The id of the payout

statusstring

The status of the payout (one of SUBMITTED, ACCEPTED, REJECTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, WITHDRAWN)

paymentsSubmittedinteger

The number of payments that were submitted in the payout

paymentsAcceptedinteger

The number of payments that were accepted in the payout

paymentsRejectedinteger

The number of payments that were rejected in the payout

paymentsWithdrawninteger required

The number of payments that were withdrawn in the payout

Example response

{
  "rejectedPayments": [
    {
      "currencyType": "USD",
      "reason": "The payee has not been onboarded",
      "amount": 10000,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "payorPaymentId": "123211321ABSD",
      "reasonCode": "VE1012",
      "remoteSystemId": "OB012",
      "lineNumber": 34,
      "message": "Payment cannot be processed because of the Payee's OFAC or Compliance Status",
      "remoteId": "remoteIdVal123",
      "sourceAccountName": "Chase Bank Account"
    },
    {
      "currencyType": "USD",
      "reason": "The payee has not been onboarded",
      "amount": 10000,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "payorPaymentId": "123211321ABSD",
      "reasonCode": "VE1012",
      "remoteSystemId": "OB012",
      "lineNumber": 34,
      "message": "Payment cannot be processed because of the Payee's OFAC or Compliance Status",
      "remoteId": "remoteIdVal123",
      "sourceAccountName": "Chase Bank Account"
    }
  ],
  "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": 1,
  "paymentsSubmitted": 10,
  "paymentsWithdrawn": 0,
  "fxSummaries": [
    {
      "invertedRate": 1.12,
      "creationTime": "2022-10-30T09:45:09Z",
      "rate": 0.89,
      "expiryTime": "2022-10-30T09:50:09Z",
      "sourceCurrency": "USD",
      "totalPaymentAmount": 890000,
      "paymentCurrency": "USD",
      "quoteId": "af80d455-29dd-4e72-a000-495a9829a7d0",
      "totalSourceAmount": 1000000,
      "fundingStatus": "FUNDED",
      "status": "QUOTED"
    },
    {
      "invertedRate": 1.12,
      "creationTime": "2022-10-30T09:45:09Z",
      "rate": 0.89,
      "expiryTime": "2022-10-30T09:50:09Z",
      "sourceCurrency": "USD",
      "totalPaymentAmount": 890000,
      "paymentCurrency": "USD",
      "quoteId": "af80d455-29dd-4e72-a000-495a9829a7d0",
      "totalSourceAmount": 1000000,
      "fundingStatus": "FUNDED",
      "status": "QUOTED"
    }
  ],
  "accounts": [
    {
      "sourceAccountId": "cf81e490-4ab8-49c2-bd68-9d1e725480cb",
      "currency": "USD",
      "totalPayoutCost": 1000000,
      "sourceAccountName": "AccountName"
    },
    {
      "sourceAccountId": "cf81e490-4ab8-49c2-bd68-9d1e725480cb",
      "currency": "USD",
      "totalPayoutCost": 1000000,
      "sourceAccountName": "AccountName"
    }
  ],
  "payoutId": "cf81e490-4ab8-49c2-bd68-9d1e725480cb",
  "acceptedPayments": [
    {
      "currencyType": "USD",
      "amount": 10000,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "payorPaymentId": "123211321ABSD",
      "railsId": "SVB",
      "paymentMemo": "INV00112",
      "remoteSystemId": "OB012",
      "remoteId": "remoteId1234",
      "sourceAccountName": "Chase Bank Account"
    },
    {
      "currencyType": "USD",
      "amount": 10000,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "payorPaymentId": "123211321ABSD",
      "railsId": "SVB",
      "paymentMemo": "INV00112",
      "remoteSystemId": "OB012",
      "remoteId": "remoteId1234",
      "sourceAccountName": "Chase Bank Account"
    }
  ],
  "status": "COMPLETED",
  "paymentsAccepted": 9
}

Changes

  • 2c03ca69ee09Revision changes
    • info

      api tag Payouts added

    • info

      api tag Payout Service removed

  • 1e7a1734a45cRevision changes
    • info

      removed the EXECUTED enum value from the // response property for the response status

    • info

      removed the EXECUTED enum value from the / response property for the response status

    • info

      removed the EXPIRED enum value from the // response property for the response status

    • info

      removed the FAILED enum value from the / response property for the response status

    • info

      removed the FUNDED enum value from the // response property for the response status

    • info

      removed the INSTRUCTED enum value from the // response property for the response status

    • info

      removed the QUOTED enum value from the // response property for the response status

    • info

      removed the REJECTED enum value from the // response property for the response status

    • info

      removed the SCHEDULED enum value from the / response property for the response status

    • info

      removed the UNFUNDED enum value from the // response property for the response status

    • info

      removed the UNQUOTED enum value from the // response property for the response status

    • info

      added the required property // to the response with the status