Sign in
Payouts

Retrieve payments for a payout

Retrieve payments for a payout

get/v3/payouts/{payoutId}/payments

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

transmissionType'ACH' | 'SAME_DAY_ACH' | 'WIRE'

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",
      "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",
      "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