Search payments
You can use this endpoint to search for payments you’ve previously created. Payments are sorted by date, with the most recently-created payment appearing first.
Query parameters
Returns payments with reference values exactly matching your specified value.
Returns payments with matching email values. You can send full or partial email addresses. email is the paying user’s email address.
Returns payments in a matching state. state reflects where a payment is in the payment status lifecycle.
Returns payments paid with a particular card brand.
Returns payments created on or after the from_date. Date and time must be coordinated Universal Time (UTC) and ISO 8601 format to second-level accuracy - YYYY-MM-DDThh:mm:ssZ.
Returns payments created before the to_date. Date and time must be coordinated Universal Time (UTC) and ISO 8601 format to second-level accuracy - YYYY-MM-DDThh:mm:ssZ.
Returns a specific page of results. Defaults to 1.
The number of payments returned per results page. Defaults to 500. Maximum value is 500.
Returns payments paid with cards under this cardholder name.
Returns payments paid by cards beginning with the first_digits_card_number value. first_digits_card_number value must be 6 digits.
Returns payments paid by cards ending with the last_digits_card_number value. last_digits_card_number value must be 4 digits.
Returns payments settled on or after the from_settled_date value. You can only search by settled date if your payment service provider is Stripe. Date must be in ISO 8601 format to date-level accuracy - YYYY-MM-DD. Payments are settled when your payment service provider sends funds to your bank account.
Returns payments settled before the to_settled_date value. You can only search by settled date if your payment service provider is Stripe. Date must be in ISO 8601 format to date-level accuracy - YYYY-MM-DD. Payments are settled when your payment service provider sends funds to your bank account.
Returns payments that were authorised using the agreement with this agreement_id. Must be an exact match.
Response
OK - your request was successful.
Example response
{
"_links": {
"first_page": {
"href": "https://an.example.link/from/payment/platform",
"method": "GET"
},
"last_page": {
"href": "https://an.example.link/from/payment/platform",
"method": "GET"
},
"next_page": {
"href": "https://an.example.link/from/payment/platform",
"method": "GET"
},
"prev_page": {
"href": "https://an.example.link/from/payment/platform",
"method": "GET"
},
"self": {
"href": "https://an.example.link/from/payment/platform",
"method": "GET"
}
},
"count": 20,
"page": 1,
"results": [
{
"_links": {
"cancel": {
"href": "https://an.example.link/from/payment/platform",
"method": "POST",
"params": {
"description": "This is a value for a parameter called description"
},
"type": "application/x-www-form-urlencoded"
},
"capture": {
"href": "https://an.example.link/from/payment/platform",
"method": "POST",
"params": {
"description": "This is a value for a parameter called description"
},
"type": "application/x-www-form-urlencoded"
},
"events": {
"href": "https://an.example.link/from/payment/platform",
"method": "GET"
},
"refunds": {
"href": "https://an.example.link/from/payment/platform",
"method": "GET"
},
"self": {
"href": "https://an.example.link/from/payment/platform",
"method": "GET"
}
},
"amount": 1200,
"card_brand": "Visa",
"card_details": {
"billing_address": {
"city": "address city",
"country": "GB",
"line1": "address line 1",
"line2": "address line 2",
"postcode": "AB1 2CD"
},
"card_brand": "Visa",
"card_type": "debit",
"cardholder_name": "Mr. Card holder",
"expiry_date": "04/24",
"first_digits_card_number": "123456",
"last_digits_card_number": "1234",
"wallet_type": "Apple Pay"
},
"corporate_card_surcharge": 250,
"created_date": "2016-01-21T17:15:00.000Z",
"description": "Your Service Description",
"email": "The paying user’s email address.",
"exemption": {
"outcome": {
"result": "honoured"
},
"requested": true,
"type": "corporate"
},
"fee": 5,
"language": "en",
"net_amount": 1195,
"payment_id": "hu20sqlact5260q2nanm0q8u93",
"payment_provider": "worldpay",
"provider_id": "reference-from-payment-gateway",
"reference": "your-reference",
"refund_summary": {
"amount_available": 100,
"status": "available"
},
"return_url": "http://your.service.domain/your-reference",
"settlement_summary": {
"capture_submit_time": "2016-01-21T17:15:00.000Z",
"captured_date": "2016-01-21",
"settled_date": "2016-01-21"
},
"state": {
"code": "P010",
"message": "User cancelled the payment",
"status": "created"
},
"total_amount": 1450
}
],
"total": 100
}