List Payments
Retrieve a list of all payments that you have created.
You can filter the list with query parameters.
Note
A date range that exceeds 90 days, defined with both created_after
and created_before
, returns ERROR_QUERY_DATE_RANGE_EXCEEDS_90_DAYS.
Note
The code samples include successful requests (200), bad requests (400), and an unauthorized request (401).
For a list of all error messages that appear due to bad requests, see:
created_after
The ID of the payment created before the first payment you want to retrieve. String starting with payment_.
Date range: 1-90 days. Default: 90 days.
created_before
The ID of the payment created after the last payment you want to retrieve. String starting with payment_.
Date range: 1-90 days. Default: 90 days.
customer
Filters the list for payments related to the specified customer.
destination_card
Filters the list for payments related to the specified destination card.
ending_before
The ID of the payment created after the last payment you want to retrieve. String starting with payment_. Deprecated.
ewallet
Filters the list for payments related to the specified wallet.
invoice
Filters the list for payments related to the specified invoice.
limit
The maximum number of payments to return. Range: 1-100.
10
order
Filters the list for payments related to the specified order.
payment_method
Filters the list for payments related to the specified payment method.
starting_after
The ID of the payment created before the first payment you want to retrieve. String starting with payment_. Deprecated.
subscription
Filters the list for payments related to the specified subscription.
Code Samples
.NET
using System; namespace RapydApiRequestSample { class Program { static void Main(string[] args) { try { int limit = 2; string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payments?limit={limit}"); Console.WriteLine(result); } catch (Exception e) { Console.WriteLine("Error completing request: " + e.Message); } } } }
JavaScript
const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest; async function main() { try { const result = await makeRequest( 'GET', '/v1/payments?limit=2' ); console.log(result); } catch (error) { console.error('Error completing request', error); } }
PHP
<?php $path = $_SERVER['DOCUMENT_ROOT']; $path .= "/<path-to-your-utility-file>/utilities.php"; include($path); try { $object = make_request('get', '/v1/payments?limit=2'); var_dump($object); } catch(Exception $e) { echo "Error: $e"; } ?>
Python
from pprint import pprint from utilities import make_request response = make_request(method='get', path=f'/v1/payments?limit=2')
/v1/payments
List Payments
curl -X get https://sandboxapi.rapyd.net/v1/payments?limit=2 -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "5ea2b85c-7cd9-4b8f-baf6-1b12d0bb2118" }, "data": [ { "id": "payment_f2e57196a80852a24b644ef6ceea56f7", "amount": 0, "original_amount": 1000, "is_partial": false, "currency_code": "PLN", "country_code": "pl", "status": "ACT", "description": "Bank transfer payment using prerequisite PM", "merchant_reference_id": "", "customer_token": "cus_f3d4d8575d30b27aa39230e76fb83a54", "payment_method": "other_2d1a55ed70548f259f6a488fd81ed96a", "payment_method_data": { "id": "other_2d1a55ed70548f259f6a488fd81ed96a", "type": "pl_p24_bank", "category": "bank_redirect", "metadata": { "merchant_defined": true }, "image": "", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "bic_swift": "", "account_last4": "" }, "auth_code": null, "expiration": 1755097289, "captured": true, "refunded": false, "refunded_amount": 0, "receipt_email": "", "redirect_url": "https://sandboxcheckout.rapyd.net/complete-bank-payment?token=payment_f2e57196a80852a24b644ef6ceea56f7&complete_payment_url=&error_payment_url=", "complete_payment_url": "", "error_payment_url": "", "receipt_number": "", "flow_type": "", "address": null, "statement_descriptor": "Doc Team", "transaction_id": "", "created_at": 1753887689, "metadata": {}, "failure_code": "", "failure_message": "", "paid": false, "paid_at": 0, "dispute": null, "refunds": null, "order": null, "outcome": null, "visual_codes": {}, "textual_codes": {}, "instructions": {}, "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 1000, "percent": 100, "refunded_amount": 0 } ], "payment_method_options": {}, "payment_method_type": "pl_p24_bank", "payment_method_type_category": "bank_redirect", "fx_rate": 1, "merchant_requested_currency": null, "merchant_requested_amount": null, "fixed_side": "", "payment_fees": null, "invoice": "", "escrow": null, "group_payment": "", "cancel_reason": null, "initiation_type": "customer_present", "mid": "", "next_action": "pending_confirmation", "error_code": "", "remitter_information": {}, "save_payment_method": false, "merchant_advice_code": null, "merchant_advice_message": null, "transaction_link_id": null }, { "id": "payment_162a9c308e67f998b8a87757ea44409f", "amount": 0, "original_amount": 1000, "is_partial": false, "currency_code": "PLN", "country_code": "pl", "status": "ACT", "description": "Bank transfer payment using prerequisite PM", "merchant_reference_id": "", "customer_token": "cus_f3d4d8575d30b27aa39230e76fb83a54", "payment_method": "other_2d1a55ed70548f259f6a488fd81ed96a", "payment_method_data": { "id": "other_2d1a55ed70548f259f6a488fd81ed96a", "type": "pl_p24_bank", "category": "bank_redirect", "metadata": { "merchant_defined": true }, "image": "", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "bic_swift": "", "account_last4": "" }, "auth_code": null, "expiration": 1755096408, "captured": true, "refunded": false, "refunded_amount": 0, "receipt_email": "", "redirect_url": "https://sandboxcheckout.rapyd.net/complete-bank-payment?token=payment_162a9c308e67f998b8a87757ea44409f&complete_payment_url=&error_payment_url=", "complete_payment_url": "", "error_payment_url": "", "receipt_number": "", "flow_type": "", "address": null, "statement_descriptor": "Doc Team", "transaction_id": "", "created_at": 1753886808, "metadata": {}, "failure_code": "", "failure_message": "", "paid": false, "paid_at": 0, "dispute": null, "refunds": null, "order": null, "outcome": null, "visual_codes": {}, "textual_codes": {}, "instructions": {}, "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 1000, "percent": 100, "refunded_amount": 0 } ], "payment_method_options": {}, "payment_method_type": "pl_p24_bank", "payment_method_type_category": "bank_redirect", "fx_rate": 1, "merchant_requested_currency": null, "merchant_requested_amount": null, "fixed_side": "", "payment_fees": null, "invoice": "", "escrow": null, "group_payment": "", "cancel_reason": null, "initiation_type": "customer_present", "mid": "", "next_action": "pending_confirmation", "error_code": "", "remitter_information": {}, "save_payment_method": false, "merchant_advice_code": null, "merchant_advice_message": null, "transaction_link_id": null } ] }
List Group Payments and Limit of Two
curl -X get https://sandboxapi.rapyd.net/v1/payments?group=true&limit=2 -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "bb216c05-069f-45e7-b22d-25fb4e6e4b7a" }, "data": [ { "id": "payment_d272bf57ccb88741cf9732270516b526", "amount": 200, "original_amount": 200, "is_partial": false, "currency_code": "USD", "country_code": "fr", "status": "CLO", "description": "", "merchant_reference_id": "", "customer_token": "cus_3cd0d059b51936a0487634b456a8e9c3", "payment_method": "card_c60d4678a8bfbad42b495b3c3dcd0810", "payment_method_data": { "id": "card_c60d4678a8bfbad42b495b3c3dcd0810", "type": "fr_mastercard_card", "category": "card", "metadata": null, "image": "", "authentication_url": "", "webhook_url": "", "supporting_documentation": "", "name": "John Doe", "last4": "1111", "acs_check": "unchecked", "cvv_check": "unchecked", "bin_details": { "brand": null, "bin_number": "411111" }, "expiration_year": "23", "expiration_month": "11", "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467", "payment_account_reference": "V0010013018036782991622965076" }, "expiration": 1622554328, "captured": true, "refunded": false, "refunded_amount": 0, "receipt_email": "", "redirect_url": "", "complete_payment_url": "", "error_payment_url": "", "receipt_number": "", "flow_type": "", "address": null, "statement_descriptor": "Rapyd", "transaction_id": "", "created_at": 1621949528, "metadata": {}, "failure_code": "", "failure_message": "", "paid": true, "paid_at": 1621949528, "dispute": null, "refunds": null, "order": null, "outcome": null, "visual_codes": {}, "textual_codes": {}, "instructions": {}, "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4", "ewallets": [ { "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4", "amount": 200, "percent": 100, "refunded_amount": 0 } ], "payment_method_options": {}, "payment_method_type": "fr_mastercard_card", "payment_method_type_category": "card", "fx_rate": 1, "merchant_requested_currency": null, "merchant_requested_amount": null, "fixed_side": "", "payment_fees": null, "invoice": "", "escrow": null, "group_payment": "gp_119896e86cedd72e8bafbcf26968ea08", "cancel_reason": null, "initiation_type": "customer_present", "mid": "", "next_action": "not_applicable", "merchant_advice_code": null, "merchant_advice_message": null, "transaction_link_id": "A49sx-3Tm2Pk3dYv_PL0Rc" }, { "id": "payment_5dbe58b16fd1f611f5de4015b7cf6bba", "amount": 50, "original_amount": 50, "is_partial": false, "currency_code": "USD", "country_code": "fr", "status": "CLO", "description": "", "merchant_reference_id": "", "customer_token": "cus_ab5b66edc938dbd09764eb4974247e41", "payment_method": "card_6d85d4898377ce80959584034fe91cc5", "payment_method_data": { "id": "card_6d85d4898377ce80959584034fe91cc5", "type": "fr_visa_card", "category": "card", "metadata": null, "image": "", "authentication_url": "", "webhook_url": "", "supporting_documentation": "", "name": "Jane Doe", "last4": "1111", "acs_check": "unchecked", "cvv_check": "unchecked", "bin_details": { "brand": null, "bin_number": "411111" }, "expiration_year": "23", "expiration_month": "11", "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467", "payment_account_reference": "V0010013018036782991622965076" }, "expiration": 1622554328, "captured": true, "refunded": false, "refunded_amount": 0, "receipt_email": "", "redirect_url": "", "complete_payment_url": "", "error_payment_url": "", "receipt_number": "", "flow_type": "", "address": null, "statement_descriptor": "Rapyd", "transaction_id": "", "created_at": 1621949528, "metadata": {}, "failure_code": "", "failure_message": "", "paid": true, "paid_at": 1621949528, "dispute": null, "refunds": null, "order": null, "outcome": null, "visual_codes": {}, "textual_codes": {}, "instructions": {}, "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db", "ewallets": [ { "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db", "amount": 50, "percent": 100, "refunded_amount": 0 } ], "payment_method_options": {}, "payment_method_type": "fr_visa_card", "payment_method_type_category": "card", "fx_rate": 1, "merchant_requested_currency": null, "merchant_requested_amount": null, "fixed_side": "", "payment_fees": null, "invoice": "", "escrow": null, "group_payment": "gp_119896e86cedd72e8bafbcf26968ea08", "cancel_reason": null, "initiation_type": "customer_present", "mid": "", "next_action": "not_applicable", "merchant_advice_code": null, "merchant_advice_message": null, "transaction_link_id": null } ] }
List Payments by Wallet ID
curl -X get https://sandboxapi.rapyd.net/v1/payments?ewallet=ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4 -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "4d9bd095-9ca4-4b03-b26d-3e1044a7201d" }, "data": [ { "id": "payment_d272bf57ccb88741cf9732270516b526", "amount": 200, "original_amount": 200, "is_partial": false, "currency_code": "USD", "country_code": "fr", "status": "CLO", "description": "", "merchant_reference_id": "", "customer_token": "cus_3cd0d059b51936a0487634b456a8e9c3", "payment_method": "card_c60d4678a8bfbad42b495b3c3dcd0810", "payment_method_data": { "id": "card_c60d4678a8bfbad42b495b3c3dcd0810", "type": "fr_mastercard_card", "category": "card", "metadata": null, "image": "", "authentication_url": "", "webhook_url": "", "supporting_documentation": "", "name": "John Doe", "last4": "1111", "acs_check": "unchecked", "cvv_check": "unchecked", "bin_details": { "brand": null, "bin_number": "411111" }, "expiration_year": "23", "expiration_month": "11", "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467", "payment_account_reference": "V0010013018036782991622965076" }, "expiration": 1622554328, "captured": true, "refunded": false, "refunded_amount": 0, "receipt_email": "", "redirect_url": "", "complete_payment_url": "", "error_payment_url": "", "receipt_number": "", "flow_type": "", "address": null, "statement_descriptor": "Rapyd", "transaction_id": "", "created_at": 1621949528, "metadata": {}, "failure_code": "", "failure_message": "", "paid": true, "paid_at": 1621949528, "dispute": null, "refunds": null, "order": null, "outcome": null, "visual_codes": {}, "textual_codes": {}, "instructions": {}, "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4", "ewallets": [ { "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4", "amount": 200, "percent": 100, "refunded_amount": 0 } ], "payment_method_options": {}, "payment_method_type": "fr_mastercard_card", "payment_method_type_category": "card", "fx_rate": 1, "merchant_requested_currency": null, "merchant_requested_amount": null, "fixed_side": "", "payment_fees": null, "invoice": "", "escrow": null, "group_payment": "gp_119896e86cedd72e8bafbcf26968ea08", "cancel_reason": null, "initiation_type": "customer_present", "mid": "", "next_action": "not_applicable", "merchant_advice_code": null, "merchant_advice_message": null, "transaction_link_id": "A49sx-3Tm2Pk3dYv_PL0Rc" }, { "id": "payment_cc8c029e086acbd6d34eb0eb696c9804", "amount": 279, "original_amount": 279, "is_partial": false, "currency_code": "USD", "country_code": "US", "status": "CLO", "description": "", "merchant_reference_id": "", "customer_token": "cus_91be5f1b0f2dbb70c1d0509a1ae2351e", "payment_method": "card_8cc9838d5d1bf3b3843cd1b8aa585e19", "payment_method_data": { "id": "card_8cc9838d5d1bf3b3843cd1b8aa585e19", "type": "us_mastercard_card", "category": "card", "metadata": null, "image": "", "authentication_url": "", "webhook_url": "", "supporting_documentation": "", "name": "John Doe", "last4": "0414", "acs_check": "unchecked", "cvv_check": "unchecked", "bin_details": { "brand": null, "bin_number": "554672" }, "expiration_year": "23", "expiration_month": "11", "fingerprint_token": "ocfp_5f5a0376b98d8238064a232cc51f6f4e", "payment_account_reference": "V0010013018036782991622965076" }, "expiration": 1622553335, "captured": false, "refunded": false, "refunded_amount": 0, "receipt_email": "", "redirect_url": "", "complete_payment_url": "", "error_payment_url": "", "receipt_number": "", "flow_type": "", "address": null, "statement_descriptor": "Rapyd", "transaction_id": "", "created_at": 1621948535, "metadata": { "merchant_defined": true }, "failure_code": "", "failure_message": "", "paid": true, "paid_at": 1621948562, "dispute": null, "refunds": null, "order": null, "outcome": null, "visual_codes": {}, "textual_codes": {}, "instructions": [], "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4", "ewallets": [ { "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4", "amount": 279, "percent": 100, "refunded_amount": 0 } ], "payment_method_options": {}, "payment_method_type": "us_mastercard_card", "payment_method_type_category": "card", "fx_rate": 1, "merchant_requested_currency": null, "merchant_requested_amount": null, "fixed_side": "", "payment_fees": null, "invoice": "", "escrow": null, "group_payment": "", "cancel_reason": null, "initiation_type": "customer_present", "mid": "", "next_action": "not_applicable", "merchant_advice_code": null, "merchant_advice_message": null, "transaction_link_id": "E7iAc-7Sr5Nt7sPs_OX3Xy" } ] }
Bad Request - Date Range
curl -X get 'https://sandboxapi.rapyd.net/v1//payments?created_before=payment_eac0d2f27b85af17a018ec8b7ac2f504&created_after=payment_d31d3ca850419ab5e2f9f1a33f9c6eea' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "ERROR_QUERY_DATE_RANGE_EXCEEDS_90_DAYS", "status": "ERROR", "message": "The request included temporal query parameters for defining a date range, but the date range defined via the IDs of the objects exceeds 90 days. Corrective action: Create a query where the date range does not exceed 90 days.", "response_code": "ERROR_QUERY_DATE_RANGE_EXCEEDS_90_DAYS", "operation_id": "84c42872-b1a6-4267-a1c8-fc23e7c73660" } }
Bad Request - Query Mismatch
curl -X get 'https://sandboxapi.rapyd.net/v1//payments?ending_before=payment_eac0d2f27b85af17a018ec8b7ac2f504&created_after=payment_d31d3ca850419ab5e2f9f1a33f9c6eea' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "ERROR_LIST_PAYMENTS_PAYOUTS_QUERY_MISMATCH", "status": "ERROR", "message": "The request tried to list payments or payouts filtered with query parameters, but the query parameters were mutually incompatible. The request was rejected. Corrective action: Use any combination of 'created_before' and 'created_after' or any combination of 'ending_before' and 'starting_after'.", "response_code": "ERROR_LIST_PAYMENTS_PAYOUTS_QUERY_MISMATCH", "operation_id": "0f5563d7-e1f5-4eed-af0e-45553c8920b7" } }
Unauthorized
curl -X get 'https://sandboxapi.rapyd.net/v1/payments' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "UNAUTHENTICATED_API_CALL", "status": "ERROR", "message": "The request was rejected due to an authentication issue. Corrective action: Check the status of your account in the 'Account Details' page of the Client Portal.", "response_code": "UNAUTHENTICATED_API_CALL", "operation_id": "57fb0879-5474-49da-86d9-3cc5d1d212ec" } }