Get Payout Summary

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

GET

/v3/payouts/{payoutId}

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v3/payouts/'

Response Example

200 - Example 1

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

Request

Path Params

Responses

🟢200Details of Payout

application/json

Body

🟠401Invalid access token. May be expired or invalid

🟠403The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

🟠404The resource was not found or is no longer available

Modified at 2022-09-11 21:50:18

Withdraw Payout

Instruct Payout