Retrieve payments for a payout
643 matches
88 actions
Velo Payments
88 actions
- Add LogoPOSTv1.0.0
- Create a Payor LinkPOSTv1.0.0
- Create a quote for the payoutPOSTv1.0.0
- Create API KeyPOSTv1.0.0
- Create ApplicationPOSTv1.0.0
- Create Funding AccountPOSTv1.0.0
- Create Funding RequestPOSTv1.0.0
- Create Funding RequestPOSTv1.0.0
- Delete a source account by IDDELETEv1.0.0
- Delete a UserDELETEv1.0.0
- Delete Payee by IdDELETEv1.0.0
- Delete Payee by IdDELETEv1.0.0
- Deschedule a payoutDELETEv1.0.0
- Disable a UserPOSTv1.0.0
- Enable a UserPOSTv1.0.0
- Get BrandingGETv1.0.0
- Get details about given source account.GETv1.0.0
- Get FundingGETv1.0.0
- Get Funding AccountGETv1.0.0
- Get Funding AccountsGETv1.0.0
- Get Funding Audit DeltaGETv1.0.0
- Get Fundings for PayorGETv1.0.0
- Get List of PaymentsGETv1.0.0
- Get list of source accountsGETv1.0.0
- Get list of source accountsGETv1.0.0
- Get Payee by IdGETv1.0.0
- Get Payee by IdGETv1.0.0
- Get Payee Invitation StatusGETv1.0.0
- Get Payee Invitation StatusGETv1.0.0
- Get PaymentGETv1.0.0
- Get Payments for PayoutGETv1.0.0
- Get PayorGETv1.0.0
- Get PayorGETv1.0.0
- Get Payout StatisticsGETv1.0.0
- Get Payout SummaryGETv1.0.0
- Get Payouts for PayorGETv1.0.0
- Get SelfGETv1.0.0
- Get Source AccountGETv1.0.0
- Get UserGETv1.0.0
- Initiate Payee CreationPOSTv1.0.0
- Initiate Payee CreationPOSTv1.0.0
- Instruct PayoutPOSTv1.0.0
- Invite a UserPOSTv1.0.0
- List Payee ChangesGETv1.0.0
- List Payee ChangesGETv1.0.0
- List PayeesGETv1.0.0
- List PayeesGETv1.0.0
- List Payment ChangesGETv1.0.0
- List Payment Channel Country RulesGETv1.0.0
- List Payor LinksGETv1.0.0
- List Supported CountriesGETv1.0.0
- List Supported CountriesGETv1.0.0
- List Supported CurrenciesGETv1.0.0
- List UsersGETv1.0.0
- LogoutPOSTv1.0.0
- Register SMS NumberPOSTv1.0.0
- Reminder Email Opt-OutPOSTv1.0.0
- Resend Payee InvitePOSTv1.0.0
- Resend Payee InvitePOSTv1.0.0
- Reset passwordPOSTv1.0.0
- Retrieve payments for a payoutGETv1.0.0
- Schedule a payoutPOSTv1.0.0
- Set notificationsPOSTv1.0.0
- Set notificationsPOSTv1.0.0
- Submit PayoutPOSTv1.0.0
- Transfer Funds between source accountsPOSTv1.0.0
- Transfer Funds between source accountsPOSTv1.0.0
- Unlock a UserPOSTv1.0.0
- Unregister MFA for SelfPOSTv1.0.0
- Unregister MFA for the userPOSTv1.0.0
- Update Password for selfPOSTv1.0.0
- Update Payee DetailsPOSTv1.0.0
- Update Payee DetailsPOSTv1.0.0
- Update Payee Remote IdPOSTv1.0.0
- Update Payee Remote IdPOSTv1.0.0
- Update User DetailsPOSTv1.0.0
- Update User Details for selfPOSTv1.0.0
- Update User RolePOSTv1.0.0
- V1 Get Fundings for PayorGETv1.0.0
- V1 Get Payout StatisticsGETv1.0.0
- V1 List Payment ChangesGETv1.0.0
- V3 Get List of PaymentsGETv1.0.0
- V3 Get PaymentGETv1.0.0
- V3 Get Payments for PayoutGETv1.0.0
- V3 Get Payouts for PayorGETv1.0.0
- Validate the proposed passwordPOSTv1.0.0
- Withdraw a PaymentPOSTv1.0.0
- Withdraw PayoutDELETEv1.0.0
E-commerce/Velo Payments
Retrieve payments for a payout
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"paymentMemo": {
"type": "string"
},
"payorPaymentId": {
"type": "string"
},
"payoutId": {
"type": "string",
"format": "uuid"
},
"remoteId": {
"type": "string"
},
"sourceAccountName": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"REJECTED",
"WITHDRAWN",
"WITHDRAWABLE"
]
},
"transmissionType": {
"type": "string",
"enum": [
"ACH",
"SAME_DAY_ACH",
"WIRE"
]
}
},
"required": [
"payoutId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
{
"type": "object",
"description": "List Payees Response Object",
"properties": {
"content": {
"type": "array",
"items": {
"type": "object",
"required": [
"paymentId"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount of the payment in minor units"
},
"autoWithdrawnReasonCode": {
"type": "string",
"description": "Populated only if the payment was automatically withdrawn during instruction for being invalid"
},
"currency": {
"type": "string",
"description": "The currency that the payment was made in"
},
"payee": {
"type": "object",
"description": "Payee data associated with a payment. Either individual or company must be populated",
"required": [
"payeeId"
],
"properties": {
"company": {
"type": "object",
"required": [
"companyName"
],
"properties": {
"companyName": {
"type": "string"
}
}
},
"individual": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
}
}
}
},
"payeeId": {
"type": "string",
"format": "uuid"
}
}
},
"paymentId": {
"type": "string",
"format": "uuid",
"description": "The id of the payment"
},
"paymentMemo": {
"type": "string",
"description": "<p>Any value here will override the memo value in the parent payout</p>\n<p>This should be the reference field on the statement seen by the payee (but not via ACH)</p>\n"
},
"paymentMetadata": {
"type": "string",
"description": "<p>Metadata about the payment that may be relevant to the specific rails or remote system making the payout</p>\n<p>The structure of the data will be dictated by the requirements of the payment rails</p>\n"
},
"payorPaymentId": {
"type": "string",
"description": "A reference identifier for the payor for the given payee payment"
},
"railsId": {
"type": "string",
"description": "Indicates the 3rd party system involved in making this payment"
},
"remoteId": {
"type": "string",
"description": "The remoteId supplied by the payor that identifies the payee"
},
"remoteSystemId": {
"type": "string",
"description": "<p>The identifier for the remote payments system if not Velo</p>\n"
},
"sourceAccountName": {
"type": "string",
"description": "The identifier of the source account to debit the payment from"
},
"status": {
"type": "string",
"description": "Current status of payment. One of the following values: SUBMITTED, ACCEPTED, REJECTED, WITHDRAWN, RETURNED, AWAITING_FUNDS, FUNDED, UNFUNDED, CANCELLED, BANK_PAYMENT_REQUESTED"
},
"transmissionType": {
"type": "string",
"description": "The transmission method of the payment. One of the following values: ACH, SAME_DAY_ACH, WIRE, LOCAL, SWIFT"
},
"withdrawable": {
"type": "boolean",
"description": "Can this paynent be withdrawn"
}
}
}
},
"links": {
"type": "array",
"items": {
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"page": {
"properties": {
"numberOfElements": {
"type": "integer"
},
"page": {
"type": "integer"
},
"pageSize": {
"type": "integer"
},
"totalElements": {
"type": "integer"
},
"totalPages": {
"type": "integer"
}
}
}
}
}