VEvelopaymentsapi
Payouts

Retrieve payments for a payout

Changed on

Retrieve payments for a payout

get/v3/payouts/{payoutId}/payments

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

Query parameters

status'ACCEPTED' | 'REJECTED' | 'WITHDRAWN' | 'WITHDRAWABLE'

Payment Status

  • ACCEPTED: any payment which was accepted at submission time (status may have changed since)
  • REJECTED: any payment rejected by initial submission processing
  • WITHDRAWN: any payment which has been withdrawn
  • WITHDRAWABLE: any payment eligible for withdrawal
remoteIdstring

The remote id of the payees.

payorPaymentIdstring

Payor's Id of the Payment

sourceAccountNamestring

Physical Account Name

transmissionTypestring

Valid values for transmissionType can be found attached to the Source Account

Transmission Type

  • ACH
  • SAME_DAY_ACH
  • WIRE
paymentMemostring

Payment Memo of the Payment

pageSizeinteger

The number of results to return in a page

pageinteger

Page number. Default is 1.

Response

Payments for payout

Example response

{
  "links": [
    {
      "rel": "rel",
      "href": "href"
    },
    {
      "rel": "rel",
      "href": "href"
    }
  ],
  "page": {
    "numberOfElements": 0,
    "totalPages": 1,
    "pageSize": 5,
    "page": 5,
    "totalElements": 6
  },
  "content": [
    {
      "amount": 10000,
      "paymentMemo": "INV00112",
      "transactionId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "remoteId": "remoteIdVal123",
      "payee": {
        "individual": {
          "name": {
            "firstName": "Fred",
            "lastName": "Flintstone"
          }
        },
        "company": {
          "companyName": "ACME Anvils PLC"
        },
        "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      },
      "paymentId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "withdrawable": false,
      "autoWithdrawnReasonCode": "VE0003",
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "transmissionType": "LOCAL",
      "railsId": "SVB",
      "remoteSystemId": "OB012",
      "sourceAccountName": "Chase Bank Account",
      "status": "AWAITING_FUNDS"
    },
    {
      "amount": 10000,
      "paymentMemo": "INV00112",
      "transactionId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "remoteId": "remoteIdVal123",
      "payee": {
        "individual": {
          "name": {
            "firstName": "Fred",
            "lastName": "Flintstone"
          }
        },
        "company": {
          "companyName": "ACME Anvils PLC"
        },
        "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      },
      "paymentId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "withdrawable": false,
      "autoWithdrawnReasonCode": "VE0003",
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "transmissionType": "LOCAL",
      "railsId": "SVB",
      "remoteSystemId": "OB012",
      "sourceAccountName": "Chase Bank Account",
      "status": "AWAITING_FUNDS"
    }
  ]
}

Changes

  • 05c3f09fc50aRevision changes
    • breaking

      removed the enum value ACH from the query request parameter transmissionType

    • breaking

      removed the enum value SAME_DAY_ACH from the query request parameter transmissionType

    • breaking

      removed the enum value WIRE from the query request parameter transmissionType

    • info

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

  • 2c03ca69ee09Revision changes
    • info

      api tag Payouts added

    • info

      api tag Payout Service removed