Get a list of payments
This method allows you to get a list of payments and their corresponding information.
- URL syntax: /api/v2/merchant/payments
- Method: GET
URL parameters
| Name | Type | Details | Mandatory | Description |
|---|---|---|---|---|
| amount | int | N | The amount of the payment. | |
| currency | string | [A-Z]3 | N | The currency of the payment (ISO-4217). |
| request_time_start | unix timestamp | N | The request start date from where you want to get the payments. | |
| request_time_end | unix timestamp | N | The request end date until where you want to get the payments. | |
| processing_time_start | unix timestamp | N | The processing start date from where you want to get the payments. | |
| processing_time_end | unix timestamp | N | The processing end date until where you want to get the payments. | |
| source | int | N | The Syspay source reference. | |
| reference | string | UNIQUE, [ -~]+ (max: 85 ascii printable characters) | N | The merchant payment identifier. |
| token_id | int | N | The token reference. | |
| status | string | N | The payment status. See Payment statuses. | |
| page | int | N | The results page number requested. |
Example requests
/api/v2/merchant/payments?currency=EUR&processing_time_start=1363957978&processing_time_end=1364389978
/api/v2/merchant/payments?reference=999
/api/v2/merchant/payments?amount=5000&status=SUCCESS&source=16
Response parameters
The response in this case is a List with potential Payment(s).
Example response
{
"class": "list",
"items_class": "payment",
"total_count": 4,
"pages": 1,
"page": 1,
"limit": 100,
"next_page": null,
"previous_page": null,
"data": [
{
"class": "payment",
"id": 246800,
"reference": "65ea33c6d2025",
"amount": 10000,
"currency": "EUR",
"status": "SUCCESS",
"preauth_expiration_date": null,
"action_url": null,
"flow": "API",
"processing_time": 1709847496,
"source": 2544,
"contract": "SysPay (8737476)",
"descriptor": "Test Contract",
"extra": null,
"description": null,
"account_id": 23918,
"merchant_id": 2744,
"merchant_login": "23918001",
"settlement_date": 1709847496,
"failure_category": null,
"chip_and_pin_status": null,
"capture_date": null,
"token": {
"class": "token",
"id": "83377",
"status": "ACTIVE",
"action_url": null,
"booking_id": "65eaf84d2694e",
"check_in_date": "2024-03-31",
"check_out_date": "2024-04-07",
"booking_details": {
"class": "booking_details",
"type": "HOTEL",
"booking_id": "65eaf84d2694e",
"check_in_date": "2024-03-31",
"check_out_date": "2024-04-07",
"total_booking_amount": "100000",
"booking_currency": "EUR"
},
"creation_date": "1709847486",
"expiration_date": "1712489805",
"description": "Booking 65ea33bc7446e from 2024-03-30 to 2024-04-06.",
"extra": "Array",
"customer": {
"class": "customer",
"email": "john.doe+65ea33bc72e00@gmail.com",
"language": "en",
"firstname": "John",
"lastname": "Doe",
"billing_address": {
"class": "billing_address",
"address1": "55 rue du Faubourg Saint-Honoré",
"address2": null,
"address3": null,
"city": "Paris",
"country": "FR",
"postal_code": "75008"
}
},
"payment_method": {
"class": "payment_method",
"type": "CREDITCARD",
"validation_status": "VALID",
"validation_date": "1709898064",
"invalid_reason": null,
"display": "4491-70xx-xxxx-4007",
"details": {
"class": "payment_method_details",
"fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
"holder": "Card Holder Name",
"scheme": "VISA",
"exp_month": "01",
"exp_year": "2025"
}
},
"moto_instance_id": null,
"mandate": {
"class": "mandate",
"status": "ACTIVE",
"currency": "EUR",
"end_reason": null,
"start_date": 1709847486,
"end_date": null
},
"payment": null,
"risk": {
"class": "risk",
"level": "MEDIUM",
"reason": null
}
},
"customer": {
"class": "customer",
"email": "john.doe+65ea33bc72e00@gmail.com",
"language": "en",
"firstname": null,
"lastname": null,
"billing_address": {
"class": "billing_address",
"address1": "55 rue du Faubourg Saint-Honoré",
"address2": null,
"address3": null,
"city": "Paris",
"country": "FR",
"postal_code": "75008"
}
},
"payment_method": {
"class": "payment_method",
"type": "CREDITCARD",
"validation_status": "VALID",
"validation_date": "1709898064",
"invalid_reason": null,
"display": "4491-70xx-xxxx-4007",
"details": {
"class": "payment_method_details",
"fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
"holder": "Card Holder Name",
"scheme": "VISA",
"exp_month": "01",
"exp_year": "2025"
}
},
"processor_reference": null,
"qr_code": null
},
{
"class": "payment",
"id": 246806,
"reference": "65ea38551bb46",
"amount": 10000,
"currency": "EUR",
"status": "SUCCESS",
"preauth_expiration_date": null,
"action_url": null,
"flow": "API",
"processing_time": 1709848662,
"source": 2544,
"contract": "SysPay (8737476)",
"descriptor": "Test Contract",
"extra": null,
"description": null,
"account_id": 23918,
"merchant_id": 2744,
"merchant_login": "23918001",
"settlement_date": 1709848662,
"failure_category": null,
"chip_and_pin_status": null,
"capture_date": null,
"token": {
"class": "token",
"id": "83377",
"status": "ACTIVE",
"action_url": null,
"booking_id": "65eaf84d2694e",
"check_in_date": "2024-03-31",
"check_out_date": "2024-04-07",
"booking_details": {
"class": "booking_details",
"type": "HOTEL",
"booking_id": "65eaf84d2694e",
"check_in_date": "2024-03-31",
"check_out_date": "2024-04-07",
"total_booking_amount": "100000",
"booking_currency": "EUR"
},
"creation_date": "1709847486",
"expiration_date": "1712489805",
"description": "Booking 65ea33bc7446e from 2024-03-30 to 2024-04-06.",
"extra": "Array",
"customer": {
"class": "customer",
"email": "john.doe+65ea33bc72e00@gmail.com",
"language": "en",
"firstname": "John",
"lastname": "Doe",
"billing_address": {
"class": "billing_address",
"address1": "55 rue du Faubourg Saint-Honoré",
"address2": null,
"address3": null,
"city": "Paris",
"country": "FR",
"postal_code": "75008"
}
},
"payment_method": {
"class": "payment_method",
"type": "CREDITCARD",
"validation_status": "VALID",
"validation_date": "1709898064",
"invalid_reason": null,
"display": "4491-70xx-xxxx-4007",
"details": {
"class": "payment_method_details",
"fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
"holder": "Card Holder Name",
"scheme": "VISA",
"exp_month": "01",
"exp_year": "2025"
}
},
"moto_instance_id": null,
"mandate": {
"class": "mandate",
"status": "ACTIVE",
"currency": "EUR",
"end_reason": null,
"start_date": 1709847486,
"end_date": null
},
"payment": null,
"risk": {
"class": "risk",
"level": "MEDIUM",
"reason": null
}
},
"customer": {
"class": "customer",
"email": "john.doe+65ea33bc72e00@gmail.com",
"language": "en",
"firstname": null,
"lastname": null,
"billing_address": {
"class": "billing_address",
"address1": "55 rue du Faubourg Saint-Honoré",
"address2": null,
"address3": null,
"city": "Paris",
"country": "FR",
"postal_code": "75008"
}
},
"payment_method": {
"class": "payment_method",
"type": "CREDITCARD",
"validation_status": "VALID",
"validation_date": "1709898064",
"invalid_reason": null,
"display": "4491-70xx-xxxx-4007",
"details": {
"class": "payment_method_details",
"fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
"holder": "Card Holder Name",
"scheme": "VISA",
"exp_month": "01",
"exp_year": "2025"
}
},
"processor_reference": null,
"qr_code": null
},
{
"class": "payment",
"id": 246831,
"reference": "65eaf7f2f0ced",
"amount": 10000,
"currency": "EUR",
"status": "SUCCESS",
"preauth_expiration_date": null,
"action_url": null,
"flow": "API",
"processing_time": 1709897715,
"source": 2544,
"contract": "SysPay (8737476)",
"descriptor": "Test Contract",
"extra": null,
"description": null,
"account_id": 23918,
"merchant_id": 2744,
"merchant_login": "23918001",
"settlement_date": 1709897716,
"failure_category": null,
"chip_and_pin_status": null,
"capture_date": null,
"token": {
"class": "token",
"id": "83377",
"status": "ACTIVE",
"action_url": null,
"booking_id": "65eaf84d2694e",
"check_in_date": "2024-03-31",
"check_out_date": "2024-04-07",
"booking_details": {
"class": "booking_details",
"type": "HOTEL",
"booking_id": "65eaf84d2694e",
"check_in_date": "2024-03-31",
"check_out_date": "2024-04-07",
"total_booking_amount": "100000",
"booking_currency": "EUR"
},
"creation_date": "1709847486",
"expiration_date": "1712489805",
"description": "Booking 65ea33bc7446e from 2024-03-30 to 2024-04-06.",
"extra": "Array",
"customer": {
"class": "customer",
"email": "john.doe+65ea33bc72e00@gmail.com",
"language": "en",
"firstname": "John",
"lastname": "Doe",
"billing_address": {
"class": "billing_address",
"address1": "55 rue du Faubourg Saint-Honoré",
"address2": null,
"address3": null,
"city": "Paris",
"country": "FR",
"postal_code": "75008"
}
},
"payment_method": {
"class": "payment_method",
"type": "CREDITCARD",
"validation_status": "VALID",
"validation_date": "1709898064",
"invalid_reason": null,
"display": "4491-70xx-xxxx-4007",
"details": {
"class": "payment_method_details",
"fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
"holder": "Card Holder Name",
"scheme": "VISA",
"exp_month": "01",
"exp_year": "2025"
}
},
"moto_instance_id": null,
"mandate": {
"class": "mandate",
"status": "ACTIVE",
"currency": "EUR",
"end_reason": null,
"start_date": 1709847486,
"end_date": null
},
"payment": null,
"risk": {
"class": "risk",
"level": "MEDIUM",
"reason": null
}
},
"customer": {
"class": "customer",
"email": "john.doe+65ea33bc72e00@gmail.com",
"language": "en",
"firstname": null,
"lastname": null,
"billing_address": {
"class": "billing_address",
"address1": "55 rue du Faubourg Saint-Honoré",
"address2": null,
"address3": null,
"city": "Paris",
"country": "FR",
"postal_code": "75008"
}
},
"payment_method": {
"class": "payment_method",
"type": "CREDITCARD",
"validation_status": "VALID",
"validation_date": "1709898064",
"invalid_reason": null,
"display": "4491-70xx-xxxx-4007",
"details": {
"class": "payment_method_details",
"fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
"holder": "Card Holder Name",
"scheme": "VISA",
"exp_month": "01",
"exp_year": "2025"
}
},
"processor_reference": null,
"qr_code": null
},
{
"class": "payment",
"id": 246835,
"reference": "65eb009a1a068",
"amount": 10000,
"currency": "EUR",
"status": "SUCCESS",
"preauth_expiration_date": null,
"action_url": null,
"flow": "API",
"processing_time": 1709899931,
"source": 2544,
"contract": "SysPay (8737476)",
"descriptor": "Test Contract",
"extra": null,
"description": null,
"account_id": 23918,
"merchant_id": 2744,
"merchant_login": "23918001",
"settlement_date": 1709899931,
"failure_category": null,
"chip_and_pin_status": null,
"capture_date": null,
"token": {
"class": "token",
"id": "83377",
"status": "ACTIVE",
"action_url": null,
"booking_id": "65eaf84d2694e",
"check_in_date": "2024-03-31",
"check_out_date": "2024-04-07",
"booking_details": {
"class": "booking_details",
"type": "HOTEL",
"booking_id": "65eaf84d2694e",
"check_in_date": "2024-03-31",
"check_out_date": "2024-04-07",
"total_booking_amount": "100000",
"booking_currency": "EUR"
},
"creation_date": "1709847486",
"expiration_date": "1712489805",
"description": "Booking 65ea33bc7446e from 2024-03-30 to 2024-04-06.",
"extra": "Array",
"customer": {
"class": "customer",
"email": "john.doe+65ea33bc72e00@gmail.com",
"language": "en",
"firstname": "John",
"lastname": "Doe",
"billing_address": {
"class": "billing_address",
"address1": "55 rue du Faubourg Saint-Honoré",
"address2": null,
"address3": null,
"city": "Paris",
"country": "FR",
"postal_code": "75008"
}
},
"payment_method": {
"class": "payment_method",
"type": "CREDITCARD",
"validation_status": "VALID",
"validation_date": "1709898064",
"invalid_reason": null,
"display": "4491-70xx-xxxx-4007",
"details": {
"class": "payment_method_details",
"fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
"holder": "Card Holder Name",
"scheme": "VISA",
"exp_month": "01",
"exp_year": "2025"
}
},
"moto_instance_id": null,
"mandate": {
"class": "mandate",
"status": "ACTIVE",
"currency": "EUR",
"end_reason": null,
"start_date": 1709847486,
"end_date": null
},
"payment": null,
"risk": {
"class": "risk",
"level": "MEDIUM",
"reason": null
}
},
"customer": {
"class": "customer",
"email": "john.doe+65ea33bc72e00@gmail.com",
"language": "en",
"firstname": null,
"lastname": null,
"billing_address": {
"class": "billing_address",
"address1": "55 rue du Faubourg Saint-Honoré",
"address2": null,
"address3": null,
"city": "Paris",
"country": "FR",
"postal_code": "75008"
}
},
"payment_method": {
"class": "payment_method",
"type": "CREDITCARD",
"validation_status": "VALID",
"validation_date": "1709898064",
"invalid_reason": null,
"display": "4491-70xx-xxxx-4007",
"details": {
"class": "payment_method_details",
"fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
"holder": "Card Holder Name",
"scheme": "VISA",
"exp_month": "01",
"exp_year": "2025"
}
},
"processor_reference": null,
"qr_code": null
}
]
}