List Payouts
GET {{baseUrl}}/v1/payouts?beneficiary=<string>&created_after=<string>&created_before=<string>&ending_before=<string>&ewallet=<string>&limit=<string>&merchant_reference_id=<string>&payout_method_type=<string>&sender=<string>&sender_country=OM&sender_currency=KGS&starting_after=<string>
Retrieve a list of payouts that you created.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
beneficiary | string | Filters according to the beneficiary ID. String starting with beneficiary_. | |
created_after | string | The ID of the payout created before the first payout you want to retrieve. String starting with payout_. | |
created_before | string | The ID of the payout created after the last payout you want to retrieve. String starting with payout_. | |
ending_before | string | The ID of a payout in the list. The list ends with the payout that was created before the payout with this ID. Use this filter to get the previous page of results. String starting with payout_. Deprecated. | |
ewallet | string | Filters according to the wallet ID. String starting with ewallet_. | |
limit | string | The maximum number of payouts to return. Range: 1-100. Default is 10. | |
merchant_reference_id | string | Filters according to the merchant reference ID. | |
payout_method_type | string | Filters according to the type of payout method. The two-letter prefix must match the beneficiary country code. | |
sender | string | Filters according to the sender ID. String starting with sender_. | |
sender_country | string | Filters according to the country of the sender. Two-letter ISO 3166-1 ALPHA-2 code. | |
sender_currency | string | Filters according to the currency that the sender is paying with. Three-letter ISO 4217 code. | |
starting_after | string | The ID of a payout in the list. The list begins with the payout that was created next after the payout with this ID. Use this filter to get the next page of results. Relevant when ending_before is not used. String starting with payout_. Deprecated |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"amount":"\u003cnumber\u003e","beneficiary":{"aba":"\u003cstring\u003e","account_number":"\u003cstring\u003e","ach_code":"\u003cstring\u003e","additional_data":{},"additional_last_name":"\u003cstring\u003e","address":"\u003cstring\u003e","bank_account_holder_name":"\u003cstring\u003e","bank_account_type":"\u003cstring\u003e","bank_address":"\u003cstring\u003e","bank_branch_code":"\u003cstring\u003e","bank_branch_name":"\u003cstring\u003e","bank_city":"\u003cstring\u003e","bank_code":"\u003cstring\u003e","bank_country":"\u003cstring\u003e","bank_name":"\u003cstring\u003e","bank_province":"\u003cstring\u003e","beneficiary_bic_local":"\u003cstring\u003e","beneficiary_relationship":"\u003cstring\u003e","bic_swift":"\u003cstring\u003e","bsb_code":"\u003cstring\u003e","card_expiration_month":"\u003cstring\u003e","card_expiration_year":"\u003cstring\u003e","card_number":"\u003cstring\u003e","category":"rapyd_ewallet","city":"\u003cstring\u003e","clabe":"\u003cstring\u003e","cnaps":"\u003cstring\u003e","company_name":"\u003cstring\u003e","confirmation_required":"\u003cboolean\u003e","country":"CC","currency":"AMD","date_of_birth":"\u003cstring\u003e","date_of_incorporation":"\u003cstring\u003e","default_payout_method_type":"\u003cstring\u003e","email":"\u003cstring\u003e","entity_type":"company","ewallet":"\u003cstring\u003e","first_name":"\u003cstring\u003e","iban":"\u003cstring\u003e","id":"\u003cstring\u003e","id_date_of_issue":"\u003cstring\u003e","id_issue_authority":"\u003cstring\u003e","id_issue_location":"\u003cstring\u003e","identification_type":"\u003cstring\u003e","identification_value":"\u003cstring\u003e","ifsc":"\u003cstring\u003e","issuer_code":"\u003cstring\u003e","last_name":"\u003cstring\u003e","merchant_reference_id":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","mobile_number":"\u003cstring\u003e","name":"\u003cstring\u003e","nationality":"\u003cstring\u003e","payment_type":"\u003cstring\u003e","phone_country_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","purpose_code":"\u003cstring\u003e","routing_code_type_1":"\u003cstring\u003e","routing_code_type_2":"\u003cstring\u003e","routing_code_type_3":"\u003cstring\u003e","routing_code_value_1":"\u003cstring\u003e","routing_code_value_2":"\u003cstring\u003e","routing_code_value_3":"\u003cstring\u003e","sort_code":"\u003cstring\u003e","state":"\u003cstring\u003e","statement_narrative":"\u003cstring\u003e","suburb":"\u003cstring\u003e","tax_id":"\u003cstring\u003e","vpa":"\u003cstring\u003e"},"beneficiary_country":"UG","created_at":"\u003cinteger\u003e","description":"\u003cstring\u003e","error":"\u003cstring\u003e","estimated_time_of_arrival":"\u003cstring\u003e","ewallets":[{"amount":"\u003cnumber\u003e","ewallet_id":"\u003cstring\u003e","percent":"\u003cnumber\u003e"},{"amount":"\u003cnumber\u003e","ewallet_id":"\u003cstring\u003e","percent":"\u003cnumber\u003e"}],"expiration":"\u003cnumber\u003e","fx_rate":"\u003cnumber\u003e","gc_error_code":"\u003cstring\u003e","id":"\u003cstring\u003e","identifier_type":"\u003cstring\u003e","identifier_value":"\u003cstring\u003e","instructions":{},"instructions_value":{},"merchant_reference_id":"\u003cstring\u003e","metadata":{},"paid_amount":"\u003cnumber\u003e","paid_at":"\u003cstring\u003e","payout_currency":"UYU","payout_fees":{"fx_fee":{"calc_type":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"gross_fees":"\u003cnumber\u003e","net_fees":"\u003cnumber\u003e","transaction_fee":{"calc_type":"\u003cstring\u003e","fee_type":"\u003cstring\u003e","value":"\u003cnumber\u003e"}},"payout_method_type":"\u003cstring\u003e","payout_type":"cash","sender":{"account_number":"\u003cstring\u003e","additional_data":{},"additional_last_name":"\u003cstring\u003e","address":"\u003cstring\u003e","bank_code":"\u003cstring\u003e","bank_name":"\u003cstring\u003e","beneficiary_relationship":"\u003cstring\u003e","city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","country":"BW","currency":"ZMW","date_of_birth":"\u003cstring\u003e","date_of_incorporation":"\u003cstring\u003e","email":"\u003cstring\u003e","entity_type":"individual","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","id_date_of_issue":"\u003cstring\u003e","id_expiry":"\u003cstring\u003e","id_issue_authority":"\u003cstring\u003e","id_issue_location":"\u003cstring\u003e","identification_type":"\u003cstring\u003e","identification_value":"\u003cstring\u003e","last_name":"\u003cstring\u003e","merchant_reference_id":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","mobile_number":"\u003cstring\u003e","name":"\u003cstring\u003e","nationality":"\u003cstring\u003e","occupation":"\u003cstring\u003e","phone_country_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","purpose_code":"\u003cstring\u003e","source_of_income":"\u003cstring\u003e","state":"\u003cstring\u003e","suburb":"\u003cstring\u003e","tax_id":"\u003cstring\u003e"},"sender_amount":"\u003cnumber\u003e","sender_country":"NF","sender_currency":"KHR","statement_descriptor":"\u003cstring\u003e","status":"Canceled"},{"amount":"\u003cnumber\u003e","beneficiary":{"aba":"\u003cstring\u003e","account_number":"\u003cstring\u003e","ach_code":"\u003cstring\u003e","additional_data":{},"additional_last_name":"\u003cstring\u003e","address":"\u003cstring\u003e","bank_account_holder_name":"\u003cstring\u003e","bank_account_type":"\u003cstring\u003e","bank_address":"\u003cstring\u003e","bank_branch_code":"\u003cstring\u003e","bank_branch_name":"\u003cstring\u003e","bank_city":"\u003cstring\u003e","bank_code":"\u003cstring\u003e","bank_country":"\u003cstring\u003e","bank_name":"\u003cstring\u003e","bank_province":"\u003cstring\u003e","beneficiary_bic_local":"\u003cstring\u003e","beneficiary_relationship":"\u003cstring\u003e","bic_swift":"\u003cstring\u003e","bsb_code":"\u003cstring\u003e","card_expiration_month":"\u003cstring\u003e","card_expiration_year":"\u003cstring\u003e","card_number":"\u003cstring\u003e","category":"bank","city":"\u003cstring\u003e","clabe":"\u003cstring\u003e","cnaps":"\u003cstring\u003e","company_name":"\u003cstring\u003e","confirmation_required":"\u003cboolean\u003e","country":"WF","currency":"BRL","date_of_birth":"\u003cstring\u003e","date_of_incorporation":"\u003cstring\u003e","default_payout_method_type":"\u003cstring\u003e","email":"\u003cstring\u003e","entity_type":"individual","ewallet":"\u003cstring\u003e","first_name":"\u003cstring\u003e","iban":"\u003cstring\u003e","id":"\u003cstring\u003e","id_date_of_issue":"\u003cstring\u003e","id_issue_authority":"\u003cstring\u003e","id_issue_location":"\u003cstring\u003e","identification_type":"\u003cstring\u003e","identification_value":"\u003cstring\u003e","ifsc":"\u003cstring\u003e","issuer_code":"\u003cstring\u003e","last_name":"\u003cstring\u003e","merchant_reference_id":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","mobile_number":"\u003cstring\u003e","name":"\u003cstring\u003e","nationality":"\u003cstring\u003e","payment_type":"\u003cstring\u003e","phone_country_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","purpose_code":"\u003cstring\u003e","routing_code_type_1":"\u003cstring\u003e","routing_code_type_2":"\u003cstring\u003e","routing_code_type_3":"\u003cstring\u003e","routing_code_value_1":"\u003cstring\u003e","routing_code_value_2":"\u003cstring\u003e","routing_code_value_3":"\u003cstring\u003e","sort_code":"\u003cstring\u003e","state":"\u003cstring\u003e","statement_narrative":"\u003cstring\u003e","suburb":"\u003cstring\u003e","tax_id":"\u003cstring\u003e","vpa":"\u003cstring\u003e"},"beneficiary_country":"MN","created_at":"\u003cinteger\u003e","description":"\u003cstring\u003e","error":"\u003cstring\u003e","estimated_time_of_arrival":"\u003cstring\u003e","ewallets":[{"amount":"\u003cnumber\u003e","ewallet_id":"\u003cstring\u003e","percent":"\u003cnumber\u003e"},{"amount":"\u003cnumber\u003e","ewallet_id":"\u003cstring\u003e","percent":"\u003cnumber\u003e"}],"expiration":"\u003cnumber\u003e","fx_rate":"\u003cnumber\u003e","gc_error_code":"\u003cstring\u003e","id":"\u003cstring\u003e","identifier_type":"\u003cstring\u003e","identifier_value":"\u003cstring\u003e","instructions":{},"instructions_value":{},"merchant_reference_id":"\u003cstring\u003e","metadata":{},"paid_amount":"\u003cnumber\u003e","paid_at":"\u003cstring\u003e","payout_currency":"NOK","payout_fees":{"fx_fee":{"calc_type":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"gross_fees":"\u003cnumber\u003e","net_fees":"\u003cnumber\u003e","transaction_fee":{"calc_type":"\u003cstring\u003e","fee_type":"\u003cstring\u003e","value":"\u003cnumber\u003e"}},"payout_method_type":"\u003cstring\u003e","payout_type":"rapyd_ewallet","sender":{"account_number":"\u003cstring\u003e","additional_data":{},"additional_last_name":"\u003cstring\u003e","address":"\u003cstring\u003e","bank_code":"\u003cstring\u003e","bank_name":"\u003cstring\u003e","beneficiary_relationship":"\u003cstring\u003e","city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","country":"WS","currency":"KPW","date_of_birth":"\u003cstring\u003e","date_of_incorporation":"\u003cstring\u003e","email":"\u003cstring\u003e","entity_type":"company","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","id_date_of_issue":"\u003cstring\u003e","id_expiry":"\u003cstring\u003e","id_issue_authority":"\u003cstring\u003e","id_issue_location":"\u003cstring\u003e","identification_type":"\u003cstring\u003e","identification_value":"\u003cstring\u003e","last_name":"\u003cstring\u003e","merchant_reference_id":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","mobile_number":"\u003cstring\u003e","name":"\u003cstring\u003e","nationality":"\u003cstring\u003e","occupation":"\u003cstring\u003e","phone_country_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","purpose_code":"\u003cstring\u003e","source_of_income":"\u003cstring\u003e","state":"\u003cstring\u003e","suburb":"\u003cstring\u003e","tax_id":"\u003cstring\u003e"},"sender_amount":"\u003cnumber\u003e","sender_country":"PE","sender_currency":"IQD","statement_descriptor":"\u003cstring\u003e","status":"Error"}],"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}