With our API function ‘payment_search’ it is possible to search for a payment, you can search by a wide variety of ids or strings.
To get started please look at the code example here.
When you run the code by uploading the file to your server and navigate to it in your browser, you will see the following input form:
If you’re unsure how to fill in the form, please look at the table below:
The parameter names are written in italic. They are case sensitive.
TIP You can open the file with notepad, if you do not have an editor for viewing source code.
|Merchant Token (token)||You can get this token by logging into our admin portal at admin.yourpay.io and look under integration settings.|
|Search (search)||Your search query.|
|Method (method)|| use the method “all”|
More methods will be added.
On submit you will get a JSON response with the following data:
|PaymentID||Six digit identifier.|
|TransID||Ten digit identifier.|
|OrderID||The orderid set on the transaction.|
|merchantid||The merchantid which the payment was processed for.|
|cardtype||The cardtype used e.g. VISA, MasterCard. ‘2’ & ‘3’ is for VISA & ‘4’ is for MasterCard|
|currency||ISO-4217 code for the currency used in the transaction.|
|amount||The amount charged on the credit card.|
|cardno||The first six and last four digits of the card number.|
|cardprefix||The last 4 numbers of the card.|
|secure||‘1’ if the payment was processed with 3D Secure, ‘0’ otherwise.|
|time_registration||Unix timestamp of the moment the transaction was processed.|
|cardholder||The full name of the card owner, which is printed on the credit card.|
|platform||The platform used to pay with Yourpay.|
|completed_through||Confirms if the payment have been processed through 3D Secure|
|amount_captured||Amount captured on the payment.|
|time_captured||Unix timestamp of the moment the payment was captured.|
|time_refunded||Unix timestamp of the moment the payment was refunded.|
|amount_refunded||Amount refunded on the payment.|
|time_deleted||Unix timestamp of the moment the payment was deleted.|