\n \nWelcome to Worldpay for Platforms REST API for online payment services.
\nOur API enables you to integrate your business software with worldpay for platforms payment processing and management solutions. Adhering to a RESTful architecture, it will give you fast, flexible and scalable integration.
\nWe make it easy for you to expand your business's capabilities with services such as transaction processing and reporting, payer record management and payment scheduling. You'll soon be able to accept one-off and recurring payments from credit/debit cards and bank debits, plus PayTo/PayID and BPAY in Australia and ACH in the USA.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4945012","collectionId":"6644ab8c-28f6-4eec-a9d9-436123feccc1","publishedId":"RWaC1BQ5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"A18CDE"},"publishDate":"2025-03-30T04:35:48.000Z"},"item":[{"name":"Getting Started","item":[],"id":"5e519f4a-1513-45cc-893a-0e80148463de","description":"There will be five stages to your integration with us:
\nDiscuss your requirements with our team
\nApply for your sandbox account and API credentials
\nDevelopment
\nCertification
\nProduction
\nSo to get started, talk to us about your business and technology requirements. Our team of payment specialists will ensure you have access to the solutions that meet your needs. They will also assist with your application for a sandbox account and API credentials.
\nAustralia: 1300 592 283
\nNew Zealand: 0800 480 054
\nOR by email:
\n\nIf you are operating in the United Kingdom contact our team by email:
\n\nFor Technical Integration Support:
\n\nA new version of the API will be issued for any breaking changes.
\nThe addition of new fields to request and response models are not considered breaking changes. New fields can therefore be added at any time.
\nPlease ensure that your result and model parsing software is able to handle the appearance of new fields.
\nAnywhere in documentation where you see the π symbol.
We are highlighting some additional information that will be important either during of after your integration. Please pay extra attention to these notes.
If you haven't done so yet, first look at the Getting Started section so you know what you're getting into, then contact us to apply for a sandbox (test) account. Once your application is approved, we'll send API credentials to your nominated contact email address. These will allow you to send us API requests that require authorization for your sandbox account only: different credentials are required for production (live) accounts, which are available only after your development is finished and has been certified by us.
\nYour Sandbox API credentials will consist of a user name (also known as the BusinessID) and a password.
You can use your sandbox details with the Run in Postman link above. Remember to set your language for the Examples.
The BusinessID is the same ID you pass to us through the POST LOGIN API call.
Both the username and password will change when you have live credentials.
Sandbox BusinessIDs are denoted by beginning with the number 9 - example '91000'.
Live Business IDs can begin with 1, 2, 3 or 4 - example '20000'.
Once you are ready to go live you will also receive a LIVE URL, that will need to replace the Sandbox URLs you test with.
\nurl: https://sandbox.rest.paymentsapi.io
\nurl-auth: https://sandbox.auth.paymentsapi.io
\nOnce you have finished development and testing, we will run a quick sign off with you.
Allowing you to demo your software and the touch between the two systems.
Once signed off we can provide live credentials and URLs.
\nPlease reach out to your Account Manager or customerintegration@worldpayforplatforms.com to schedule the integration sign off.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"28dfd0a4-6d97-45d5-a744-1c07410c87fb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3159d7ef-a033-43d0-9b93-29771a9380c2","type":"text/javascript","exec":[""]}}],"_postman_id":"5e519f4a-1513-45cc-893a-0e80148463de"},{"name":"π΄ PCI Compliance ","item":[],"id":"e519347a-a7b0-4622-9e17-fed5bd2dc364","description":"Every organisation that handles card payments must comply with the Payment Card Industry Data Security Standard (PCI DSS). Annual compliance is mandated by the payment card schemes and banks.
\nPCI DSS is a global standard, helping to protect cardholder data and tackle the growing threat of security breaches. It sets the operational and technical requirements for organisations handling card payments, and for software developers and manufacturers of payment applications and devices.
\nWorldpay for Platforms entire infrastructure is fully compliant with PCI DSS - we are certified at Level 1, the highest level of compliance. We are independently audited annually for compliance by qualified security assessors.
\nYour integration with us will need to comply with PCI DSS. To help you with your integration, any API requests that require PCI Compliance Level 1 are flagged throughout this documentation with the π΄ symbol. You will only be able to use these calls if you have AOC for PCI Compliance Level 1.
\nWhilst Worldpay for Platforms is PCI DSS compliant, if your organisation accepts card payments then it must also be fully compliant. Non-compliance could make you responsible for any losses through fraud, and you may also face considerable fines from the card schemes and banks.
\nThere are four levels of compliance, dependant on how many transactions you process in a year. Find out how your organisation can reach compliance at the PCI Security Standards Council website
\nOur team can also advise you on any aspect of your PCI DSS compliance - contact our Sales Team, and they may refer you to our Risk and Fraud Team for further advice.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c4b67544-a281-4967-98c7-b15f93c94e52","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c41fae19-c57b-4a58-ae1b-126c3ce02c1f","type":"text/javascript","exec":[""]}}],"_postman_id":"e519347a-a7b0-4622-9e17-fed5bd2dc364"},{"name":"API Responses","item":[],"id":"32c6d0dc-5a21-46fc-932c-17e0cf7ec094","description":"Succesful statuses are coded 200 or 201.
For non-successful statuses the API returns a stand error model in the response body with details of the error:
\n{\n \"errorCode\": string,\n \"errorMessage\": string,\n \"errorDetail\": string\n}\nFor more information refer to error model
\nBelow is a list of the HTTP status codes that this API can return.
\n| Status code | \nStatus type | \n
|---|---|
200 (OK) | \n The API call was successful. | \n
201 (OK created) | \n The API call was successful, and a new resource was created. | \n
400 (bad request) | \n There is a format or data error in the request that you submitted - see error model in response body for details. | \n
401 (unauthorised) | \n The authentication bearer token was missing, invalid or expired. | \n
403 (forbidden) | \n You tried to access a resource that your credentials are not authorized to access. | \n
404 (not found) | \n No resource was found matching the ID or reference you provided. | \n
409 (conflict) | \n Some functions require you to provide a unique reference to identify a new resource - this status will be returned when you provide a reference that is not unique when using one of these functions. | \n
429 (too many requests) | \n A small number of API functions can only be accessed a maximum number of times in a given time period. For all functions that have such a limit, the function description below will provide the details of what the limits are. | \n
500 (internal server error) | \n A temporary or unexpected fault occurred, you can try the request again at a later time. | \n
Use to authenticate your user details with the API and retrieve a bearer token that need to be included in the Authorization HTTP header of every API function call.
PLEASE NOTE: Each token expires in 1 hour, after which you will need to login to get a new token.
\nTo send us API requests that require authorization, your requests must include an HTTP Authorization header containing a Bearer token that you get from our authentication endpoint. You get this token by sending a Login request containing your API credentials. If authentication is successful, then the response to the Login request will contain the token value, lifetime in seconds, and token type; for example:
{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjM4NkM3N.....gs6yufdyfdiukgjfdsDD\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}\n\nNote that for clarity, the length of the access_token value shown above is much shorter than the actual length of Bearer tokens that you will get from our authentication endpoint.
Unlike your sandbox (test) account API credentials, Bearer tokens that you get from our authentication endpoint are valid for a short time only. This makes it much harder for someone else to impersonate you, but does mean that you need to request new Bearer tokens as older tokens expire.
This API uses Bearer Tokens for authentication.
\nPLEASE NOTE: All functions requiring an HTTP Authorization header containing a Bearer token MUST be called 'server side\" and CANNOT be called client side.
\nThe Login function is used to obtain a token. Once obtained, the token must be provided in the Authorization HTTP header of every API function call in the format: bearer xxxxxxxxxxxxx.
If the token is missing, invalid or expired, HTTP status 401 (Unauthorized) will be returned.
Each token expires in 1 hour, after which you will need to login to get a new token.
\nTokens can be up to 3000 characters long.
\nAll functions requiring an HTTP Authorization header containing a Bearer token will be flagged throughout this document with the π.
\nSandbox Auth URL =
https://sandbox.auth.paymentsapi.io
This quickstart guides you through building an example webpage to accept payment card details from payers.
\nThe system will tokenize the data on this page, it can be used to either add the card details entered to an existing payer. Or it can be used to Make a live card transaction against those details.
\nPOST Make a live tokenized card transaction π
\nIn the <head> element of your webpage, add a <script> tag to include the JavaScript that is used to tokenise payment card details. For the following, replace {{api-url}} with either the sandbox (test) or production (live) URL for the REST API, as appropriate:
<head>\n <script src=\"https://code.jquery.com/jquery-3.2.1.min.js\" integrity=\"sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4=\" crossorigin=\"anonymous\"></script>\n <script src=\"{{api-url}}/js/tokenize-card\"></script>\n</head>\n\nIn the <body> element of your webpage, add a <form> tag to contain the elements used to accept payment card details from payers. The <form> tag must include a data-integrapay attribute with a value of PaymentFormto allow the imported JavaScript to identify this element.
After the JavaScript has tokenised the payment card details, the <form> will be submitted automatically. This can be used to trigger further actions; for example, causing the payer's web browser to navigate to the URL specified for the action attribute (for the following, replace {{action-url}} with your own URL):
<body>\n <form data-integrapay=\"PaymentForm\" method=\"POST\" action=\"{{action-url}}\">\n </form>\n</body>\n\nAs well as tokenising the payment card details, the JavaScript will clear the elements used to accept the card number and security code (CCV/CVV) values. This helps to reduce your PCI compliance obligations by ensuring that your web server does not receive confidential information about payment cards.
\nIn the <form> element, add a hidden <input> tag to specify the BusinessKeyof the organisation for which the payment card details are to be tokenised. The business key is a \"public\" identifier that allows the tokenisation to occur without prior authentication; the tokenised details can only be accessed with authentication and authorisation.
The <input> tag must include a data-integrapay attribute with a value of BusinessKeyto allow the imported JavaScript to identify this element. For the following, replace {{business-key}} with the business key for the organisation:
<input data-integrapay=\"BusinessKey\" type=\"hidden\" value=\"{{business-key}}\" />\n\nPlease note the BusinessKey aka BusinessGUID can be obtained using the Check your business details call. This will change when changed over to the Live system.
\nIn the <form> element, add a hidden <input> tag as a placeholder for the token that is created when the JavaScript tokenises the payment card details. The <input> tag must include a data-integrapay attribute with a value of CardToken to allow the imported JavaScript to identify this element.
After the JavaScript has tokenised the payment card details, the value attribute of the <input> tag will contain the token for the card. To access the token, either specify an id attribute for the <input> tag and read it using your own JavaScript, or specify a name attribute to include the token as a parameter when the <form> is submitted, as follows:
<input data-integrapay=\"CardToken\" name=\"CardToken\" type=\"hidden\" />\n\nIn the <form> element, add text <input> tags to accept cardholder name, card number and security code (CCV/CVV) values, and <select> tags to accept card expiry month and year values. For each of the <input> tags, include an autocomplete attribute with a value of off to help avoid the accidental storage of confidential information about payment cards, which in turn helps to reduce your PCI compliance obligations.
The <input> and <select> tags must include a data-integrapay attribute to allow the imported JavaScript to identify them, as follows:
After the JavaScript has tokenised the payment card details, it will clear the elements used to accept the card number and security code values. To access the values of the other elements, either specify an id attribute for the tags and read them using your own JavaScript, or specify a name attribute for the tags to include them as parameters when the <form> is submitted, as follows:
<input data-integrapay=\"CardName\" name=\"CardName\" type=\"text\" autocomplete=\"off\" />\n<input data-integrapay=\"CardNumber\" type=\"text\" autocomplete=\"off\" />\n<select data-integrapay=\"CardExpiryMonth\" name=\"CardExpiryMonth\">\n card expiry month options \n</select>\n<select data-integrapay=\"CardExpiryYear\" name=\"CardExpiryYear\">\n card expiry year options \n</select>\n<input data-integrapay=\"CardCcv\" type=\"text\" autocomplete=\"off\" />\n\nIn the <select> element for the card expiry month, add an <option> tag for each calendar month that includes a <value> attribute with a value of the month number as two digits left-padded with zero, from 01 for January to 12 for December. The display text for each <option> is your choice, but we recommend using either the two-digit month number, as appears on payment cards, or an abbreviated month name, as follows:
<select data-integrapay=\"CardExpiryMonth\" name=\"CardExpiryMonth\">\n <option value=\"01\">Jan</option>\n <option value=\"02\">Feb</option>\n <option value=\"03\">Mar</option>\n <option value=\"04\">Apr</option>\n <option value=\"05\">May</option>\n <option value=\"06\">Jun</option>\n <option value=\"07\">Jul</option>\n <option value=\"08\">Aug</option>\n <option value=\"09\">Sep</option>\n <option value=\"10\">Oct</option>\n <option value=\"11\">Nov</option>\n <option value=\"12\">Dec</option>\n</select>\n\nIn the <select> element for card expiry year, add an <option> tag for each of the next five or more years, starting with the current year, that includes a value attribute of the year as four digits. The display text for each <option> is your choice, but we recommend using the four-digit year, as follows (at the time of writing, the year was 2018):
<select data-integrapay=\"CardExpiryYear\" name=\"CardExpiryYear\">\n <option value=\"2018\">2018</option>\n <option value=\"2019\">2019</option>\n <option value=\"2020\">2020</option>\n <option value=\"2021\">2021</option>\n <option value=\"2022\">2022</option>\n</select>\n\nIn the <form> element, add a <div> tag to contain the error indicator that is used to notify the payer if any problems occur while the JavaScript tokenises the payment card details. The <div> tag must include a data-integrapay attribute with a value of Errors to allow the imported JavaScript to identify this element.
Note that if payers are notified about problems that occurred during the tokenisation process, then the <form> is not submitted automatically by the JavaScript. This allows payers a chance the fix the problem and try again.
<div class='preserveHtml' class='preserveHtml' data-integrapay=\"Errors\"></div>\n\nIn the <form> element, add a <div> tag to contain the progress indicator that is displayed while the JavaScript tokenises the payment card details. The <div> tag must include a data-integrapay attribute with a value of Processing to allow the imported JavaScript to identify this element.
The process of tokenising the payment card details includes asynchronous communication between the payer's web browser and IntegraPay web services. This can take a few moments to complete, so a progress indicator is displayed automatically to let payers know that your webpage is busy, not broken.
\n<div class='preserveHtml' class='preserveHtml' data-integrapay=\"Processing\"></div>\n\nIn the <form> element, add a <button> tag to allow payers to submit their credit card details for tokenisation. The <button> tag must include a data-integrapay attribute with a value of SubmitButton to allow the imported JavaScript to identify this element.
To allow the JavaScript to tokenise the credit card details before the <form> is submitted, the <button> tag must include a type attribute with a value of button; not a value of submit. If the wrong value is specified, then tokenisation will not occur and your web server will receive confidential information about payment cards, raising your PCI compliance obligations.
The display text for the <button> is your choice, but should be chosen to indicate the purpose for which the tokenised payment card details will be used. For example, if the next action taken by your website is to process a payment using the tokenised details, then we suggest using Process Payment for the display text, as follows:
<button data-integrapay=\"SubmitButton\" type=\"button\">Process Payment</button>\n\nReturns a payer/customer's BPAY Customer Reference Number (CRN) if they have one assigned to your Business.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
Assigns a BPAY Customer Reference Number (CRN) to a Customer within your business.
\nIf the customer already has a BPAY CRN assigned then it will be returned and no new assignment will occur.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
Empty
\nCan be used for searching all BPAY CRNs that have been assigned to your business. A maximum of 200 payers can be returned in one call (see skip/take parameters below).
\nThis function can be used to generate and assigned a new BPAY CRN or iCRN.
\nDepending on what options you choose the CRN can be linked to a payer, a single transaction, or to an invoice in one of the accounting systems that are integrated with our platform.
This method will also allow for restricting an iCRN by date, amount or both.
If a BPAY CRN has previously been assigned for the reference/invoice you have specified, the previous CRN will be returned.
\nThe restrict to date has a maximum of 365 days in the future.
\nYour βRestrictionβ option, date, amount or date and amount is defined by the BPay account. You will only be able to use one option.
Please contact your account manager for further details.
BPay have branding guidelines on how the BPAY and BPAY View logos and word marks need to appear in various mediums, please refer to their documentation here: BPAY Branding Guide
\n","event":[{"listen":"prerequest","script":{"id":"669778cc-332b-40bf-aa13-1d1ff5e2cfd5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e114f5df-6b4d-42cd-8fa7-21ac73890c58","type":"text/javascript","exec":[""]}}],"_postman_id":"8a11ff7c-6a9e-4427-bb07-d7acc957b49b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"BSB Search","item":[{"name":"BSBsπ","id":"e1b726cd-d229-483d-a149-bd823adabbba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/bsbs/{{country}}/{{BSB}}","description":"| Parameter | \nDescription | \n
|---|---|
country | \n 3-digit ISO country code for the country in which the account is registered | \n
bsb | \n Bank account branch identifier (e.g. BSB) | \n
Used for searching bank details, such as name and address, based on a BSB number.
\nThis data is currently only available in AUS and NZL.
\n","event":[{"listen":"prerequest","script":{"id":"b62c8613-bc23-43f1-8767-837f9e05e9b4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"35d961cc-b837-4c19-a6d4-f9d51e096e85","type":"text/javascript","exec":[""]}}],"_postman_id":"c9c9822c-7e11-4efc-95d0-b39455b0865a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Business Details","item":[{"name":"your business details π","id":"5c874aef-7bcc-40bf-9eef-d043de71c35a","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/businesses/{{business-id}}/status","description":"This function has two purposes:\nIt can be used as a way to check that your computer has an open communication path to the web service and is able to reach it.\nIt can also be used to check that the username/password you are using is for the correct business.
\n","event":[{"listen":"prerequest","script":{"id":"75067f27-3491-4929-b8d4-91cded70c74d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"05bd2ab2-ac81-43ba-b375-e42b9f3512e9","type":"text/javascript","exec":[""]}}],"_postman_id":"ef5e00cb-574d-4bac-81b2-8cb5160da136","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Card Bin Search","item":[{"name":"card issuer information π","id":"b4ce4092-d3a0-4333-8103-97084fb7027e","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/card-bins/{{card-bin}}","description":"The first 6-digits of a credit card number is known as the Bank Identification Number (BIN). This function allows you to pass in a BIN number to obtain information on the card type and the bank and country who issued it.
\nThis data is provided to us on a regular basis. We will update this data as often as possible, but be aware that we do not guarantee the accuracy of all the data.
\n\n","urlObject":{"path":["card-bins","{{card-bin}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7cf6f3ef-d2a4-4f9c-91ff-4ae39b331f80","name":"Get Card BIN","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/card-bins/{{card-bin}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"CF-RAY","value":"44e2f925ecd55db4-BNE","name":"CF-RAY","description":"Custom header"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 22 Aug 2018 05:34:56 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"","name":"Expect-CT","description":"Custom header"},{"key":"Server","value":"cloudflare","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"paymentsapi.io","path":"/","secure":true,"value":"d3b8e3dd4bb4fe1dc774d59b03dd0a2a61532998355","key":"__cfduid"}],"responseTime":null,"body":"{\"cardBin\":434404,\"countryID\":\"AUS\",\"cardBrand\":\"VISA\",\"cardType\":\"CREDIT\",\"cardCategory\":\"\",\"bank\":\"ANZ - AUSTRALIA AND NEW ZEALAND BANKING GROUP\"}"}],"_postman_id":"b4ce4092-d3a0-4333-8103-97084fb7027e"}],"id":"85208acf-06ec-42de-bff1-4a87965478c4","_postman_id":"85208acf-06ec-42de-bff1-4a87965478c4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Invoices","item":[{"name":"Add / Remove Invoice","item":[{"name":"Add a new invoice π","id":"ff5de848-f763-4f23-bf93-3473959a765c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"invoiceId\": \"48624a42-5ec3-46b4-a4c1-27e29dc00b04\",\n \"invoiceNumber\": \"INV-001\",\n \"orderNumber\": \"ORD-001\",\n \"date\": \"2025-01-12\",\n \"dueDate\": \"2025-01-30\",\n \"lines\": [\n \"Goods and/or services\",\n \"listed on invoice INV-001\"\n ],\n \"amount\": 100.00,\n \"url\": \"https://platforms.worldpay.com/en/\",\n \"payer\": {\n \"familyOrBusinessName\": \"Smith\",\n \"givenName\": \"John\",\n \"email\": \"support@example.com\",\n \"phone\": \"07 3040 4320\",\n \"mobile\": \"0412 345 678\",\n \"billingAddress\": {\n \"line1\": \"Level 1, Building 2\",\n \"line2\": \"2 Clunies Ross Court\",\n \"suburb\": \"Eight Mile Plains\",\n \"state\": \"Qld\",\n \"postCode\": \"4113\",\n \"country\": \"Australia\"\n }\n }\n}"},"url":"{{url}}/businesses/{{business-id}}/invoices","description":"Adds a new invoice to the system.
\nNot Idempotent - returns an error if an invoice with the same InvoiceId already exists.
| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
Voids an existing invoice in the system.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
invoice-id | \n The GUID that identifies the invoice | \n
Regardless of if you are creating a new payer or referencing an existing payer, all requests must include at least an Invoice Number, Order Number, Lines and Amount. See Invoice Input Model
For more details on new and existing players see: Payers
\nInvoiceId Is an optional GUID that uniquely identifies the invoice. If this value is not specified, a new GUID will be assigned to the invoice automatically.
Request with new payer:
\n{\n \"invoiceId\": \"1284D7F6-C6C4-4567-B66F-263836F5507A\",\n \"invoiceNumber\": \"INV-001\",\n \"orderNumber\": \"ORD-001\",\n \"date\": \"2018-06-12\",\n \"dueDate\": \"2018-06-12\",\n \"lines\": [\n \"Goods and/or services\",\n \"listed on invoice INV-001\"\n ],\n \"amount\": 10.00,\n \"url\": \"https://platforms.worldpay.com/en/\",\n \"payer\": {\n \"familyOrBusinessName\": \"Smith\",\n \"givenName\": \"John\",\n \"email\": \"noreply@worldpayforplatforms.com.au\",\n \"phone\": \"07 3040 4320\",\n \"mobile\": \"0412 345 678\",\n \"billingAddress\": {\n \"line1\": \"Level 1, Building 2\",\n \"line2\": \"2 Clunies Ross Court\",\n \"suburb\": \"Eight Mile Plains\",\n \"state\": \"Qld\",\n \"postCode\": \"4113\",\n \"country\": \"Australia\"\n }\n }\n}\n\nRequest with existing payer:
\n{\n \"invoiceId\": \"1284D7F6-C6C4-4567-B66F-263836F5507A\",\n \"invoiceNumber\": \"INV-001\",\n \"orderNumber\": \"ORD-001\",\n \"date\": \"2018-07-31\",\n \"dueDate\": \"2018-10-12\",\n \"lines\": [\n \"Goods and/or services\",\n \"listed on invoice INV-001\"\n ],\n \"amount\": 10.00,\n \"url\": \"https://platforms.worldpay.com/en/\",\n \"payer\": {\n\"UniqueReference\": \"P1-UNIQUE-REF\"\n }\n}\n\nThe result is indicated by the response HTTP status code: 201 (Created) indicates that the Invoice was added successfully.
Returns information of a specific invoice
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
invoice-reference | \n The GUID that identifies the invoice | \n
Used for searching all previously added invoices. A maximum of 200 invoices can be returned in one call (see skip/take parameters below).
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
invoiceId | \n guid | \nThe GUID that identifies the invoice | \n
invoiceNumber | \n string | \nThe invoice number | \n
invoiceStatus | \n Invoice Status Code | \nSearch based on the current status of the invoice | \n
statusTimeFrom | \n ISO 8601 Date/Time | \nSearch for invoice status changes on or after this date/time | \n
statusTimeTo | \n ISO 8601 Date/Time | \nSearch for invoice status changes on or before this date/time | \n
skip | \n integer | \nNumber of records to not return (offset) when paging results (Default: 0) | \n
take | \n integer | \nNumber of records to return per call when paging results (Default: 200) | \n
Invoices allow for generation of a payment reminder URL, this can then be embedded in an email and sent to a client. The email holds the \"Pay Now\" button, that links to the hosted page for secure payments.
\nThe invoices can remain in the system with multiple statuses including Pending, Over Due and Paid.
\n","event":[{"listen":"prerequest","script":{"id":"8f32974c-fd53-4d21-8ee9-f7d796fb6895","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e03c0c10-b9f4-48fe-b190-63b97f71f715","type":"text/javascript","exec":[""]}}],"_postman_id":"2b5ce691-5ec4-4724-b70c-50664ba80236","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Payers","item":[{"name":"Add and Edit a Payer","item":[{"name":"Add a new Payer π","id":"18425722-4aa3-45cf-9b28-65926620bf32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UniqueReference\": \"P1-UNIQUE-REF\",\r\n \"GroupReference\": \"P1-UNIQUE-REF\",\r\n \"FamilyOrBusinessName\": \"Citizen\",\r\n \"GivenName\": \"Jane\",\r\n \"Email\": \"support@example.com\",\r\n \"Phone\": \"0733332222\",\r\n \"Mobile\": \"0411228833\",\r\n \"Address\": {\r\n \"Line1\": \"1 Test St\",\r\n \"Line2\": \"Test Bulding\",\r\n \"Suburb\": \"Testville\",\r\n \"State\": \"QLD\",\r\n \"PostCode\": \"4001\",\r\n \"Country\": null\r\n },\r\n \"ExtraInfo\": {\r\n \"XeroAutoDebitEnabled\": false,\r\n \"SalesforceAutoDebitEnabled\":false\r\n },\r\n \"Audit\": {\r\n \"Username\": \"Example-User\",\r\n \"UserIP\": \"1.2.3.4\"\r\n }\r\n }"},"url":"{{url}}/businesses/{{business-id}}/payers","description":"Adds a new payer to the system.
\nNot Idempotent - returns an error if a payer with the same unique reference already exists.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
Updates the payer with the given unique reference with the details provided.
\nIdempotent - if a payer with the unique reference doesn't exist it will be created.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
Allows you to change the processing status of an existing payer. It can be used to set a payer to Active, Suspended or Cancelled statuses.
\nSome statuses are restricted due to processing reasons, so some statues will not be able to be changed by using this function.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
Used to save a bank account to the given payer for use with scheduled debits.
\nA payer can only have one payment method account - calling this function will replace any existing bank account or card attached to this payer with the new bank account.
\nIdempotent - if the payer already has a payment method it will be replaced, otherwise a new account will be added.
\nπ If there is no transaction on saved payment details for 12 months, the payer status will be changed to βCancelled β cancelled due to inactivity β. 1 month after this (13 months total), payment details will be removed. After 12 months transactions will not be possible unless Payer Status is changed.
\nPlease note if using this call as part of electronic Direct Debit Request (eDDR) or to update bank details please review compliance documentation here.
\n| Parameter | Description |
|---|---|
business-id | The business you want to access |
payer-reference | Your unique reference that identifies the payer |
π΄ WARNING: This endpoint is marked for Depreciation. As part of the alignment with the CIT/MIT framework, this endpoint will not be available moving forward and is marked for Depreciation. The API replacing this request is the existing POST Make a live card transaction API.π΄
\nUsed to save a credit/debit card account to the given payer for use with scheduled debits and/or real-time payments.
A payer can only have one payment method account - calling this function will replace any existing bank account or card attached to this payer with the new card.
Idempotent - if the payer already has a payment method it will be replaced, otherwise a new account will be added.
π If there is no transaction on saved payment details for 12 months, the payer status will be changed to βCancelled β cancelled due to inactivity β. 1 month after this (13 months total), payment details will be removed. After 12 months transactions will not be possible unless Payer Status is changed.
π~~~~Note - This API request is not enabled by default unless your system is PCI Level 1. To confirm your system is PCI Level 1 you will need to supply an AOC (Attestation of Compliance) for our Risk team to review and approve this API for development and integration. This API request is also not applicable for integrations in the United Kingdom due to the card on file compliance regulations. To update card details for a payer, a transaction must be processed which can be completed through a Zero-Dollar Authentication transaction request or a value transaction payment.
π΄ WARNING: This request can directly accept payment card details. If you do so, then your integration CANNOT be certified unless your system is PCI DSS complaint. See the PCI Compliance section for more details π΄
| Parameter | Description |
|---|---|
business-id | The business you want to access |
payer-reference | Your unique reference that identifies the payer |
π΄ WARNING: This endpoint is marked for Depreciation. As part of the alignment with the CIT/MIT framework, this endpoint will not be available moving forward and is marked for Depreciation. The API replacing this request is the existing POST Make a live tokenised card transaction API.π΄
\nThis endpoint is used for our \"Add To Vault\" service which works in conjunction with our JavaScript-based card tokenization functions to give you the ability to attach a card to one of your existing payers without the sensitive card information passing through your servers, which frees you from a significant portion of the PCI Compliance obligations.
To use this function simply send through the Token you receive when the payment details form that you have wired-up with our JavaScript library is posted-back to your server.
π If there is no transaction on saved payment details for 12 months, the payer status will be changed to βCancelled β cancelled due to inactivity β. 1 month after this (13 months total), payment details will be removed. After 12 months transactions will not be possible unless Payer Status is changed.
π~~~~Note - This API request is not applicable for integrations in the United Kingdom due to the card on file compliance regulations. To update card details for a payer, a transaction must be processed which can be completed through a Zero-Dollar Authentication transaction request or a value transaction payment.
A payer can only have one payment method account - calling this function will replace any existing bank account or card attached to this payer with the new card.
| Parameter | Description |
|---|---|
business-id | The business you want to access |
payer-reference | Your unique reference that identifies the payer |
Card Payer Account Token Model
\nThis function allows you to add a new payer record or update the details of an existing one. Whether a new payer is added or an existing one is updated is determined by the value you provide for the \"payerUniqueID\" parameter. If a payer with this ID already exists within our database for your business then their details will be updated, and if not a new payer record will be added.
\nNOTE - The minimum information that should be requested and provided when creating a payer record is, First Name, Last Name and Email Address. For integrations that are processing in the UK, to align with the UK requirements, along with the First Name, Last Name and Email Address, an Address is also mandatory.
\nEach time you add a new payer, you must assign them a UniqueReference value that identifies them uniquely within your account. We are not able to do this for you. Whenever possible, we recommend assigning the same unique identifier that you use to identify the payer within your own system. If you cannot use your own unique identifier, then we recommend generating a new GUID value.
As well as a UniqueReference value that must be unique, you can also assign a GroupReference value that can be the same for two or more payers. You can use this to group together payers and retrieve them all at once; for example, by sending us a Payer Search request. One common use of this feature is to support individual payers who have saved multiple payment methods; for example two or more payment cards and/or bank accounts. By adding new payers with different UniqueReference values but the same GroupReference value, you can retrieve a list of all the saved payment methods for that individual, allow them to select one, and then accept a payment using the UniqueReference associated with the selected payer.
We do not distinguish between individual and business payers, but to promote consistency the Payer Input Model that is used to add new payers accepts FamilyOrBusinessName and GivenName values.
For a new business payer, specify the business name as FamilyOrBusinessName and do not specify the GivenName value; for example:
{\n ...\n \"FamilyOrBusinessName\": \"Citizen\",\n ...\n}\n\nFor a new individual payer, specify their surname as FamilyOrBusinessName and their given name as the GivenName value; for example, for Jane A Citizen:
{\n ...\n \"FamilyOrBusinessName\": \"Citizen\",\n \"GivenName\": \"Jane\",\n ...\n}\n\nUse the Bearer token to send us an authorized POST Add a new Payer request containing the details of the payer. It must include at least a UniqueReference and the FamilyOrBusinessName; whenever possible, we recommend also including an Email address, and a Phone and/or Mobile phone number; for example:
{\n \"UniqueReference\": \"PAYER-1\",\n \"FamilyOrBusinessName\": \"Citizen\",\n \"Email\": \"support@example.com\",\n \"Phone\": \"07 3040 4320\"\n}\n\nIf you do not specify a value for GroupReference explicitly, then it will be initialized automatically to match the UniqueReference value.
The result is indicated by the response HTTP status code: 200 (OK) indicates that the new payer was added successfully. The Payer ID Model object that comprises the response body contains both the UniqueReference that you specified and our specific PayerID for cross-referencing purposes only: it cannot be used when you send us API requests to specify payers.
If a Payer has no payments for 365 days, their status will be changed from \"Active\" to \"Cancelled due to inactivity\", they will then remain in the system for a further 30 days, after which their payment methods will be permanently deleted. Unless their account is reactivated.
\n","event":[{"listen":"prerequest","script":{"id":"6424d30d-caa4-426c-a9b9-99224f287b68","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"266a7675-85bd-4714-b4e9-54fa36004c72","type":"text/javascript","exec":[""]}}],"_postman_id":"f8f85ea3-ba5f-4561-ab6c-33bbc0ba844d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Delete a Payer","item":[{"name":"Remove a Payers payment methods π","id":"610c7cc9-cbc5-40cd-a3bd-764cc67d1cd3","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/businesses/{{business-id}}/payers/{{payer-reference}}/accounts","description":"Removes all bank accounts or cards from the given payer. Note this will only remove the payment details. NOT the payer themselves.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
username | \n string(50) | \nFor auditing purposes - Name/reference of a user, or process identifier, from your system which initiated the API call | \n
userIP | \n string(20) | \nFor auditing purposes - IP address of the user or process from your system which initiated the API call | \n
Returns information of a specific payer
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
Used for searching all previously added payers. A maximum of 200 payers can be returned in one call (see skip/take parameters below).
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
payerId | \n string | \nSearch on our unique payer ID | \n
uniqueReference | \n string | \nSearch on the unique reference you set for the payer | \n
groupReference | \n string | \nSearch on the group reference you set for the payer | \n
familyOrBusinessName | \n string | \nSearch on the family/last name or business name of the payer | \n
givenName | \n string | \nSearch on the given/first name of the payer | \n
email | \n Email Address | \nSearch on the email address of the payer | \n
phone | \n Phone Number | \nSearch on the phone number of the payer | \n
mobile | \n Phone Number | \nSearch on the mobile (cell) phone number of the payer | \n
status | \n Payer Status Code | \nSearch based on the current processing status of the payer (single or list - for lists reference the field multiple times in the querystring, e.g.: ?status=A&status=S&status=C-SPS etc.) | \n
createdFrom | \n ISO 8601 Date/Time | \nSearch for payers added on or after this date/time | \n
createdTo | \n ISO 8601 Date/Time | \nSearch for payers that have had a change to their status occur before this date/time | \n
statusChangeFrom | \n ISO 8601 Date/Time | \nSearch for payers that have had a change to their status occur on or after this date/time. | \n
statusChangeTo | \n ISO 8601 Date/Time | \nSearch for payers that have had a change to their status occur on or before this date/time. | \n
skip | \n integer | \nNumber of records to not return (offset) when paging results (Default: 0) | \n
take | \n integer | \nNumber of records to return per call when paging results (Default: 200) | \n
Returns details of any accounts attached to the given payer
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
This function is used to lookup the details of existing payers.
\n","event":[{"listen":"prerequest","script":{"id":"85c6494b-fabb-46dc-858d-3b4b578057a2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"651f1613-fbd9-4c4c-b7d1-19112ecb7e99","type":"text/javascript","exec":[""]}}],"_postman_id":"bfb569d2-1858-4510-a97a-c9e6802d8a87","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}}],"id":"982c68a0-bd3b-45d6-afc4-ae2de24cc3f9","event":[{"listen":"prerequest","script":{"id":"8e2155e3-4d2d-4831-967d-a4c38fa324b1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0c9b6a26-1944-423c-8097-261b46ae1675","type":"text/javascript","exec":[""]}}],"_postman_id":"982c68a0-bd3b-45d6-afc4-ae2de24cc3f9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Reports","item":[{"name":"Run the Settlements Report π","id":"04469543-ac31-42d9-a618-2177541d2800","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/businesses/{{business-id}}/reports/settlements/?timeFrom=2025-01-20T00:00:12%2B10:00&timeTo=2025-01-25T23:59:00%2B10:00'","description":"This function can be used to obtain information about your settlement payments. It includes listing all transactions, fees and miscellaneous items that make up the settlement, with each amount that was added to, and deducted from, your settlement.
\nThe function requires you to specify a date range via the querystring to search settlements for. The date range allows you to specify a time with time zone to search settlements relative to dates in your country. \nTo search for settlements a single day include time range from 12:00am to 11:59pm, e.g.:
\n?timeFrom=2018-07-08T00:00:00+10:00&timeTo=2018-07-08T23:59:00+10:00
Searching with a date range of more than 31 days is not supported.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
timeFrom* | \n ISO 8601 Date/Time | \nSearch for settlements processed from this date/time. | \n
timeTo* | \n ISO 8601 Date/Time | \nSearch for settlements processed on or before this date/time. | \n
* Required
\nThis function can be used to obtain detailed information about your settlement payments. It is similar to the above Settlement Report function, however, this one provides a further level of breakdown whereby it lists each item associated with settled transactions (such as fees) separately.
\nThe function requires you to specify a date range via the querystring to search settlements for. The date range allows you to specify a time with time zone to search settlements relative to dates in your country. \nTo search for settlements a single day include time range from 12:00am to 11:59pm, e.g.:
\n?timeFrom=2018-07-08T00:00:00+10:00&timeTo=2018-07-08T23:59:00+10:00
Searching with a date range of more than 31 days is not supported.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
timeFrom* | \n ISO 8601 Date/Time | \nSearch for settlements processed from this date/time. | \n
timeTo* | \n ISO 8601 Date/Time | \nSearch for settlements processed on or before this date/time. | \n
* Required
\nAdds a single payment to the default schedule for an existing payer that will be processed at a future time. If the payer does not have a processing status of ACTIVE on the scheduled date, then the payment will not be processed. See the Change a Payers status request for more details.
There is a limit of 25 transactions, per Payer, per day.
\nWhenever possible, we recommend keeping your system simple and efficient by using only the default schedule for payers. However, there are some scenarios that require payers to have multiple schedules, each having a different set of future payments. To allow this, the URL above supports the inclusion of an optional schedule-reference route, as follows:
.../schedules/{{schedule-reference}}/payments
If you think that you might require payers to have multiple schedules, then we ask that you first contact us to discuss your requirements before using this feature. We'll try our best to keep your system as simple and efficient as we can!
\nAdds multiple payments to the default schedule for an existing payer that will be processed at a future time. If the payer does not have a processing status of ACTIVE on the scheduled date, then the payment will not be processed. See the Change a Payers status request for more details.
Whenever possible, we recommend keeping your system simple and efficient by using only the default schedule for payers. However, there are some scenarios that require payers to have multiple schedules, each having a different set of future payments. To allow this, the URL above supports the inclusion of an optional schedule-reference route, as follows:
.../schedules/{{schedule-reference}}
If you think that you might require payers to have multiple schedules, then we ask that you first contact us to discuss your requirements before using this feature. We'll try our best to keep your system as simple and efficient as we can!
\nDeletes a single payment that is currently scheduled for this payer based on our unique scheduled payment ID.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
scheduled-payment-id | \n Our unique ID of the payment that you wish to look up information of | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
username | \n string | \nFor auditing purposes - Name/reference of a user, or process identifier, from your system which initiated the API call | \n
userIP | \n string | \nFor auditing purposes - IP address of the user or process from your system which initiated the API call | \n
Deletes all payments currently scheduled for this payer
\nWhenever possible, we recommend keeping your system simple and efficient by using only the default schedule for payers. However, there are some scenarios that require payers to have multiple schedules, each having a different set of future payments. To allow this, the URL above supports the inclusion of an optional schedule-reference route, as follows:
.../schedules/{{schedule-reference}}
If you think that you might require payers to have multiple schedules, then we ask that you first contact us to discuss your requirements before using this feature. We'll try our best to keep your system as simple and efficient as we can!
\nLets you change the amount of a single scheduled payment, with the option to also change the amount of all future payments scheduled after that payment.
\nOur unique ScheduledPaymentId is required to identity the payment to change - you can obtain this by doing a scheduled payment search.
\nWhenever possible, we recommend keeping your system simple and efficient by using only the default schedule for payers. However, there are some scenarios that require payers to have multiple schedules, each having a different set of future payments. To allow this, the URL above supports the inclusion of an optional schedule-reference route, as follows:
.../schedules/{{schedule-reference}}
If you think that you might require payers to have multiple schedules, then we ask that you first contact us to discuss your requirements before using this feature. We'll try our best to keep your system as simple and efficient as we can!
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
Returns information on an individual scheduled payment
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
payer-reference | \n Your unique reference that identifies the payer | \n
scheduled-payment-id | \n Our unique ID of the payment that you wish to look up information of | \n
Search on all scheduled payments currently assigned to the given payer.
\nWhenever possible, we recommend keeping your system simple and efficient by using only the default schedule for payers. However, there are some scenarios that require payers to have multiple schedules, each having a different set of future payments. To allow this, the URL above supports the inclusion of an optional schedule-reference route, as follows:
.../schedules/{{schedule-reference}}/payments
If you think that you might require payers to have multiple schedules, then we ask that you first contact us to discuss your requirements before using this feature. We'll try our best to keep your system as simple and efficient as we can!
\nUsed for searching all types of scheduled payments (payments that have not yet been processed, but are scheduled to be processed in the future). A maximum of 200 payments can be returned in one call (see skip/take parameters below).
\nSearch for transaction processed from this date/time. PLEASE NOTE: timeFrom is REQUIRED for all searches where a \"reference\" is not supplied.
\n","type":"text/plain"},"key":"dateFrom","value":"2018-06-09T11:07:15+10:00"},{"description":{"content":"Search for payments that are scheduled before or after this date
\n","type":"text/plain"},"key":"dateTo","value":"2018-12-09T11:07:15+10:00"}],"variable":[]}},"response":[{"id":"f1eac7a0-7b8e-4965-b752-1b03768e4bfe","name":"Search all scheduled payments with options","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/businesses/{{business-id}}/scheduled-payments?dateFrom=2018-06-09T11:07:15+10:00&dateTo=2018-12-09T11:07:15+10:00","host":["{{url}}"],"path":["businesses","{{business-id}}","scheduled-payments"],"query":[{"key":"dateFrom","value":"2018-06-09T11:07:15+10:00","description":"Search for transaction processed from this date/time. PLEASE NOTE: timeFrom is REQUIRED for all searches where a \"reference\" is not supplied."},{"key":"dateTo","value":"2018-12-09T11:07:15+10:00","description":"Search for payments that are scheduled before or after this date"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"f43ce38c-c946-4816-a83d-f260382715ee","name":"Scheduled Payments Search ALL","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/businesses/{{business-id}}/scheduled-payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"scheduledPaymentId\": \"213898\",\n \"business\": {\n \"businessId\": \"1234\",\n \"businessName\": \"Test Business Ltd\"\n },\n \"date\": \"2018-06-29T00:00:00\",\n \"amount\": 75,\n \"reference\": \"Pmt-Reference-001\",\n \"description\": \"This is a scheduled payment\",\n \"scheduleReference\": null,\n \"isIndividualPayment\": true,\n \"subBusinessId\": null,\n \"payer\": {\n \"payerId\": \"114868\",\n \"uniqueReference\": \"114868\",\n \"groupReference\": \"114868\",\n \"familyOrBusinessName\": \"Smith\",\n \"givenName\": \"John\",\n \"status\": \"ACTIVE\"\n }\n },\n {\n \"scheduledPaymentId\": \"213893\",\n \"business\": {\n \"businessId\": \"1234\",\n \"businessName\": \"Test Business Ltd\"\n },\n \"date\": \"2021-07-05T00:00:00\",\n \"amount\": 100.5,\n \"reference\": null,\n \"description\": null,\n \"scheduleReference\": null,\n \"isIndividualPayment\": false,\n \"subBusinessId\": null,\n \"payer\": {\n \"payerId\": \"135032\",\n \"uniqueReference\": \"P1-UNIQUE-REF\",\n \"groupReference\": \"P1-GROUP-REF\",\n \"familyOrBusinessName\": \"Surname\",\n \"givenName\": \"First Name\",\n \"status\": \"ACTIVE\"\n }\n },\n {\n \"scheduledPaymentId\": \"213894\",\n \"business\": {\n \"businessId\": \"1234\",\n \"businessName\": \"Test Business Ltd\"\n },\n \"date\": \"2021-08-03T00:00:00\",\n \"amount\": 100.5,\n \"reference\": null,\n \"description\": null,\n \"scheduleReference\": null,\n \"isIndividualPayment\": false,\n \"subBusinessId\": null,\n \"payer\": {\n \"payerId\": \"135032\",\n \"uniqueReference\": \"P1-UNIQUE-REF\",\n \"groupReference\": \"P1-GROUP-REF\",\n \"familyOrBusinessName\": \"Surname\",\n \"givenName\": \"First Name\",\n \"status\": \"ACTIVE\"\n }\n },\n {\n \"scheduledPaymentId\": \"213895\",\n \"business\": {\n \"businessId\": \"1234\",\n \"businessName\": \"Test Business Ltd\"\n },\n \"date\": \"2021-09-03T00:00:00\",\n \"amount\": 100.5,\n \"reference\": null,\n \"description\": null,\n \"scheduleReference\": null,\n \"isIndividualPayment\": false,\n \"subBusinessId\": null,\n \"payer\": {\n \"payerId\": \"135032\",\n \"uniqueReference\": \"P1-UNIQUE-REF\",\n \"groupReference\": \"P1-GROUP-REF\",\n \"familyOrBusinessName\": \"Surname\",\n \"givenName\": \"First Name\",\n \"status\": \"ACTIVE\"\n }\n }\n]"}],"_postman_id":"dea962c6-d4b2-443c-ae19-dc5fb46b5a69"}],"id":"26046bcb-328d-45c5-a3bc-36273f4d4d3d","_postman_id":"26046bcb-328d-45c5-a3bc-36273f4d4d3d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}}],"id":"dc3eaa60-e297-457c-84dc-8db984910d21","description":"Recurring payments are Credit Card and Bank Debit (ACH) transactions that are scheduled to be processed on the current or future date.
\nDepending on the functionality of the software integrating, the scheduling of transactions may be controlled by the integrated application or by the Payrix Payment Scheduler.
\nMost CRM and ERP systems already contain the information regarding the Payer and when they are to be debited. In this case, transaction requests are typically passed on the morning they are due to be debited via the POST Schedule a single payment or POST Schedule multiple future payments functions.
\nTo process a transaction ASAP, it is possible to schedule for \"today\", this transaction will be picked up in the next available processing run. If the transaction is received after the last processing run for the day has started, it will be processed in the next available run. typically, the morning of the next business day.
\nIf you would prefer to use the our scheduler, you would use the POST Schedule multiple future payments to set up the original payment schedule, the utilise the POST Schedule a single payment, POST Schedule a single payment and PATCH Change Payment Amounts functions to deal with exceptions. Alternatively, if exceptions are rare, you could choose to allow the users to make changes manually through the Payrix portal application.
\nPlease be aware you will need to add the Worldpay for Platforms Terms and Conditions to your page for the Payer to agree to.
\nAn alternative method of setting up schedules in the Payment Scheduler is to utilise the eDDR page which allows users to enter biographical and payment details, select a schedule and agree to Terms and Conditions on a single PCI compliant page hosted by Worldpay for Platforms.
\nUp until the time the our debit process is run for the day, Scheduled transactions may be altered or removed. Once a scheduled transaction is picked up for processing, the transaction may not be removed, and can only be refunded once the transaction has been processed by the bank.
\nπNote - In the UK, for a Bank Account direct debit to be valid, the Payers First name, Last name, Email Address and Address are mandatory. A Bank Account direct debit schedule in the UK must allow 6 business days notice before the payment due date. Scheduled Bank Account debits may not be altered or removed once it is within the 6 business day notice period. A Credit Card direct debit does not fall under the same UK BACS requirements for the 6 business day rule and can be scheduled, altered or removed at any time prior to processing.
\n","event":[{"listen":"prerequest","script":{"id":"cc8ab99d-36bf-4a65-840d-8ce2354fa607","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"34e85e43-9282-485b-95bd-e9df4aed907d","type":"text/javascript","exec":[""]}}],"_postman_id":"dc3eaa60-e297-457c-84dc-8db984910d21","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Transactions","item":[{"name":"Create Card Transaction","item":[{"name":"Make a live card transaction ππ΄","id":"7321df17-1479-4261-b20f-6afe4ba489cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ProcessType\": \"COMPLETE\",\r\n \"Reference\": \"REAL-TIME-TXN-101\",\r\n \"Description\": \"This is an example real-time transaction\",\r\n \"Amount\": 10.25,\r\n \"CardToken\": null,\r\n \"Card\": {\r\n \"CardNumber\": \"4111111111111111\",\r\n \"CardholderName\": \"TEST Card\",\r\n \"ExpiryYear\": 2029,\r\n \"ExpiryMonth\": 10,\r\n \"Ccv\": \"123\"\r\n },\r\n \"Payer\": null,\r\n \"Audit\": {\r\n \"Username\": \"Example-User\",\r\n \"UserIP\": \"1.2.3.4\"\r\n }\r\n }"},"url":"{{url}}/businesses/{{business-id}}/transactions/card-payments","description":"This function submits a single credit card payment to the bank and returns a result in real-time. The payment can be a complete payment that will be processed and the funds settled to the business, or it can be a pre-authorisation that will hold the funds until you Process a pre authorised card transaction or the pre-authorisation expires.
\nPlease note you have the option to Tokenize Card and to Make a live tokenized card transaction
\nUsually transactions will be processed by the bank and a result returned to you within a couple of seconds, however delays in the bank networks can occur from time to time so you should ideally enable your system to be able to wait up to 90 seconds to get a transaction result.
\nπ΄ WARNING: This request can directly accept payment card details. If you do so, then your integration CANNOT be certified unless your system is PCI DSS complaint. See the PCI Compliance section for more details π΄
\nπNote - This API request is not enabled by default unless your system is PCI Level 1. To confirm your system is PCI Level 1 you will need to supply an AOC (Attestation of Compliance) for our Risk team to review and approve this API for development and integration.
\nThis function submits a single credit card payment to the bank and returns a result in real-time. The payment can be a complete payment that will be processed and the funds settled to the business, or it can be a pre-authorisation that will hold the funds until you Process a pre authorised card transaction or the pre-authorisation expires.
\nThis call requires a token generated from the Tokenize Card endpoint. For more details on how to tokenize the card please click here.
\nUsually transactions will be processed by the bank and a result returned to you within a couple of seconds, however delays in the bank networks can occur from time to time so you should ideally enable your system to be able to wait up to 90 seconds to get a transaction result.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
Tokenized Card Transaction Model
\nThis function submits a single credit card payment with a 3D-Secure Authentication validation to the bank and returns a result in real-time. The 3DS transaction could be completed via a frictionless success or frictionless reject, otherwise a 3DS challenge is required to be completed by the end user. If a challenge is required, sotre the redirectId and redirect the end-user to complete the challenge to the redirectUrl.
\nThis call requires a token generated from the Tokenize Card endpoint. For more details on how to tokenize the card please click here.
\nUsually transactions will be processed by the bank and a result returned to you within a couple of seconds, however delays in the bank networks can occur from time to time so you should ideally enable your system to be able to wait up to 90 seconds to get a transaction result.
\nTokenized Card Transaction Model
\nThis function allows users the ability to submit a single wallet eCommerce payment via Apple Pay or Google Pay through the SaaS own payment page and returns a result in real-time. This functionality is available for single real-time payments only via the SaaS payment page and using the βtokenised card transaction modelβ for Apple Pay or Google Pay specifically where you will interchange the cardtoken for the applepaytoken or googlepaytoken when the end user is submitting payment via applepay or googlepay respectively.
\nTo integrate Apple Pay or Google Pay into your payment page, you will need to have the integration approved by Apple and/or Google to certify your payment page. Our team will need to set up and configure your account to allow wallet acceptance and to provide you with a CSR to accept ApplePay and a gateway merchantID for GooglePay.
\nUsually transactions will be processed by the bank and a result returned to you within a couple of seconds, however delays in the bank networks can occur from time to time so you should ideally enable your system to be able to wait up to 90 seconds to get a transaction result.
\nTokenized Card Transaction Model
\nThis function allows users the ability to submit a single wallet eCommerce payment via Apple Pay or Google Pay through the SaaS own payment page and returns a result in real-time. This functionality is available for single real-time payments only via the SaaS payment page and using the βtokenised card transaction modelβ for Apple Pay or Google Pay specifically where you will interchange the cardtoken for the applepaytoken or googlepaytoken when the end user is submitting payment via applepay or googlepay respectively.
\nTo integrate Apple Pay or Google Pay into your payment page, you will need to have the integration approved by Apple and/or Google to certify your payment page. Our team will need to set up and configure your account to allow wallet acceptance and to provide you with a CSR to accept ApplePay and a gateway merchantID for GooglePay.
\nUsually transactions will be processed by the bank and a result returned to you within a couple of seconds, however delays in the bank networks can occur from time to time so you should ideally enable your system to be able to wait up to 90 seconds to get a transaction result.
\nTokenized Card Transaction Model
\nUsed to refund all or part of a previously processed card transaction
\n**Please note that the API Refund function is not available by default.
\nThe ability to process refunds depends on what type of merchant account you have, and approval by our Risk and Fraud team.
\nFor further information please contact us.
\nCapture the funds from a previously pre-authorized card transaction
\nUsed to reverse (cancel) a pre-auth transaction that has not been captured yet. This will release the held funds back to the cardholder.
\n** PLEASE NOTE: It is not possible to perform a partial reversal - the entire amount of the original authorization must be reversed.
\nFor further information please contact us.
\nThis quickstart guides you through accepting card payments using tokenized payment card details.
\nYou can help to reduce your PCI compliance obligations by ensuring that your system does not receive confidential information about payment cards. To do so, we recommended making a webpage to allow your payers to enter their payment card details via their web browser. This webpage can then use our JavaScript to tokenize the details to us directly, avoiding your system entirely. See the Building a Webpage quickstart for more details.
\nOnce you have the \"card token\" that represents the details of the payment card, use the Bearer token to send us an authorized POST Make a live tokenized card transaction request containing the \"card token\" and other details of the payment. It must include at least the ProcessType, a unique Reference, and the Amount for the payment; whenever possible, we recommended also including a Description; for example:
{\n \"ProcessType\": \"COMPLETE\",\n \"Reference\": \"INV-1-PAY-1\",\n \"Description\": \"Invoice 1 Payment 1\",\n \"Amount\": 10.00,\n \"CardToken\": \"0123456789abcdef0123456789abcdef\"\n}\n\nIf you asked for payer-paid fees in your account application, then you do not need to include customer surcharges in the value of Amount as these are added automatically when your request is processed.
When using the test API, the transaction amount gives you the ability to test both successful and failed payments. When the transaction amount has zero or a number of cents/pence (subunit) other than the ones listed below, the test transaction will always be successful. If you provide one of the following numbers for the number of cents you will receive a transaction failed response with the corresponding reason:
\n31 = Invalid Account
\n54 = Expired card - Card Only
\n51 = Declined
\n61 = Insufficient Funds
\n96 = Technical failure - Card Only
\nThe payment result is not indicated by the response HTTP status code. If we receive a POST Make a live tokenized card transaction request and can process it, then the response HTTP status code will be 200 (OK) regardless of whether the payment was approved or declined. To check the payment result, inspect the StatusCode value of the Transaction Result object that comprises the response body: S means the payment succeeded (was approved); F means it failed (was declined). See the Card Transaction Status Code list for all possible status codes.
For declined payments, additional details about why it failed are provided in the SubStatusCode and StatusDescription values of the Transaction Result object; for example:
{\n \"TransactionId\": \"12345\",\n \"Reference\": \"INV-1-PAY-1\",\n \"StatusCode\": \"F\",\n \"SubStatusCode\": \"R1\",\n \"StatusDescription\": \"Insufficient Funds\",\n \"ProcessedAmount\": 10.48\n}\n\nSee the Transaction Sub-Status Code list for all possible sub-status codes.
\nIf payer fees have been enabled for your account, then the ProcessedAmount value in the response will be greater than the Amount value in your request: the difference being the fees charged to the payer. You can use payer fees to, for example, add surcharges for different payment card types without the risk of accessing confidential information about payment cards, which helps to reduce your PCI compliance obligations.
Example Cards Numbers. Please note thes ecan only be used in Sandbox.
\n| Card Type | Test Card Numbers |
|---|---|
VISA | 4111111111111111 4444333322221111 4242424242424242 4012888888881881 |
Mastercard | 5353535353535351 5555555555554444 5105105105105100 2221000000000009 2720990000000007 |
AMEX | 378282246310005 371449635398431 378734493671000 |
Discover | 6011111111111117 6011000990139424 |
JCB | 3530111333300000 3566002020360505 |
Diners | 30569309025904 38520000023237 |
CVC: Any 3-digit number
\nExpiry Date: Any Future Date.
\n* 4012888888881881 Will return a Rejected status as Sanctioned country
When testing the 3DS supports a few different card numbers for triggering different scenarios:
\nProcesses a real-time card transaction on the card account currently registered to the payer.
\nπNote - This API request is not applicable for integrations in the United Kingdom due to the card on file compliance regulations. To charge a stored card you will need to use the POST - 3DS - Process a tranaction using saved card details to specify whether the saved card transaction is a CIT(customer-initited transaction) or MIT(merchant-initiated transaction)
\nPlease use card number 4111111111111111 when testing this call.
\nAs 3DS is mandatory in the UK for Customer-Initiated-Transaction(CIT) payments, this function will need to be used. You will need to supply CallBackUrl, BrowserInfo, CardStorageType and CardAuthorizationType in the request. If you submit a CIT request the function will process a 3DS real-time card transaction on the card account currently registered to the payer. This will then require a challenge for the end user to complete the 3DS challenge or be completed frictionless.
\nWhen testing the 3DS supports a few different card numbers for triggering different scenarios:
\nThis quickstart guides you through making a transaction using a payers saved card details.
\nUse the Bearer token to send us an authorized POST Process a transaction using saved card details request containing the details of the transaction.
It must include at least the ProcessType, a unique Reference, and the Amount for the payment; whenever possible, we recommended also including a Description; for example:
{\n \"ProcessType\": \"COMPLETE\",\n \"Reference\": \"Transaction-001\",\n \"Amount\": 100.75,\n \"Description\": \"This is a test transaction\",\n \"Audit\": {\n \"Username\": \"Example-User\",\n \"UserIP\": \"1.2.3.4\"\n }\n}\n\nInformation regarding Enums can be found here: ProcessType Enums
\nIf you asked for payer-paid fees in your account application, then you do not need to include customer surcharges in the value of Amount as these are added automatically when your request is processed.
The payment result is not indicated by the response HTTP status code. If we receive a POST Make a live card transaction request and can process it, then the response HTTP status code will be 200 (OK) regardless of whether the payment was approved or declined. The check the payment result, inspect the StatusCode value of the Transaction Result object that comprises the response body: S means the payment succeeded (was approved); F means it failed (was declined). See the Card Transaction Status Code list for all possible status codes.
For declined payments, additional details about why it failed are provided in the SubStatusCode and StatusDescription values of the Transaction Result object; for example:
{\n \"TransactionId\": \"12345\",\n \"Reference\": \"Transaction-001\",\n \"StatusCode\": \"F\",\n \"SubStatusCode\": \"R1\",\n \"StatusDescription\": \"Insufficient Funds\",\n \"ProcessedAmount\": 10.48\n}\n\nSee the Transaction Sub-Status Code list for all possible sub-status codes.
\nIf payer fees have been enabled for your account, then the ProcessedAmount value in the response will be greater than the Amount value in your request: the difference being the fees charged to the payer. You can use payer fees to, for example, add surcharges for different payment card types without the risk of accessing confidential information about payment cards, which helps to reduce your PCI compliance obligations.
As 3DS is mandatory in the UK if it is a Customer-Initiated-Transaction (CIT) further parameters are required to be provided in the request to identify and trigger 3DS to be compliant. For applications operating in the UK, please use this endpoint.
\n","event":[{"listen":"prerequest","script":{"id":"263b0b8b-b0fe-4545-b9b2-1695c0444235","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8f3b6322-63f6-4d98-bc26-81ee7b6780ed","type":"text/javascript","exec":[""]}}],"_postman_id":"32a8b226-cd17-490c-86ff-22051de081c8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Fraud Checking","item":[{"name":"Fraud Check π","id":"b155fd3b-9075-483b-aa4c-d437f6ae179b","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Token\": \"f4111d25-82d3-4743-87f4-cbf7a8e7972f\",\r\n \"SessionId\": \"abc12345678901234567890123456789\",\r\n \"TransactionAmount\": 20.78,\r\n \"IpAddress\": \"111.222.333.444\",\r\n \"Payer\": {\r\n \"FamilyOrBusinessName\": null,\r\n \"GivenName\": null,\r\n \"BillingAddress\": null,\r\n \"Email\": \"support@example.com\",\r\n \"Phone\": null\r\n },\r\n \"AirlineInfo\": null,\r\n \"HotelInfo\": null,\r\n \"CallbackUrl\": \"https://tester.com.au/test.aspx?p1=asdfasdf&p2=asdfasdf\",\r\n \"Audit\": null\r\n}"},"url":"{{url}}/businesses/{{business-id}}/transactions/card-payments/fraud-check","description":"Performs a fraud check to determine the risk of process a transaction based on the details of a card you have previously tokenized, and information on the transaction you pass into this function.
\nThis function returns a status to let you know if the transaction is ok to process immediately, requires additional fraud checking or the use of 3-D Secure, or if the transaction should not be processed at all due to high risk of fraud.
\nTesting Fraud Check responses via API is controlled via the cents value of the transaction\nFor example, $10.65
\nNB When tokenizing a card use: 4111111111111111
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
Used in conjunction with the card-payments/fraud-check function to obtain a HTML snippet with a DIV tag which contains code for a JavaScript Data Collector which collects pertinent information about your customer for performing the fraud check.
\nThis DIV tag must be embedded into one of your webpages once you have established a session with your customer, but before you call the fraud-check function.
\n| Parameter | \nDescription | \n
|---|---|
business-key | \n Your unique Key (GUID) which identifies your business | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
session-id | \n guid | \nA globally unique ID which identifies the session of your user. must be between 10 and 32 characters, contain no spaces, and contain no symbols expect - and _. It is recommended that you use a GUID with the \"-\" removed, or used your web server's session id. This id must be the same as the session ID your provided to the JavaScript Fraud Data Collector (see our Fraud Management Guide for more information on this). | \n
\n \nIf you have used 3-D Secure to validate a transaction (through the use of the \"Fraud Check\" function), your customer will be redirected to 3-D Secure and then back to your website if they complete the process.
\nOnce they have been redirected back to your website, you can call this function from your server to check whether the 3-D Secure validation was successful, and whether or not it is ok to proceed with the payment.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
token | \n string | \nToken for a card that you previously tokenized and used with the Fraud Check function | \n
3-D Secure Authorization Result Model
\n","urlObject":{"path":["businesses","{{business-id}}","transactions","card-payments","3dsecure","result",""],"host":["{{url}}"],"query":[{"key":"token","value":"{{card-token}}"}],"variable":[]}},"response":[{"id":"e5156a48-607c-40bb-82d4-93609fc3efe2","name":"3-D Secure Result Lookup","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/businesses/{{business-id}}/transactions/card-payments/3dsecure/result/?token={{card-token}}","host":["{{url}}"],"path":["businesses","{{business-id}}","transactions","card-payments","3dsecure","result",""],"query":[{"key":"token","value":"{{card-token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"AUTHORISED\"\r\n }"}],"_postman_id":"6a40fa57-1f22-4c91-bacd-0b8297bea256"}],"id":"514e1719-af63-4d58-8458-1c7ee9c86af4","description":"To use our fraud checking, you must use a webpage to accept payment card details from payers. (If you are not doing so already, see the Building a Webpage quickstart for more details. This allows us to provide you with a fraud check data collector that gathers information automatically about payers; for example, approximate geographic locations and source IP addresses.
\nTo get the data collector, send us a Fraud Check Data Collector HTML request, which does not need to be authorized. A new data collector must be used for each payment attempt, so each time your webpage is displayed, you must send us a new Fraud Check Data Collector HTML request. For each attempt made by the same payer during a single session, specify the same session-id in the request.
If the response HTTP status code is 200 (OK) then the response body contains the fraud check data collector as an HTML
element, which in turn contains other HTML tags; for example:
\n<div class='preserveHtml' class='preserveHtml' class='kaxsdc' data-event='load'>\n <script type='text/javascript' src='https://ssl.kaptcha.com/collect/sdk?m=100000&s=12345678901234567'></script>\n <img class='preserveHtml' class='preserveHtml' src='https://ssl.kaptcha.com/logo.gif?m=100000&s=12345678901234567' />\n <script type='text/javascript'>var client=new ka.ClientSDK(); client.autoLoadEvents();</script>\n</div>\n\nThe outer HTML element of the data collector will always be a
\n, but its attributes and the other HTML tags it contains may change with each Fraud Check Data Collector HTML request. It is therefore important that you do not save and reuse the data collector
\nelement for your webpage.
\nIn the element of your webpage, add the entire response body for the Fraud Check Data Collector HTML request that you sent us. As explained above, this will be a
\ntag that has attributes and/or contains other HTML elements comprising our fraud check data collector. If you don't have a reason to do otherwise, we recommend adding this
\ntag immediately prior to the tag in your webpage.
\nOnce you have the \"card token\" that represents the details of the payment card, use the Bearer token to send us an authorized Fraud Check request containing the \"card token\" and other details of the payment. It must include at least the SessionId, the TransactionAmount, and payer IpAddress and Email details; to support 3-D Secure, a CallbackUrl is also required; for example:
{\n \"Token\": \"0123456789abcdef0123456789abcdef\",\n \"SessionId\": \"12345678901234567\",\n \"TransactionAmount\": 10.00,\n \"IpAddress\": \"1.2.3.4\",\n \"Payer\": {\n \"Email\": \"jane.citizen@example.com\"\n },\n \"CallbackUrl\": \"https://my.domain/3d-secure-callback?id=1a2b3c4d5e6f\"\n}\n\nIf you asked for payer-paid fees in your account application, then you do not need to include customer surcharges in the value of TransactionAmount as these are added automatically when your request is processed.
The fraud check result is not indicated by the response HTTP status code. If we receive a Fraud Check request and can process it, then the response HTTP status code will be 200 (OK) regardless of whether or not fraud is suspected. To check the fraud check result, inspect the Result value of the Fraud Check Result object that comprises the response body: PROCEED means there is minimal risk of fraud; USE3DS means that you should use 3-D Secure; other values indicate an increased risk of fraud. See the Fraud Check Result list for all possible results.
Additional details about the fraud check result are provided in the ResultMessage and RedirectUrl values of the Fraud Check Result object; for example:
{\n \"Result\": \"PROCEED\",\n \"ResultMessage\": \"Low Risk Transaction - OK to proceed\",\n \"RedirectUrl\": null\n}\n\nIf the value of Result in the response to your Fraud Check Result request is USE3DS, then 3-D Secure cardholder authentication is available. It is not available if the value of Result is something else. The use of 3-D Secure when available was not enforced at the time of writing, but we recommend doing so whenever possible, and may require its use when available in the future.
To use 3-D Secure, redirect the payer's web browser to the URL provided as the value of RedirectUrl in the response to your Fraud Check Result request. Once cardholder authentication is complete, the payer's web browser will be redirected back to the URL you specified as the value of CallbackUrl in your Fraud Check request.
When your callback URL is activated, check the 3-D Secure result by sending us an authorized 3-D Secure Result Lookup request. The result is not indicated by the response HTTP status code. If we receive your request and can process it, the response HTTP status code will be 200 (OK) regardless of whether or not the cardholder was authenticated. To check the result, inspect the Status value of the 3-D Secure object that comprises the response body: AUTHORISED means that the cardholder was authenticated; other values indicate an increased risk of fraud. See the 3-D Secure Authorization Status list for all possible statuses.
Our fraud checking allows you to gauge the risk of accepting payments. At the time of writing, it remains up to you to decide whether or not to continue with accepting the payment; however, we may restrict which payments can be accepted based on risk in the future.
\nTo accept the payment, send us an authorized POST Make a live card transaction request containing the \"card token\" and other details of the payment, and then check the payment result. See the Create Card Transaction quickstart for more details.
\n","event":[{"listen":"prerequest","script":{"id":"3a3cc4da-93de-460b-a48f-938a7c850d00","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"27c389db-8d92-45f7-8ad7-9e557bb41a9c","type":"text/javascript","exec":[""]}}],"_postman_id":"514e1719-af63-4d58-8458-1c7ee9c86af4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Status Changes","item":[{"name":"Search for transaction status changes π","id":"4e87eb46-2ed5-4469-9ab4-904b99a2a738","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/businesses/{{business-id}}/transactions/new","description":"This function is used to get a set of all transactions for your business that have had a change of transaction status so the details of the transaction can be updated within your own systems.
\nIt needs to be used in conjunction with the POST \"Acknowledge transaction status change\" function below. Only transactions processed within the last 90 days will be returned by this function.
\nA maximum of 1000 transactions can be returned in one call (see skip/take parameters below).
\nPLEASE NOTE: This function will only allow you to retrieve your transaction results once per hour. It can return up to 1000 transactions per call - once all your waiting transaction results have been returned, or the function returns the same results due to not acknowledging the previous transactions you downloaded, you will need to wait an hour until you can retrieve any results from the function again.
\nIf you call the function again within that hour it will return HTTP Status Code 429 (Too Many Requests). Payment processing for most transaction types only occurs a few times per day, so there is no benefit in calling this transaction more frequently than once per hour.
This function notifies us that the details downloaded for a transaction via the \"New Status Search\" function above have been received and processed by you so they won't be downloaded again the next time the \"New Status Search\" function is called.
\nPLEASE NOTE: As there is always the possibility of this call failing due to network dropouts etc., it is recommended that you make your system able to handle transaction results being downloaded a second time from the \"New Status Search\" function (i.e. so your system will ignore a result update for a transaction if it is downloaded again after you have already processed that result).
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
Transaction Status Update Received Model
\nUsed for searching all types of previously processed transactions. A maximum of 200 transactions can be returned in one call (see skip/take parameters below).
\nUsed to lookup details of a single previously processed transaction
\nUsed to search previously processed real-time card transactions and return the results.\nThis function can be used to lookup a transaction using your reference if you were unable to receive or record the results of a previous transaction submit.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
| Parameter | \nType | \nDescription | \n
|---|---|---|
reference | \n string | \nThe unique reference you provided to identify the transaction | \n
The unique reference you provided to identify the transaction
\n","type":"text/plain"},"key":"reference","value":"{{transaction-reference}}"}],"variable":[]}},"response":[{"id":"cf0afc04-edf2-4407-9ef0-38df69dfe56c","name":"Real-time Card Transaction Search","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/businesses/{{business-id}}/transactions/card-payments?reference=REAL-TIME-TXN-001","host":["{{url}}"],"path":["businesses","{{business-id}}","transactions","card-payments"],"query":[{"key":"reference","value":"REAL-TIME-TXN-001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"1203317\",\n \"reference\": \"REAL-TIME-TXN-001\",\n \"statusCode\": \"S\",\n \"subStatusCode\": null,\n \"statusDescription\": \"Successful\",\n \"processedAmount\": 100.25\n}"}],"_postman_id":"0986efcc-2ba8-46bc-b436-bce88a4e1a6c"},{"name":"Look up single live card transaction π","id":"ac43557c-2b7a-4530-85cd-9f9af66ff790","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/businesses/{{business-id}}/transactions/card-payments/{{transaction-id}}","description":"Can be used to lookup the processing result of a previously processed real-time card transaction
\nUsed to determine the full transaction lifecycle. Showing all \"From\" and \"To\" status changes for a specific Transaction ID or Reference.
\nAll static transaction information can be found using the
Transaction Search
or the Transaction Lookup endpoints
Route
\nTransaction Status History Model
\n","urlObject":{"path":["businesses","{{business-id}}","transactions","statuses",""],"host":["{{url}}"],"query":[{"key":"Reference","value":"test"}],"variable":[]}},"response":[{"id":"c63e138d-2de8-4411-a6d7-2fb656887b51","name":"Transaction Status History π ","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/businesses/{{business-id}}/transactions/statuses/?Reference=test","host":["{{url}}"],"path":["businesses","{{business-id}}","transactions","statuses",""],"query":[{"key":"Reference","value":"test"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Feb 2019 00:31:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4a41468d38965d72-BNE"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"transactionId\": \"1149552\",\n \"reference\": \"test\",\n \"statusChangeTime\": \"2018-11-20T02:20:51.9346928+00:00\",\n \"statusChangeFrom\": \"N\",\n \"statusChangeFromDescription\": \"Not Submitted\",\n \"statusChangeTo\": \"P\",\n \"statusChangeToDescription\": \"Pending\"\n },\n {\n \"transactionId\": \"1149552\",\n \"reference\": \"test\",\n \"statusChangeTime\": \"2018-11-22T12:02:01.6307632+00:00\",\n \"statusChangeFrom\": \"P\",\n \"statusChangeFromDescription\": \"Pending\",\n \"statusChangeTo\": \"C\",\n \"statusChangeToDescription\": \"Cleared\"\n },\n {\n \"transactionId\": \"1149552\",\n \"reference\": \"test\",\n \"statusChangeTime\": \"2018-11-22T12:02:07.6668311+00:00\",\n \"statusChangeFrom\": \"C\",\n \"statusChangeFromDescription\": \"Cleared\",\n \"statusChangeTo\": \"S\",\n \"statusChangeToDescription\": \"Settled\"\n }\n]"}],"_postman_id":"98b2d736-9c96-40bf-a819-a30be1d27949"}],"id":"396d57fd-6587-4f5a-82bc-3b3e55250e4e","_postman_id":"396d57fd-6587-4f5a-82bc-3b3e55250e4e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Point-of-Sale","item":[{"name":"Register a Point-of-Sale Transaction π","id":"3138d556-16ce-4e1d-9f9f-802d41b47144","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ProcessType\": \"COMPLETE\",\r\n \"TransactionType\": \"CASH\",\r\n \"Time\": \"2018-09-27T16:45:20.4646152+10:00\",\r\n \"Reference\": \"POS-0001\",\r\n \"PreviousTransactionReference\": null,\r\n \"Description\": \"xUnit Second Test POS Transactions\",\r\n \"Amount\": 185.37,\r\n \"CurrencyCode\": \"AUD\",\r\n \"StatusCode\": \"S\",\r\n \"SubStatusCode\": null,\r\n \"StatusDescription\": \"POS-Processed-OK\",\r\n \"Card\": {\r\n \"MaskedCardNumber\": \"555555xxxxxx4444\",\r\n \"CardholderName\": \"POS CARDHOLDER\",\r\n \"ExpiryYear\": 2031,\r\n \"ExpiryMonth\": 11,\r\n \"CardType\": \"Mastercard\"\r\n },\r\n \"Payer\": {\r\n \"UniqueReference\": \"pos.payer.1\",\r\n \"GroupReference\": \"pos.g.payer.1\",\r\n \"FamilyOrBusinessName\": \"Surname\",\r\n \"GivenName\": \"Firstname\",\r\n \"BillingAddress\": {\r\n \"Line1\": \"1 POS Test St\",\r\n \"Line2\": null,\r\n \"Suburb\": \"Testville\",\r\n \"State\": \"QLD\",\r\n \"PostCode\": \"4000\",\r\n \"Country\": null\r\n },\r\n \"Email\": \"support@example.com\",\r\n \"Phone\": \"07 3333 1111\",\r\n \"SavePayer\": false\r\n },\r\n \"SettlementDate\": \"2018-09-17T16:45:20.4654482+10:00\",\r\n \"BankReference\": \"Pos-Bank-123456789\",\r\n \"TerminalId\": \"TMR00000001\",\r\n \"MerchantId\": \"Merchant-XYZ\",\r\n \"ReceiptInfo\": \"-------- RECEIPT ---------\",\r\n \"Audit\": {\r\n \"Username\": \"Example\",\r\n \"UserIP\": \"1.2.3.4\"\r\n }\r\n }"},"url":"{{url}}/businesses/{{business-id}}/transactions/point-of-sale","description":"This function allows you to record a point-of-sale transaction that has been processed using one of your point-of-sale terminals.
\nThis function can only be used for businesses that have been approved and set up with a point-of-sale account with us.
\nPLEASE NOTE: This function performs duplicate detection on the \"Reference\" field - if we already have a transaction recorded with the Reference you provide, this function will return successful without adding a second transaction or updating the existing transaction.
\nWARNING: Full card numbers must not be passed through to this function - this function is only for recording transactions already processed by a point-of-sale system, so only the masked card number (first 6 and last 4 digits) needs to be provided.
\nTo retrieve previously posted transaction information please use the Transaction Search or Transaction Lookup calls.
\nPoint-of-Sale Transaction Model
\nPoint-of-Sale Transaction Result Model
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}},"urlObject":{"path":["businesses","{{business-id}}","transactions","point-of-sale"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"093a36ef-ffc9-4fe4-b9a7-a8fc180d02d0","name":"Register a Point-of-Sale Transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ProcessType\": \"COMPLETE\",\r\n \"TransactionType\": \"CASH\",\r\n \"Time\": \"2018-09-15T16:45:20.4646152+10:00\",\r\n \"Reference\": \"POS-0001\",\r\n \"PreviousTransactionReference\": null,\r\n \"Description\": \"xUnit Second Test POS Transactions\",\r\n \"Amount\": 185.37,\r\n \"CurrencyCode\": \"AUD\",\r\n \"StatusCode\": \"S\",\r\n \"SubStatusCode\": null,\r\n \"StatusDescription\": \"POS-Processed-OK\",\r\n \"Card\": {\r\n \"MaskedCardNumber\": \"555555xxxxxx4444\",\r\n \"CardholderName\": \"POS CARDHOLDER\",\r\n \"ExpiryYear\": 2031,\r\n \"ExpiryMonth\": 11,\r\n \"CardType\": \"Mastercard\"\r\n },\r\n \"Payer\": {\r\n \"UniqueReference\": \"pos.payer.1\",\r\n \"GroupReference\": \"pos.g.payer.1\",\r\n \"FamilyOrBusinessName\": \"Surname\",\r\n \"GivenName\": \"Firstname\",\r\n \"BillingAddress\": {\r\n \"Line1\": \"1 POS Test St\",\r\n \"Line2\": null,\r\n \"Suburb\": \"Testville\",\r\n \"State\": \"QLD\",\r\n \"PostCode\": \"4000\",\r\n \"Country\": null\r\n },\r\n \"Email\": \"support@example.com\",\r\n \"Phone\": \"07 3333 1111\",\r\n \"SavePayer\": false\r\n },\r\n \"SettlementDate\": \"2018-09-17T16:45:20.4654482+10:00\",\r\n \"BankReference\": \"Pos-Bank-123456789\",\r\n \"TerminalId\": \"TMR00000001\",\r\n \"MerchantId\": \"Merchant-XYZ\",\r\n \"ReceiptInfo\": \"-------- RECEIPT ---------\",\r\n \"Audit\": {\r\n \"Username\": \"Example\",\r\n \"UserIP\": \"1.2.3.4\"\r\n }\r\n }"},"url":"{{url}}/businesses/{{business-id}}/transactions/point-of-sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"transactionId\": \"POS-d64f21da150c4060aee8c954b0853659\",\r\n \"reference\": \"POS-0001\"\r\n }"}],"_postman_id":"3138d556-16ce-4e1d-9f9f-802d41b47144"}],"id":"40ef2e50-b3ff-49be-a4db-d0ab693f5dd5","_postman_id":"40ef2e50-b3ff-49be-a4db-d0ab693f5dd5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","id":"6644ab8c-28f6-4eec-a9d9-436123feccc1","name":"Worldpay for Platforms REST API Developer Guide","type":"collection"}}},{"name":"Tokenize Card","id":"b7f07cda-0595-4885-a5e1-4f3d2228c57f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n Card : {\n CardNumber : 4111111111111111,\n CardholderName : \"TEST CARD\",\n ExpiryYear : 2028,\n ExpiryMonth : 1,\n Ccv : \"123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/businesses/{{business-key}}/services/tokenize-card","description":"NB\nThis method is used by the framework for infrastructure purposes only, and is not intended to be called from your code.
\nPlease see the Building a Webpage section for more information on tokens.
\nIntended to be called client-side, this function uploads the details of a person's credit card directly to our servers and returns a token that can be used in place of the card information to process the payment on your server.
\nPLEASE NOTE: Tokenized cards are stored for 20 minutes only β During that time, you can use it to process a payment, to add the card to a payer, or both.\nIf a payment on the card is not processed or the card details are not added to a payer within this time, the card will need to be tokenized again.\nAfter 20 minutes the token will expire, however if you have added the payment details to a Payer you will be able to process a saved card transaction.
\n| Parameter | \nDescription | \n
|---|---|
business-key/GUID | \n Your `BusinessKey` aka `BusinessGUID` which identifies your business | \n
Used to refund all or part of a previously processed bank transaction
\nBank debits refunds are not immediate and depending on time of submit may not be processed until next business day due to bank cutoffs times.
\n**Please note that the API Refund function is not available by default.
\nThe ability to process refunds depends on what type of merchant account you have, and approval by the our Risk and Fraud team.
\nFor further information please contact us.
\nGenerate a new token for use with the HPP (Hosted Payment Page) Service
\n| Parameter | Description |
|---|---|
business-id | The business you want to access |
Generate a new token for use with the eDDR (Electronic Direct Debit Request) Service
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
Generate a new token for use with the \"Add-To-Vault\" Service
\nπNote - This API request is not applicable for integrations in the United Kingdom due to the card on file compliance regulations. To update card details for a payer, a transaction must be processed which can be completed through a Zero-Dollar Authentication transaction request or a value transaction payment through a HPP (Hosted Payment Page)
\nUsed to lookup details of a single previously generated token.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
token | \n The token (GUID) that you received by using one of the token generate endpoints | \n
These endpoints can be used to obtain single use tokens that can be used for our three types of hosted payment services:
\nThese services can be used when you want to simplify your integration, and/or reduce your application risk and PCI Compliance scope, by redirecting your customers to our customizable hosted services webpages where they can entered their information which is then processed directly by us.
\nThe process for using the tokens is simply:
\nPlease note the token is valid for 20 minutes.
\nYou may wish to use a landing page to trigger this if the page will not be completed as part of the flow.
\nIf there is no transaction on saved payment details for 13 months, the payer status will be changed to βCancelled β cancelled due to inactivity β. 1 month after this (14 months total), payment details will be removed. After 13 months transactions will not be possible unless Payer Status is changed.
\nPlease allow up to 3 seconds for payer data to be available in other Payer API endpoints when saving or updating payer information via a Hosted Service Token.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e6abfe78-c6a4-4e3b-8522-198a6b527af9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c5e57afa-cd28-4ca9-a066-9fba8ec8b94e","type":"text/javascript","exec":[""]}}],"_postman_id":"5bd000e6-e156-4242-962b-3b93e9ed8f9e"},{"name":"PayTo / PayID Payments","item":[{"name":"Agreement Create π","id":"1b48795a-0128-4c32-b9f0-b6feff158e46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"AgreementUniqueReference\": \"AgreementUniqueReferenceTest1\",\r\n \"PayerUniqueReference\": \"PayToPayerUniqueReferenceTest1\",\r\n \"PayerName\": \"First Name Surname\",\r\n \"PayerIsBusiness\": \"false\",\r\n \"Description\": \"This is an example for PayTo description\",\r\n \"AgreementPurpose\": \"OTHR\",\r\n \"PayIDType\": \"EMAL\",\r\n \"PayID\": \"support@example.com\",\r\n \"PaymentAmountType\": \"VARI\",\r\n \"PaymentAmountMax\": 1000.00,\r\n \"PaymentAmountFirst\": 10.00,\r\n \"PaymentAmountLast\": 10.00,\r\n \"ValidFromDate\": \"2024-11-06\",\r\n \"ValidtoDate\": null,\r\n \"Frequencytype\": \"ADHO\",\r\n \"AllowAutomaticExtension\": true,\r\n \"IsAttended\": false,\r\n \"Audit\": {\r\n \"Username\": \"Example-User\",\r\n \"UserIP\": \"1.2.3.4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/businesses/{{business-id}}/agreements","description":"Use this endpoint to create a new PayTo agreement, use the bearer token to send us an authorised POST Agreement Create request. It must include the AgreementUniqueReference, PayerUniqueReference, PayerName, Description, AgreementPurpose, PayIDType, PayID, PaymentAmountType, FrequencyType as minimum.
Special notes:
\nEach payer can only have 1 Active PayTo agreement at a time for the business.
\nEach agreementuniqueReference must be unique.
\nUse this endpoint to retrieve the details of a specific PayTo agreement. This endpoint returns the full details, including the current status of the agreement with the given PayTo agreement reference.
\nThis request does not have a body
\nPayTo - Agreement Search Model
\n","urlObject":{"path":["businesses","{{business-id}}","agreements","{{agreementUniqueReference}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b3396fae-46ec-4be1-9771-4388ddb329c5","name":"Agreement LookUp","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/businesses/{{business-id}}/agreements/{{agreementUniqueReference}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"business\": {\r\n \"businessId\": \"90129\",\r\n \"businessName\": \"Payrix TEST\"\r\n },\r\n \"payer\": {\r\n \"payerId\": \"545742\",\r\n \"uniqueReference\": \"PayToPayerTest1\",\r\n \"groupReference\": \"PayToPayerTest1\",\r\n \"familyOrBusinessName\": \"Citizen\",\r\n \"givenName\": \"Jane\",\r\n \"address\": null,\r\n \"email\": null,\r\n \"phone\": null,\r\n \"mobile\": null\r\n },\r\n \"agreementID\": \"59cea9bb-2087-4173-bd04-9ddedc9a9fd4\",\r\n \"agreementStatus\": \"ACTIVE\",\r\n \"agreementUniqueReference\": \"PayToTestAgreement1\",\r\n \"payerUniqueReference\": \"PayToPayerTest1\",\r\n \"payerName\": \"Jane Citizen\",\r\n \"payerIsBusiness\": false,\r\n \"description\": \"This is an example for PayTo description\",\r\n \"agreementPurpose\": \"OTHR\",\r\n \"payIDType\": \"AUBN\",\r\n \"payID\": \"63135196397\",\r\n \"paymentAmountType\": \"VARI\",\r\n \"paymentAmount\": null,\r\n \"paymentAmountMax\": 1000.00,\r\n \"paymentAmountFirst\": 10.00,\r\n \"paymentAmountLast\": 10.00,\r\n \"validFromDate\": \"2024-07-12T00:00:00\",\r\n \"validToDate\": null,\r\n \"frequencyType\": \"ADHO\",\r\n \"allowAutomaticExtension\": true,\r\n \"isAttended\": false,\r\n \"actionRequestedByTime\": \"2024-07-30T10:00:00+10:00\",\r\n \"createdTime\": \"2024-07-11T10:29:13.62+10:00\",\r\n \"lastUpdateTime\": \"2024-07-11T11:06:27.46+10:00\"\r\n"}],"_postman_id":"4b525da8-0072-4c35-8773-9df57f699fb1"},{"name":"Payment Submit π","id":"545e9f6c-483f-44f3-b279-5046083754ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Reference\": \"PayToTestPayment1\",\r\n \"Amount\": 100.00,\r\n \"Audit\": {\r\n \"Username\": \"Example-User\",\r\n \"UserIP\": \"1.2.3.4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/businesses/{{business-id}}/agreements/{{agreementUniqueReference}}/payments","description":"Use this endpoint to submit a PayTo payment for a specific PayTo agreement belonging to a business.
\nUse this endpoint with POST Payment Submit to identify the result of the PayTo transaction. This endpoint returns the details of the transaction and current status of the PayTo Payment with the given reference.
\nSpecial notes
\nThis request does not have a body
\nPayTo - Agreement Payment Search Model
\n","urlObject":{"path":["businesses","{{business-id}}","agreements","payments","{{payment-reference}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7b69d7c8-28fd-438b-9885-324298875d9b","name":"Payment LookUp","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/businesses/{{business-id}}/agreements/payments/{{payment-reference}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"business\": {\r\n \"businessId\": \"90129\",\r\n \"businessName\": \"Test Business Pty Ltd\"\r\n },\r\n \"payer\": {\r\n \"payerId\": \"135032\",\r\n \"uniqueReference\": \"PayToPayerTest1\",\r\n \"groupReference\": \"PayToPayerTest1\",\r\n \"familyOrBusinessName\": \"Citizen\",\r\n \"givenName\": \"Jane\",\r\n \"address\": null,\r\n \"email\": null,\r\n \"phone\": null,\r\n \"mobile\": null\r\n },\r\n \"time\": \"2024-07-08T12:44:15.33+10:00\",\r\n \"reference\": \"PayToPaymentTestReference1\",\r\n \"agreementUniqueReference\": \"PayToAgreementTest1\",\r\n \"paymentID\": \"PTP_39\",\r\n \"agreementID\": \"505f58f8-1ad8-4648-aba2-088d1efa0510\",\r\n \"amount\": 100.00,\r\n \"amountRequested\": 100.00,\r\n \"statusCode\": \"C\",\r\n \"subStatusCode\": 0,\r\n \"lastUpdateTime\": \"2024-07-08T12:44:15.34+10:00\"\r\n}"}],"_postman_id":"002584bb-2ab0-455b-bff2-067b897aad50"},{"name":"Agreement Status Update π","id":"d222ab3c-70dc-4471-9fb3-35ff12c30850","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"ChangeToStatus\": \"SUSPEND\",\r\n \"ReasonDescription\": \"test suspension\",\r\n \"Audit\": {\r\n \"Username\": \"Example-User\",\r\n \"UserIP\": \"1.2.3.4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/businesses/{{business-id}}/agreements/{{agreementUniqueReference}}/status","description":"Use this endpoint to update the status of an existing agreement. The processing of the status change is performed asynchronously - you will need subscribe to our PayTo Agreement event webhooks to be notified as to whether or not the status change was successful.
\nPayTo - Agreement Status Update Model
\nThis request does not return any response body
\n","urlObject":{"path":["businesses","{{business-id}}","agreements","{{agreementUniqueReference}}","status"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"26429528-f78c-4b2d-9a2f-c98cbb01ad92","name":"Agreement Status Update","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ChangeToStatus\": \"SUSPEND\",\r\n \"ReasonDescription\": \"test suspension\",\r\n \"Audit\": {\r\n \"Username\": \"Example-User\",\r\n \"UserIP\": \"1.2.3.4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/businesses/{{business-id}}/agreements/{{agreementUniqueReference}}/status"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d222ab3c-70dc-4471-9fb3-35ff12c30850"}],"id":"0da0b503-70bc-4700-a15b-54d3a9c57cf5","description":"PayTo is a real-time payment method and this guide will demonstrate the API flow in order to create and submit PayTo payments.
\nPayTo is a digital payment solution offered by banks for an easy and secure way to authorise and control payments from your bank account which can be utilised in several ways, such as a digital alternative to direct debit, and allowing you to pay directly from your bank account where you previously needed a card (like for in-app purchases and online shopping).
\nA payer record must be exist or be added through the 'Add a New Payer' API to create a PayTo Agreement.
\nUse this endpoint Add a New Payer to create a payer record and map the payer between your application and us.
\nPOST Agreement Create
\nGET Agreement LookUp
\nPOST Payment Submit
\nThis endpoint will submit a new PayTo Payment for an existing agreement. The processing of the new payment is performed asynchronously - you will need subscribe to our PayTo Payment event webhooks to be notified of the result of the transaction.
\nGET Payment LookUp
\nTo prove a webhook is a legitimate and unaltered message that was sent by us, and is intended for you, we include a signature which must be validated using a shared secret.
\nWhen we send you a webhook we will look for a successful (2xx) HTTP Status response from your web app. If we receive it we will consider the webhook successfully delivered. If we receive a status other than 2xx, or if we are unable to connect to your webhook URL, we will attempt to deliver the webhook an additional 3 times using the following back-off frequency:
\n1st Retry - After 30 minutes.
\n2nd Retry - After 2 hours.
\n3rd Retry - After 24 hours.
\nOur webhook message can contain one of more data objects depending on the event type. The data provided in the webhook is the current status of that entity at the time the webhook is generated. In general, determining what change occurred can be deduced just from the EventType itself, with the data object(s) only needed to get the ID/Reference to match to the entity in your system.
In some situations (e.g. connection dropouts or timeouts), a webhook might be delivered to you multiple times. We provide a unique Message ID with each webhook which you can use for duplicate checking.
\nIn some situations (e.g. if a webhook is unable to be delivered on first attempt), webhooks might be delivered out of sequence. For some event types, before actioning a webhook, it might be prudent to check the current status of the related entities in your system to make sure processing the webhook would not cause an invalid workflow. We provide timestamps with each webhook which can be useful for determining sequencing.
\nWhen using 3-D Secure, if the challenge scenario was triggered, once your customer is redirected back to your website after completing the verification process, you will need to call this function to finalize your transaction.
\nIf the verification was completed successfully by your customer, when you call this function we will immediately submit the transaction to the bank and return the result of the transaction.
\nIf the customer failed to complete the verification, when you call this function it will return a rejected transaction result with a sub-status code describing the 3-D Secure response, and the transaction will not be submitted to the bank.
\nSee here for more info on using 3-D.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
redirect-id | \n This must be set to the redirectId you received from the transaction result when you first attempted to process the transaction (see here). | \n
None
\nWhen using 3-D Secure, if the challenge scenario was triggered, once your customer is redirected back to your website after completing the verification process, you will need to call this function to finalize your transaction.
\nIf the verification was completed successfully by your customer, when you call this function we will immediately submit the transaction to the bank and return the result of the transaction.
\nIf the customer failed to complete the verification, when you call this function it will return a rejected transaction result with a sub-status code describing the 3-D Secure response, and the transaction will not be submitted to the bank.
\nSee here for more info on using 3-D.
\n| Parameter | \nDescription | \n
|---|---|
business-id | \n The business you want to access | \n
redirect-id | \n This must be set to the redirectId you received from the transaction result when you first attempted to process the transaction (see here). | \n
None
\n3-D Secure (v2) is available for some business setups and regions. It can provide strong customer authentication which helps to mitigate the risk of fraud and chargebacks.
\nThe 3-D Secure system will always attempt to a perform a βfrictionlessβ authentication, which means that it will evaluate various factors related to your customer, including things such as the contact details provided, card information and location etc., to determine the risk of processing the transaction. If the 3-D Secure system deems the risk low, then a 3-D Secure approval is given without requiring any input from the customer, so the processing of the transaction can be completed seamlessly.
\nHowever, if the 3-D Secure network deems that verification of the customer is necessary, the βchallengeβ scenario is initiated which requires your customer to be redirected to a page provided by the cardholderβs issuing bank, within which they will need to perform their banks process for verifying they are the legitimate cardholder and approve the transaction. If the customer successfully completes this verification, they will then be redirected back and the transaction can then be completed.
\nIt is also possible for a frictionless rejection to occur in situations such as in the attempt to use a card that has already been linked to fraud, or if the card is no longer active, or is registered as lost or stolen. In this case an authorization failed response is immediately returned from the 3-D Secure system so the transaction cannot be processed, and we will return a rejected status.
\nPlease Note: Once 3-D Secure has been turned on for your account, use of 3-D Secure will be enforced for all your real-time transactions.
\nThere are two ways by which you can process transactions using 3-D Secure:
\nHosted Payment Page (HPP) card transactions
\nAPI triggered real-time card transactions
\n3-D Secure with Hosted Payment Page (HPP) card transactions
\nIf you are using our HPP then all aspects of the 3-D Secure process is taken care of by us, and there is no need for you to do anything different with your HPP integration.
\n3-D Secure with API triggered real-time card transactions
\nBoth the provided card API function (see here) and the tokenized card API function (see here) support use of 3-D Secure.
\nUsing 3-D Secure with these functions requires you to do these additional things:
\n1) Additional input fields β Provide values for these fields on the card transaction model (see here and see here):
\n2) Handle Verification Redirect β When using 3-D Secure you can still receive the βSβ, βFβ and βRβ transaction result statuses (see here) such as in the case of frictionless authentication or errors. However, when using 3-D Secure you can also receive the βVβ result status β this means the challenge scenario has been triggered and you must redirect your customer to the URL that is included in the transaction response in the βredirectUrlβ field (see here). When receiving this status, the transaction response will also include a βredirectIdβ field β you will also need to store this value for use with completing the transaction when the customer is returned to your website (see Handle Callback below).
\n3) Handle Callback β if the challenge scenario was triggered, you need to set up your website to handle the callback that occurs when your customer is redirected back to your website after performing the verification. The customer will be returned to your website at whichever URL you provided for the βCallbackUrlβ as described above. You will then need to retrieve the βredirectIdβ you received previously and use it to call our finalize transaction API (see here). When the finalize API is called, if the challenge verification was successful, we will immediately submit the transaction to the bank for processing and return the result to you. If the challenge verification failed, or was not completed, we will return the rejected status, along with one of the R20, R21, R22 or R23 3-D Secure related sub-status codes (see here).
\nIt is possible for your customer to abandon the process and not complete the challenge verification at all in which case you will not receive any callback. To handle this situation you may wish to implement some sort of timeout of your transactions to complete their status within your systems. If you wish you can use the finalize API for this purpose.
\nWhen testing the 3DS supports a few different card numbers for triggering different scenarios:
\nIf a challenge is required on the βVerify your Paymentβ page if a code/ pin of \"555\" is entered the payment will complete successfully.
Any other 3 digit code can be used for a failed challenge.
Both will trigger a redirect back to βCallbackUrlβ.
As part of the UK regulatory compliance, 3D Secure (3DS) is mandatory in the UK and EU due to the Payment Services Directive 2 (PSD2) which mandates Strong Customer Authentication (SCA) for online payments to reduce fraud and enhance security. For this reason, 3DS is mandatory on Customer-Initiated-Transactions (CIT) for eCommerce, charge stored card and first transactions.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b8cd739c-1a9f-4bcd-b1be-8d6512879470","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"503153f5-2034-44a2-88b6-00620c42b4b7","type":"text/javascript","exec":[""]}}],"_postman_id":"faff43cd-5e44-471c-ad23-64a1fd28f90f"},{"name":"Card-On-File Compliance","item":[],"id":"eec38929-7677-459c-81db-707dfe64e3bf","description":"In an attempt to reduce fraud and improve customer experience and trust, Visa has introduced a Stored Credential Framework that both merchants and payment facilitators are obligated to adhere to as a way to enforce responsible usage of cardholder data. It introduces a number of policies and procedures relating to the processing of stored customer credit/debit card information that were previously not required.
\nThis framework has already been rolled out globally, and will eventually become mandatory for all merchants and payment facilitators.
\nFurther information on the framework can be found in this document from Visa: Visa Stored Credential Framework
\nOne of the key points of this framework is the differentiation of these two ways that a transaction on a stored card can be triggered:
\nCustomer Initiated Transaction (CIT) - this is a payment on a stored card that has been actively triggered by your customer themselves (i.e. it involves the active participation of the cardholder).
\nMerchant Initiated Transaction (MIT) - this is a payment on a stored card that you as the business have initiated yourself as part of collecting money based upon a pre-agreed contract between your business and the cardholder as part of whatever product or service you are providing them.
\nIn practice, the framework requires doing the following:
\nSpecifying whether you are processing a CIT or MIT.
\nSpecifying the type of authorization you are performing.
\nLinking all subsequent payments on a stored card using an authorization reference.
\n\n\nThis framework does include other elements relating to the upfront information you must provide your customer to inform them about when and how you will be charging their card, but that is not covered in this document.
\n
To be able to fulfil the obligations of the stored credential framework, weβve added the following 4 new input fields to our real-time API functions:
\n| Input Parameter | Description |
|---|---|
CardAuthorizationType | Used to specify the nature of the authorization. See below for allowed values. See here for possible values. |
CardStorageType | Used to specify if you are storing the card you are providing, and whether or not it is CIT or MIT. See here for possible values. |
Required for compliance for CIT / MIT on certain endpoints
\nCardAuthorizationType - required when making a live tokenised card transaction
CardStorageType - required when charging stored card via saved card transaction
Youβll need to follow these steps whenever you will be processing ongoing payments on a card you are intending to store:
\nIf this is the first transaction you are processing on a card you have received:
\nSet the CardAuthorizationType to one of these 3 values:
\nRECURRING, INSTALMENT, UNSCHEDULED.When you process a subsequent transaction on the stored card:
\nCIT_PAYFAC_STORED or MIT_PAYFAC_STOREDdepending on whether the customer initiated the transaction or not.\n\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"33b8641c-e53d-43d7-873e-b17db7086a7a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"70767483-1e47-4b50-a86c-63afe37ed454","type":"text/javascript","exec":[""]}}],"_postman_id":"eec38929-7677-459c-81db-707dfe64e3bf"},{"name":"Data Models","item":[{"name":"3-D Secure Authorization Info","item":[],"id":"ab12abbb-2ef1-4468-9af5-89581ac0ab96","description":"While we have mentioned Visa as being the initiating organisation of this framework, the same requirements apply for all card types, so follow the same process above for all other card types such as Mastercard and AMEX.
\n
| Property | Type | Description |
|---|---|---|
authVersion* | string | This needs to be set to the version of the 3-D Secure service which was used to authenticate the transaction. Currently only 3-D Secure v2 is supported. |
authEci* | string | This is set to the Electronic Commerce Indicator (ECI) which indicates the outcome of the 3DS verification. Must be a two-digit number. Allowed values:
|
authValue* | string | This is set to the the cryptographic value that provides evidence of the outcome of a 3DS verification.
|
authTransactionId* | string | This is set to the the unique authentication transaction identifier, generated by the issuer. It follows RFC 4122 UUID standard and is 36 characters in length. |
| Property | \nType | \nDescription | \n
|---|---|---|
status | \n 3D Secure Authorization Status | \nThe result of the 3-D Secure verification | \n
| Property | \nType | \nDescription | \n
|---|---|---|
line1 | \n string(100) | \nBuilding and street details (line 1) | \n
line2 | \n string(100) | \nBuilding and street details (line 2) | \n
suburb | \n string(50) | \nCity, suburb or town | \n
state | \n string(50) | \nState or territory | \n
postCode | \n string(20) | \nPostal or ZIP code | \n
country | \n string(50) | \nCountry name | \n
Can be used to provide tracking information of the user of your system who is performing the action
\n| Property | \nType | \nDescription | \n
|---|---|---|
username | \n string(50) | \nName/reference of a user, or process identifier, from your system which initiated the API call | \n
userIP | \n string(20) | \nIP address of the user or process from your system which initiated the API call | \n
| Property | \nType | \nDescription | \n
|---|---|---|
accountBranch* | \n integer(3..14) | \nBank account branch identifier (e.g. BSB or routing number) | \n
accountNumber* | \n integer(3..20) | \nBank account number | \n
accountName* | \n string(4..50) | \nAccount holder name | \n
accountType | \n Bank Account Type | \nAccount type | \n
audit | \n Audit | \nCan be used to provide tracking information of the user of your system who is performing the action | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"b3053db2-716a-4dbd-b970-932ca7e4236f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b57f7c9d-e688-489c-a1ae-f0f9b63ed902","type":"text/javascript","exec":[""]}}],"_postman_id":"f843b64f-e84d-4e39-a671-d7aa5d2025d1","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Bank Account Search","item":[],"id":"252b4223-a3d6-4690-bc3b-bdaca6ab8d7d","description":"| Property | \nType | \nDescription | \n
|---|---|---|
accountBranch* | \n string | \nBank account branch identifier (e.g. BSB or routing number) | \n
accountNumber* | \n string | \nBank account number | \n
accountName* | \n string | \nAccount holder name | \n
accountType | \n Bank Account Type | \nAccount type | \n
| Property | \nType | \nDescription | \n
|---|---|---|
billerCode | \n string | \nBPAY Biller Code | \n
crn | \n string | \nBPAY Unique Customer Reference Number (CRN) | \n
* Required
\n^ Conditional
\n","event":[{"listen":"prerequest","script":{"id":"09041365-24ca-40ac-8fce-bb574ccfe9de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb25c837-e30c-49ef-84e3-334fca863e5c","type":"text/javascript","exec":[""]}}],"_postman_id":"abb387ea-4ec8-4880-a6cc-17197ddf98be","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"BPAY CRN Search","item":[],"id":"077bac18-f664-407a-b72d-4681e2dfc28e","description":"","event":[{"listen":"prerequest","script":{"id":"f71a8cde-3f94-4bd0-8625-795afb16ce48","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"50897811-d5db-4037-936b-acc416c60979","type":"text/javascript","exec":[""]}}],"_postman_id":"077bac18-f664-407a-b72d-4681e2dfc28e","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Browser Info","item":[],"id":"b71b2258-d074-4ca9-8e8c-11c00e56c15c","description":"3-D Secure Only - When using 3-D Secure, in order for the card's issuing bank to provide a challenge UI to your customer that is rendered appropriately for the device that your customer is using, the 3-D Secure system requires you to collect and pass-through information on the following information about the browser that your customer is using.
\n| Property | \nType | \nDescription | \n
|---|---|---|
UserAgent | \n string | \nThe value of the \"user-agent\" HTTP header. | \n
AcceptHeader | \n string | \nThe value of the \"accept\" HTTP header. | \n
Language | \n string | \nName of the browser language as defined in IETF BCP47.\n\n Can be obtained from the \"navigator.language\" javascript property. | \n
TimeZone | \n string | \nDefined as the number of minutes between UTC Time and cardholder's browser local time.\n\n Can be obtained from the \"new Date().getTimezoneOffset();\" javascript function. | \n
ColorDepth | \n int | \nThe bit depth of the colour palette for displaying images, in bits per pixel.\n\n Can be obtained from the \"screen.colorDepth\" javascript property. | \n
ScreenHeight | \n int | \nTotal height of the Cardholderβs screen in pixels.\n\n Can be obtained from the \"screen.height\" javascript property. | \n
ScreenWidth | \n int | \nTotal width of the cardholderβs screen in pixels.\n\n Can be obtained from the \"screen.width\" javascript property. | \n
JavaEnabled | \n boolean | \nWhether for not the cardholder's browser is able to execute Java.\n\n Can be obtained from the \"navigator.javaEnabled\" javascript property. | \n
| Property | \nType | \nDescription | \n
|---|---|---|
businessId | \n string | \nID of the associated business | \n
businessName | \n string | \nName of the associated business | \n
| Property | \nType | \nDescription | \n
|---|---|---|
businessId | \n string | \nID of the associated business | \n
businessName | \n string | \nName of the associated business | \n
status | \n Business Status | \nCurrent status of the business | \n
businessKey / GUID | \n string | \nGUID that identifies your business which is used for some of our hosted payment services | \n
| Property | Type | Description |
|---|---|---|
cardNumber\\* | integer(14,16) | Full card number (PAN) - numbers only, no spaces |
cardholderName\\* | string(3,50) | Name of the cardholder as shown on the card |
expiryYear\\* | integer(4) | Year of the card's expiry date, from 2010 to 2070 |
expiryMonth\\* | integer(1,2) | Month of the card's expiry date, from 1 to 12, no leading 0s. |
ccv\\* | string(3,4) | CCV/CVV number on the card (3 or 4 digit number) |
audit | Audit | Can be used to provide tracking information of the user of your system who is performing the action |
* Required
\n","event":[{"listen":"prerequest","script":{"id":"9597aac3-eb27-4754-a668-587650014677","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0c9a804f-14ec-4bff-8af4-46f964ca7ab0","type":"text/javascript","exec":[""]}}],"_postman_id":"4fbcd7c2-8508-46fa-8b96-c978a29deac2","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Card Bin","item":[],"id":"b78492c2-8720-4351-b0d0-6d031c9ff9ee","description":"| Property | \nType | \nDescription | \n
|---|---|---|
cardBin | \n integer(6) | \nThe 6-digit card BIN number that you searched for | \n
countryID | \n string | \n3-digit ISO country code for the country in which the card was issued | \n
cardBrand | \n Card Brand | \nWill be one of the card brand eg: VISA, MASTERCARD, AMERICAN EXPRESS etc | \n
cardType | \n String | \nCredit / Debit etc | \n
cardCategory | \n string | \nWill contain a description if the bank has registered this card for a specific purpose | \n
bank | \n string | \nThe name of the bank through which the card was issued | \n
| Property | \nType | \nDescription | \n
|---|---|---|
cardNumber | \n string | \nCard number (PAN) - first 6 and last 4 digits only (rest masked with 'x') | \n
cardholderName | \n string | \nCardholder's name | \n
cardExpires | \n date | \nCard expiry date | \n
cardType | \n Card Type | \nType/issuer of card | \n
| Property | Type | Description |
|---|---|---|
processType^ | How the transaction is to be processed | |
reference^ | string(100) | Unique reference you provide to identify the transaction (must be unique across all your transactions) |
amount^ | decimal | Amount of the transaction (include decimal point for currencies with cents) |
description | string (128) | You can provide additional information to describe the transaction |
source | string | This is used only for special case scenarios - we will inform you if your business needs to provide anything for this field. |
card^ | Details of the credit card being charged. | |
payer^^ | Details of the payer/customer making the transaction. PLEASE NOTE: It is recommended that you pass through as many of the details of the payer that you have for the purposes of reducing the risk of fraud and chargebacks. | |
audit | Can be used to provide tracking information of the user of your system who is performing the action | |
callbackUrl^^ | URL | 3-D Secure Only - if you are using 3-D Secure, you need to supply a URL to which your customer will be redirected back to if they where required to perform a challenge verification (see here) |
browserInfo^^ | 3-D Secure Only - if you are using 3-D Secure, in order for the cardβs issuing bank to provide a challenge UI to your customer that is rendered appropriately for the device that your customer is using, the 3-D Secure system requires you to collect and pass-through information on the configuration of the browser that your customer is using (see here) | |
cardStorageType^^ | CIT/MIT Field- Used to specify if you are storing the card you are providing, and whether or not it is a customer initiated transaction (CIT) or a merchant initiated transaction (MIT). | |
cardAuthorizationType^^ | CIT/MIT Field- Used to specify the nature of the authorization. | |
profile | integer (must be 1, 2) | For use with businesses using fee profiling functions to specify which fee set they wish to be charged for this transaction. |
use3ds | boolean | If your business has been enabled for optional 3-D Secure useage, you can set this field to true to trigger the 3-D Secure authentication process when the transaction is submitted. When using this field you will be required to provided all the 3-D Secure related fields above (namely \"callbackUrl\", \"browserInfo\" and \"payer.email\"). |
threeDSecureResult | If your business has been enabled for self-serve 3-D Secure via an external MPI, once you have completed a successful 3-D Secure authorization from within your systems, you can provide all the results of the authentication through this field. |
^ Required
^^ Required for compliance with CIT / MIT when operating in the UK
| Property | \nType | \nDescription | \n
|---|---|---|
reference* | \n string(100) | \nUnique transaction reference to identify the transaction update in your system | \n
description | \n string (128) | \nYou can provide extra information to describe the reason for the update | \n
amount | \n decimal | \nAmount to be applied to the transaction. If not provided the full amount of the transaction will be applied. Please Note: For reversals the amount is ignored. | \n
audit | \n Audit | \nCan be used to provide tracking information of the user of your system who is performing the action | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"3b53b87a-17ac-404b-8554-f4ec41b240b6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"80cfa7c4-68e8-4fd8-b65b-7cb24e4eb648","type":"text/javascript","exec":[""]}}],"_postman_id":"a5c13037-6a2c-4828-9f03-078008a4fe92","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Card Token","item":[],"id":"03a42d49-ab35-408d-bc71-81346a40dd3b","description":"| Property | \nType | \nDescription | \n
|---|---|---|
token | \n string | \nToken that card be used in place of credit card details | \n
| Property | \nType | \nDescription | \n
|---|---|---|
errorCode | \n Error Code | \nCode, number, or name identifier for the type of error (can be used for programmatic parsing and usage) | \n
errorMessage | \n string | \nHuman readable message describing the error (should never be used programmatically) | \n
errorDetail | \n string | \nSome types of errors may contain additional data that is relevant to the issue | \n
| Property | \nType | \nDescription | \n
|---|---|---|
token* | \n string | \nThe token you received for a card you previously tokenzied using our JavaScript services | \n
sessionId* | \n string(10,32) | \nA globally unique ID which identifies the session of your user. must be between 10 and 32 characters, contain no spaces, and contain no symbols expect - and _. It is recommended that you use a GUID with the \"-\" removed, or used your web server's session id. This id must be the same as the session ID your provided to the JavaScript Fraud Data Collector (see our Fraud Management Guide for more information on this). | \n
transactionAmount* | \n decimal | \nThe transaction amount that you intend to process | \n
ipAddress* | \n string | \nThe IP Address of your customer/user | \n
payer* | \n Fraud Check Payer | \nInformation you have gathered about your customer. A minimum of the email address is required. | \n
airlineInfo | \n Fraud Check Airline Info | \nIf you are processing airline tickets you need to specify these details. | \n
hotelInfo | \n Fraud Check Hotel Info | \nIf you are processing a hotel booking you need to specify these details. | \n
callbackUrl | \n url | \nIn case the risk of the transaction necessitates the use of 3-D Secure, you need to specify the URL within your website that your customer will be redirected back to once they have completed the 3-D Secure process. | \n
audit | \n Audit | \nCan be used to provide tracking information of the user of your system who is performing the action | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"4f1389d0-f4cc-4e0a-a048-266e8ba64eba","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"da1d2118-f502-4fdd-a96a-0329e752c77b","type":"text/javascript","exec":[""]}}],"_postman_id":"9be15e39-08c0-447f-b938-a258ef225178","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Fraud Check Payer","item":[],"id":"1836a637-8184-45fb-8f92-80361bb62604","description":"| Property | \nType | \nDescription | \n
|---|---|---|
familyOrBusinessName | \n string | \nFamily/last name or business name of the payer | \n
givenName | \n string | \nGiven/first name of the payer | \n
billingAddress | \n Address | \nBilling address of the payer | \n
email* | \n Email Address | \nEmail address of the payer | \n
phone | \n Phone Number | \nPhone number of the payer | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"366f2cb7-caf7-4dde-9ea0-56a5797380ab","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a4b51bfa-0582-4310-8e22-90d71c281d30","type":"text/javascript","exec":[""]}}],"_postman_id":"1836a637-8184-45fb-8f92-80361bb62604","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Fraud Check Result","item":[],"id":"21599873-9159-428e-a631-04050d3a9764","description":"| Property | \nType | \nDescription | \n
|---|---|---|
result | \n Fraud Check Result | \nThe result of our evaluation of the risk of the transaction, and instructions for next step if applicable | \n
resultMessage | \n string | \nA human readable description of the result of the fraud check (not intended for programmatic passing) | \n
redirectUrl | \n string | \nIf the Result specifies that 3-D Secure should be used, this is the URL you need to redirect your customer to. | \n
| Property | \nType | \nDescription | \n
|---|---|---|
carrier* | \n string | \nThe carrier selling the ticket | \n
flightCode* | \n string | \nAirline code/number of the flight being purchased | \n
flightDate* | \n DateTime | \nThe date on which the flight is departing | \n
isReturnTicket* | \n boolean | \nWhether or not a return ticket is being purchased | \n
origin* | \n string | \nCountry or Airport of origin of the flight (2 or 3-letter ISO country code or 3-letter IATA airport code) | \n
destinations* | \n string | \nComma separated list of destination countries or airports of the flight (2-letter or 3-letter ISO country codes or 3-letter IATA airport codes) | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"d22930f3-abcc-4431-ba09-40abe958052f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d03942da-a006-41b5-ac3e-c71aa4e6d669","type":"text/javascript","exec":[""]}}],"_postman_id":"d9749cc5-0db4-4b2f-a162-450d4e9f5d56","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Fraud Check Hotel Info","item":[],"id":"b1f56a2d-1bfc-429d-9633-bc6766f9aa28","description":"If you are running for fraud check for processing hotel reservations you need to specify these details.
\n| Property | \nType | \nDescription | \n
|---|---|---|
guestName* | \n string | \nFull name of the primary guest | \n
guestCountryOfResidence* | \n string | \nCountry of residence of the primary guest (2-letter or 3-letter ISO country code) | \n
guestNationality* | \n string | \nNationality of the primary guest | \n
numberOfGuests* | \n integer | \nNumber of guests the booking is for | \n
durationOfStay* | \n integer | \nNumber of days being booked | \n
checkInDateTime* | \n DateTime | \nDate/time of check-in | \n
hotelName* | \n string | \nName of the hotel the booking is for | \n
hotelCity* | \n string | \nCity in which the hotel is located | \n
hotelCountry* | \n string | \nCountry in which the hotel is located (2-letter or 3-letter ISO country code) | \n
hotelRoomType* | \n string | \nName/description of the type of room being booked | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"a62fa111-5ca9-4d52-b519-6b447998758d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cae5d645-12ba-459b-b67a-f965f3c20aa6","type":"text/javascript","exec":[""]}}],"_postman_id":"b1f56a2d-1bfc-429d-9633-bc6766f9aa28","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Invoice Input","item":[],"id":"613112c1-f874-49e8-bf98-f7861b5ab957","description":"* Required
\n","event":[{"listen":"prerequest","script":{"id":"3d197b30-3f82-4aec-92d2-9daff990dec1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ea608681-1e79-40d9-bcd5-7201f7d7828e","type":"text/javascript","exec":[""]}}],"_postman_id":"613112c1-f874-49e8-bf98-f7861b5ab957","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Invoice Payer","item":[],"id":"4be306e7-259c-4bae-a079-641ae9efd467","description":"* Required (and permitted only) if all other values are omitted.
\n** Required if uniqueReference is not specified.
| Property | \nType | \nDescription | \n
|---|---|---|
audit | \n Audit | \nOptional information to allow you to audit the use of your data. | \n
| Property | \nType | \nDescription | \n
|---|---|---|
business | \n Business Info | \nInfo of the business the payer is attached to. | \n
payerId | \n string | \nOur unique payer identifier. | \n
status | \n Payer Status | \nOverall current processing status of the payer (see the \"StatusCode\" field for more information on the payer status). | \n
statusCode | \n string | \nCode for the current processing status of the payer. | \n
statusDescription | \n string | \nHuman readable description of the meaning of the StatusCode. | \n
statusChangeDate | \n DateTime | \nDate/Time on which the last change of status occured to the payer. | \n
createdTime | \n DateTime | \nDate/Time when the payer was first added to the system. | \n
schedule | \n Payer Schedule Info | \nIf the payer has a payment schedule generated for them this will contain the details of the schedule. | \n
audit | \n Audit | \nCan be used to provide tracking information of the user of your system who is performing the action | \n
| Property | \nType | \nDescription | \n
|---|---|---|
newStatus* | \n Payer Change Status | \nCode for the status that you want to change the payer to. | \n
newStatusChangeDate | \n date | \nIf you are changing the payer to one of the following statuses you need to provide the date on which with the status change will be triggered: A-UDS = Active - Until Date (Suspend), A-UDC = Active - Until Date (Cancel) , S-DTE = Suspend - Until Date | \n
audit | \n Audit | \nCan be used to provide tracking information of the user of your system who is performing the action | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"4423f758-aeea-41a7-9594-1f96e6a82088","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fd3ab3b3-0626-4673-8ca8-6b45daafbeba","type":"text/javascript","exec":[""]}}],"_postman_id":"f37feb2e-c02d-4650-abab-5c1fc7d7cb19","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Payer Extra Info","item":[],"id":"5a05af11-9248-4e71-a40d-65d564c42e08","description":"","event":[{"listen":"prerequest","script":{"id":"becd73f4-3eac-406c-95df-16462f37d698","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2bb7c58b-3362-489c-adc2-a3d33d983147","type":"text/javascript","exec":[""]}}],"_postman_id":"5a05af11-9248-4e71-a40d-65d564c42e08","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Payer ID","item":[],"id":"f9988f13-3746-4ceb-aa20-8eb22d85883d","description":"","event":[{"listen":"prerequest","script":{"id":"3b642cd6-c4df-4fca-b535-ad059e476a3b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"05b518ac-417b-4649-abaa-0952908fff5b","type":"text/javascript","exec":[""]}}],"_postman_id":"f9988f13-3746-4ceb-aa20-8eb22d85883d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Payer Input","item":[],"id":"253a8278-5872-4808-b98c-634bb4fcc0da","description":"* Required
\n** Required for UK in order to comply with direct debit requirements
\n","event":[{"listen":"prerequest","script":{"id":"2a5b152f-f881-4dc9-8da0-c988671e6809","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e18c0191-f330-4dbc-8ee2-3f07ed772d74","type":"text/javascript","exec":[""]}}],"_postman_id":"253a8278-5872-4808-b98c-634bb4fcc0da","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Payer Schedule Info","item":[],"id":"abdeeb98-86ba-4952-aac1-e20d08ca581e","description":"","event":[{"listen":"prerequest","script":{"id":"abe3bb5d-35f0-4b5e-a55d-36d71fe9971a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"11fb9756-b552-496f-aff4-8df0cf8f5ca9","type":"text/javascript","exec":[""]}}],"_postman_id":"abdeeb98-86ba-4952-aac1-e20d08ca581e","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Payer Search","item":[],"id":"7101dbfb-8bb0-4da0-a8a6-df6d756e37f0","description":"","event":[{"listen":"prerequest","script":{"id":"d306ee0c-a947-4ac5-9dcf-ceb6f244e2e3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f8a3a156-2333-4d63-853a-961ddff138b4","type":"text/javascript","exec":[""]}}],"_postman_id":"7101dbfb-8bb0-4da0-a8a6-df6d756e37f0","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"PayTo - Agreement ID Model","item":[],"id":"5600297c-1003-495d-873e-e88013d352b7","description":"","_postman_id":"5600297c-1003-495d-873e-e88013d352b7","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"PayTo - Agreement Input Model","item":[],"id":"6125ab6e-53a5-40af-af9d-6dc9e0c2459e","description":"*Required
\n^ Conditional
\n","_postman_id":"6125ab6e-53a5-40af-af9d-6dc9e0c2459e","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"PayTo - Agreement Payment Search Model","item":[],"id":"75614bac-8b5c-45cf-b948-76933519305b","description":"","_postman_id":"75614bac-8b5c-45cf-b948-76933519305b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"PayTo - Agreement Search Model","item":[],"id":"f4844771-5d7c-459b-90f5-37c2c4a67005","description":"","_postman_id":"f4844771-5d7c-459b-90f5-37c2c4a67005","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"PayTo - Agreement Status Update Model","item":[],"id":"e0b8e402-2161-40b3-a956-7ad4c56ba674","description":"","_postman_id":"e0b8e402-2161-40b3-a956-7ad4c56ba674","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"PayTo - Payment ID Model","item":[],"id":"aead282b-d9cb-4ab0-b04f-92bacdad4ad8","description":"","_postman_id":"aead282b-d9cb-4ab0-b04f-92bacdad4ad8","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"PayTo - Payment Model","item":[],"id":"f81b5a3f-ff2b-4588-bdb5-d4a371d0bab5","description":"","_postman_id":"f81b5a3f-ff2b-4588-bdb5-d4a371d0bab5","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"PayTo - Webhook Message Model","item":[],"id":"4d094f05-dc13-4d49-912b-d7fbcea35328","description":"","_postman_id":"4d094f05-dc13-4d49-912b-d7fbcea35328","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Point-of-Sale Card","item":[],"id":"f5b2aaa7-6e00-4ff8-8de9-cf2e7036c9b5","description":"| Property | \nType | \nDescription | \n
|---|---|---|
maskedCardNumber* | \n string(14,16) | \n\n Masked number of the card that was processed including the first 6 and last 4 digits of the number (e.g. 411111xxxxxx1234). The full card number must not be provided here, however the first 6 digits are required in order to determine the BIN of the card for settlement and fee charging\n | \n
cardholderName* | \n string(3,50) | \nName of the cardholder as shown on the card | \n
expiryYear* | \n integer(4) | \nYear of the card's expiry date, from 2010 to 2070 | \n
expiryMonth* | \n integer(1,2) | \nMonth of the card's expiry date, from 1 to 12 | \n
cardType* | \n Card Type | \nType/issuer of the card | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"9c5a23c7-995c-4791-9ac4-39a5f58562d0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dc0f3b64-284a-4c48-bee1-828b7db92e2b","type":"text/javascript","exec":[""]}}],"_postman_id":"f5b2aaa7-6e00-4ff8-8de9-cf2e7036c9b5","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Point-of-Sale Transaction","item":[],"id":"a099b4c2-f127-4981-a632-47ae8382a835","description":"* Required
\n","event":[{"listen":"prerequest","script":{"id":"77d719b5-2bc0-44f6-bfe8-13593bb46be7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e346de96-50a1-4d8c-98e3-7622cf418dcc","type":"text/javascript","exec":[""]}}],"_postman_id":"a099b4c2-f127-4981-a632-47ae8382a835","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Point-of-Sale Transaction Result","item":[],"id":"9b015077-136f-46a6-b90e-09b00f55dff4","description":"","event":[{"listen":"prerequest","script":{"id":"98259fd6-a2a7-4c5c-8d74-708ebd098c9e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"21ff6984-6d66-47f1-9f3f-56fe81256fc2","type":"text/javascript","exec":[""]}}],"_postman_id":"9b015077-136f-46a6-b90e-09b00f55dff4","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Schedule Change Amounts","item":[],"id":"17afa275-af15-4e18-bfd2-6f5467e162fd","description":"* Required
\n","event":[{"listen":"prerequest","script":{"id":"fdadc2ca-7434-4a87-96da-94812bbe9e11","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c89e849a-2ed2-40cc-8da5-c166628b439f","type":"text/javascript","exec":[""]}}],"_postman_id":"17afa275-af15-4e18-bfd2-6f5467e162fd","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Schedule Generate","item":[],"id":"5b73ab32-fe9b-464f-ba9b-1558b09ad9e2","description":"* Required
\n** Note - In the UK, a Bank Account direct debit schedule must allow for at least 6 business days notice before the payment due date.
\n","event":[{"listen":"prerequest","script":{"id":"28630a48-8a5d-4648-bc5b-45b5e787f849","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"db5673ce-44c3-4acc-b640-63baf2e63faf","type":"text/javascript","exec":[""]}}],"_postman_id":"5b73ab32-fe9b-464f-ba9b-1558b09ad9e2","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Schedule Payment","item":[],"id":"6627b71d-507d-4554-a26d-1e460ad71ef1","description":"* Required
\n** Note - In the UK, a Bank Account direct debit schedule must allow for at least 6 business days notice before the payment due date.
\n","event":[{"listen":"prerequest","script":{"id":"7451b541-0064-4026-a546-fdb4266e720f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fd6b4c55-a085-4dcd-87b2-d0386f72fdc0","type":"text/javascript","exec":[""]}}],"_postman_id":"6627b71d-507d-4554-a26d-1e460ad71ef1","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Schedule Search","item":[],"id":"9e0531e0-5c54-44a4-b07d-30f5bf22be69","description":"| Property | \nType | \nDescription | \n
|---|---|---|
business | \n Business | \nInfo of the business the payer is attached to | \n
scheduledPaymentId | \n string | \nUnique ID that identifies each scheduled payment | \n
date | \n date | \nDate on which the payment is scheduled to be processed | \n
amount | \n decimal | \nAmount of money that will be debited from the payer | \n
reference | \n string | \nYour reference for the payment (if you provided one) | \n
description | \n string | \nYour description of the payment (if you provided one) | \n
scheduleReference | \n string | \nIf you are using multiple schedules for each payer, this is the reference you provided to identify which schedule the payment belongs to | \n
isIndividualPayment | \n boolean | \nIdentifies if the payment was added individually (using the \"Schedule Single Payment\" function), or generated as part of an ongoing or limited schedule (using the \"Schedule Generate\" function) | \n
subBusinessId | \n string | \nOnly relevant for Head Office scenarios - if you scheduled a payment to one of your sub-businesses, this is the ID of the business that will receive the money. | \n
payer | \n Payer Basic Info | \nIf payer details were associated with the transaction they will be shown here | \n
| Property | \nType | \nDescription | \n
|---|---|---|
scheduledPaymentId | \n string | \nUnique ID that identifies the newly scheduled payment | \n
| Property | \nType | \nDescription | \n
|---|---|---|
settlementType | \n Settlement Type | \nThe type of addition/deduction that impacted the settlement | \n
dateIncurred | \n DateTime | \nDate on which the item was incurred | \n
description | \n string | \nDescription of the item | \n
amountSettled | \n decimal | \nThe portion of the amount of the transactions that was settled to you | \n
| Property | \nType | \nDescription | \n
|---|---|---|
ledgerId | \n string | \nUnique ID for this particular settlement item | \n
settlementType | \n Settlement Type | \nThe type of addition/deduction that impacted the settlement | \n
settlementTypeId | \n integer | \nThis can be used for additional identification of the type/category of the item | \n
dateIncurred | \n DateTime | \nDate on which the item was incurred | \n
description | \n string | \nDescription of the item | \n
amountSettled | \n decimal | \nThe amount this item either added to, or reduced, your total settlement | \n
transaction | \n Transaction Search Model | \nIf this item is directly associated with a transaction then full details of the transaction will be populated here, otherwise it will be null. | \n
* Required
\n** Required for 3DS
\n","event":[{"listen":"prerequest","script":{"id":"b3eb3bad-e2f3-46a3-a630-d07d9b6264bd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"be4e6e0a-7023-41ac-93a3-da93fe01ba8f","type":"text/javascript","exec":[""]}}],"_postman_id":"0415fb4b-43e5-468f-bf39-853432a71e44","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Tokenize Card","item":[],"id":"f6eba435-1511-474d-8067-1e0c1b01f884","description":"| Property | \nType | \nDescription | \n
|---|---|---|
card* | \n Card | \nDetails of the card to be tokenized | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"cb0eb5c2-77e6-4455-9cf7-3c87e1e0b9a1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bca9dbcf-0718-4889-9c84-3dc376db2b1a","type":"text/javascript","exec":[""]}}],"_postman_id":"f6eba435-1511-474d-8067-1e0c1b01f884","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Transaction Result","item":[],"id":"7828289b-5a94-4c43-81c3-cf955e6e16bd","description":"| Property | \nType | \nDescription | \n
|---|---|---|
transactionId | \n string(100) | \nThe transaction reference provided to you from the bank/gateway that processed the transaction | \n
reference | \n string | \nUnique reference you provided to identify the transaction | \n
statusCode | \n Transaction Result Status Code | \nCode that specifies whether or not the transaction was successfully processed. | \n
subStatusCode | \n Transaction Sub-Status Code | \nAdditional information describing the transaction result such as the reason for the rejection if the transaction could not be processed | \n
statusDescription | \n string | \nHuman readable description of the status result | \n
processedAmount | \n decimal | \nAmount of the transaction that was processed | \n
cardType | \n Card Type | \nType of card | \n
redirectId | \n string | \n3-D Secure Only - if you are using 3-D Secure, and if the challenge scenario has been triggered, this will contain and ID that you need to store for later use with completing your transaction once your customer is redirected back to your website (see here). | \n
redirectUrl | \n url | \n3-D Secure Only - if you are using 3-D Secure, and if the challenge scenario has been triggered, this will contain the URL that you must redirect your customer to in order for them to complete the verification process (see here). | \n
| Property | \nType | \nDescription | \n
|---|---|---|
transactionId | \n int | \nOur unique TransactionId that identifies the payment obtained from the \"New Status Search\". | \n
statusCode | \n Transaction Status Code | \nThe \"StatusCode\" that the transaction had when you downloaded it from \"New Status Search\" - this is provided as a safety measure just in case the status of the transaction changes in the time between when the transaction details are downloaded and we are notified of the status being received and processed via this function. | \n
audit | \n Audit | \nCan be used to provide tracking information of the user of your system who is performing the action | \n
| Property | Type | Description |
|---|---|---|
returnUrl\\* | string(500) | An optional string that specifies a URL in which to redirect the user after completion of the request. |
template\\* | string(255) | The Guid or Name of a custom HPP Template that our team have setup for you based on your businesses requirements. |
ServiceDate | Start Date Service will be provided | |
transaction\\* | Details of the real-time transaction that you want to process. | |
payer | Optional, but it is recommended that you provide as much payer information as possible to help prevent payment failures and chargebacks. | |
audit | Can be used to provide tracking information of the user of your system who is performing the action. |
| Property | Type | Description |
|---|---|---|
uniqueReference | string(100) | Unique reference that identifies the payer within your systems. Must be unique within each business. π If you provide an existing uniqueReference this transaction will be recorded against that payer.[Required when saving payers and recurring PayID payments] |
groupReference | string(100) | Optional secondary reference to identify the payer within your systems that doesn't need to be unique (e.g. it can be used as a grouping reference for related payers) |
familyOrBusinessName ^ | string(50) | Family/last name or business name of the payer. [Required when saving payers] [^Required when accepting Digital Wallet] |
givenName ^ | string(50) | Given/first name of the payer [^Required when accepting Digital Wallet] |
email ^ | Email address of the payer [^Required when accepting Digital Wallet] | |
phone | Phone number of the payer | |
mobile | Mobile (cell) phone number of the payer | |
address | Address of the payer | |
extraInfo | Optional additional settings that can be used to define the functions and services used with this payer | |
savePayer ^ | boolean | If your account is enabled for payer storage can choose to save the payer for future payments (charges may apply) [^Property must be false to accept Digtal Wallet] |
* Required
\n^ Conditional - required when implementing Digital Wallet Payment acceptance.
\n","event":[{"listen":"prerequest","script":{"id":"d02f357f-1c77-45ee-873f-7c4b28b9bf5c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9bf1fe90-6335-4498-a481-5c0506e31fa5","type":"text/javascript","exec":[""]}}],"_postman_id":"8ed3c563-6f61-4b56-bbcd-98f06c46e2e1","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Token [HPP] Transaction","item":[],"id":"080f30c3-be80-4a36-ad46-9bb072c760df","description":"* Required
\n","event":[{"listen":"prerequest","script":{"id":"28d63eca-85ac-4b95-84ba-1a7b9f63c841","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"539ba9a6-d3af-42b5-be0d-eaea135d7629","type":"text/javascript","exec":[""]}}],"_postman_id":"080f30c3-be80-4a36-ad46-9bb072c760df","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Token [eDDR] Generate","item":[],"id":"1388122d-6510-4d52-a634-453275722be5","description":"* Required
\n","event":[{"listen":"prerequest","script":{"id":"be057a1f-1e2f-4825-aefe-bdb7aa8c504f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"42e62cd4-d1c5-400e-8f41-4883e3fe4a54","type":"text/javascript","exec":[""]}}],"_postman_id":"1388122d-6510-4d52-a634-453275722be5","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Token [eDDR] Payer","item":[],"id":"818ae26e-bcc3-4f93-99e0-30565243e312","description":"* Required
\n** Required for UK in order to comply with direct debit requirements
\n","event":[{"listen":"prerequest","script":{"id":"6106efe0-56e1-4354-b241-d7378eb99bf3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a00dc537-142a-4651-82aa-8f3401d702fb","type":"text/javascript","exec":[""]}}],"_postman_id":"818ae26e-bcc3-4f93-99e0-30565243e312","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Token [Vault] Generate","item":[],"id":"dd0271a3-843a-4e5b-bbd7-a40c86e8e37f","description":"| Property | \nType | \nDescription | \n
|---|---|---|
returnUrl* | \n string(500) | \nAn string that specifies a URL in which to redirect the user after completion of the request. | \n
payer* | \n Token [Vault] Payer Model | \nInformation on the payer you wish to save a payment method to. | \n
audit | \n Audit | \nCan be used to provide tracking information of the user of your system who is performing the action. | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"be057a1f-1e2f-4825-aefe-bdb7aa8c504f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"42e62cd4-d1c5-400e-8f41-4883e3fe4a54","type":"text/javascript","exec":[""]}}],"_postman_id":"dd0271a3-843a-4e5b-bbd7-a40c86e8e37f","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Token [Vault] Payer","item":[],"id":"649b730f-9830-468d-8bf9-ac39ae2cfdbc","description":"* Required
\n^ Conditional - required when AddIfNotExists = true
\n","event":[{"listen":"prerequest","script":{"id":"6106efe0-56e1-4354-b241-d7378eb99bf3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a00dc537-142a-4651-82aa-8f3401d702fb","type":"text/javascript","exec":[""]}}],"_postman_id":"649b730f-9830-468d-8bf9-ac39ae2cfdbc","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Token Lookup","item":[],"id":"38a9fb7f-df82-4ca9-82ef-1558ae196562","description":"| Property | \nType | \nDescription | \n
|---|---|---|
token | \n guid | \nThe unique token generate for use with a hosted service | \n
type | \n Token Type | \nThe type of service the token was generated for | \n
time | \n DateTime | \nDate/Time when the token was generated | \n
status | \n Token Status | \nThe current status of the token | \n
statusDescription | \n string | \nAdditional information on the token status (if any). | \n
returnUrl | \n string | \nThe URL that you provided when you generated the token that we use to redirect your customer back to your website after completion of the request. | \n
redirectToUrl | \n string | \nThe URL we provided you along with the token which you use to redirect your customer to our hosted service. | \n
template | \n guid | \nThe Guid/ID of the hosted services template that will be used with this token. | \n
templateName | \n string | \nThe name of the hosted services template that will be used with this token | \n
transaction | \n Transaction Search | \nIf a transaction was generated through the use of this token, the full details of the transaction and its current status is included here. | \n
payer | \n Payer | \nIf a payer was generated through the use of this token, the full details of the payer is included here. | \n
RequestHpp | \n Token Generate HPP | \nContains the contents of your original request to generate a HPP token. | \n
events | \n Event | \nThe events that have occured with this token. | \n
* Required
\n","event":[{"listen":"prerequest","script":{"id":"68c14018-34c8-41f5-b6f2-0af7faae311e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0e020c82-9dbe-4272-8104-7c804f0d8fa5","type":"text/javascript","exec":[""]}}],"_postman_id":"38a9fb7f-df82-4ca9-82ef-1558ae196562","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Token Result","item":[],"id":"98328d5b-e4f9-4eea-8d0d-fecbe4a962d3","description":"","event":[{"listen":"prerequest","script":{"id":"069909b2-8a9e-462c-bdce-0253c47a4721","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9f2fbeb9-ecea-4d68-9eba-11b998bc881c","type":"text/javascript","exec":[""]}}],"_postman_id":"98328d5b-e4f9-4eea-8d0d-fecbe4a962d3","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","id":"31fce60d-390a-4054-b69e-b7bc6cded2a7","name":"Data Models","type":"folder"}}},{"name":"Token Status","item":[],"id":"50600910-218e-4852-9745-2561790c602e","description":"| Property | \nType | \nDescription | \n
|---|---|---|
statusCode | \n Token Status Code | \nThe status of the token in relation to processing. | \n
statusDescription | \n string | \nA human readable description of the Status. | \n
transactionResult | \n Transaction Result | \nResult of a transaction process attempt. | \n
audit | \n Audit | \nOptional information to allow you to audit the use of your data. | \n
| Property | \nType | \nDescription | \n
|---|---|---|
event | \n Token Status | \nThe event that has occured with the token. | \n
time | \n DateTime | \nThe date/time of the Event. | \n
Description | \n string | \nA human readable description of the Event. | \n
username | \n string | \nDetails of the user logged with the event (if any). | \n
ip | \n string | \nThe IP address logged with the event. | \n
| Property | Type | Description |
|---|---|---|
processType^ | How the transaction is to be processed | |
reference^ | string(100) | Unique reference you provide to identify the transaction (must be unique across all your transactions) |
amount^ | decimal | Amount of the transaction (include decimal point for currencies with cents) |
description | string (128) | You can provide additional information to describe the transaction |
cardToken^applepaytoken^googlepaytoken^ | string | Token obtained from the 'Tokenize Card' function that can be used in place of the card details. If you are accepting wallet payments from ApplePay or GooglePay, your application will need to submit the correct property. For ApplePay, supply applepaytoken.For GooglePay, supply googlepaytoken. |
payer^^ | Details of the payer/customer making the transaction. PLEASE NOTE: It is recommended that you pass through as many of the details of the payer that you have for the purposes of reducing the risk of fraud and chargebacks. | |
audit | Can be used to provide tracking information of the user of your system who is performing the action | |
callbackUrl^^ | URL | 3-D Secure Only - if you are using 3-D Secure, you need to supply a URL to which your customer will be redirected back to if they where required to perform a challenge verification (see here) |
browserInfo^^ | 3-D Secure Only - if you are using 3-D Secure, in order for the cardβs issuing bank to provide a challenge UI to your customer that is rendered appropriately for the device that your customer is using, the 3-D Secure system requires you to collect and pass-through information on the configuration of the browser that your customer is using (see here) | |
cardAuthorizationType^^ | CIT/MIT Field- Used to specify the nature of the authorization if saving payment details. Possible values: (UNSCHEDULED / RECURRING / INSTALMENT) | |
profile | integer (must be 1, 2) | For use with businesses using fee profiling functions to specify which fee set they wish to be charged for this transaction. |
serviceDate | Date the service will be provided, ie Booking date. Optional. | |
use3ds^^ | boolean | If your business has been enabled for optional 3-D Secure useage, you can set this field to true to trigger the 3-D Secure authentication process when the transaction is submitted. When using this field you will be required to provided all the 3-D Secure related fields above (namely \"callbackUrl\", \"browserInfo\" and \"payer.email\"). |
^ Required
^^ Special conditions / Required for 3D-Secure usage
| Property | \nType | \nDescription | \n
|---|---|---|
bs | \n string | \nBank account branch identifier (e.g. BSB or routing number) | \n
branch | \n string | \nName of bank branch | \n
country | \n string | \nCountry name | \n
bank | \n string | \nName of Banking institution | \n
address | \n string | \nLine 1 of the bank address | \n
suburb | \n string | \nCity, suburb or town | \n
state | \n string | \nState or territory | \n
postCode | \n string | \nPostal or ZIP code | \n
| Value | \nDescription | \n
|---|---|
FAILED | \n 3-D Secure System failed to check the card - the 3-D Secure processor was not able to validate the card at this time | \n
NOTENROLLED | \n The customer has a card that is not registered for 3-D Secure or is of a type that can't be authorized via 3-D Secure | \n
OK | \n The customer has a card that supports 3-D Secure authorization, so you can proceed to redirect your customer to the 3-D Secure site | \n
SERVICEUNAVAILABLE | \n A system error has occurred that has prevented the 3-D Secure check from being processed | \n
** Required - for UK only
\n","event":[{"listen":"prerequest","script":{"id":"1cc8e20e-eeec-49eb-9adf-a9aa07c44d04","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f124b1b1-8787-4962-a470-50821e334ace","type":"text/javascript","exec":[""]}}],"_postman_id":"fc399f32-ab4a-4230-b961-70f56f9f426a","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","name":"Data Types","type":"folder"}}},{"name":"BPAY Invoice Type","item":[],"id":"821acfa4-fdb4-4552-8996-55cf034f4c23","description":"","event":[{"listen":"prerequest","script":{"id":"2e2cac03-985b-4828-9726-7d29c1c97ddf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"113dc666-79ce-4872-bb5f-e318ffa85cb6","type":"text/javascript","exec":[""]}}],"_postman_id":"821acfa4-fdb4-4552-8996-55cf034f4c23","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","name":"Data Types","type":"folder"}}},{"name":"BPAY Assignment Type","item":[],"id":"30593871-4d84-40ab-bfe1-3967be71c81e","description":"","event":[{"listen":"prerequest","script":{"id":"e90c7882-15f7-4df5-8474-0df3d25d64a0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6f797921-66e3-4744-8b1d-0a35dc099125","type":"text/javascript","exec":[""]}}],"_postman_id":"30593871-4d84-40ab-bfe1-3967be71c81e","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","name":"Data Types","type":"folder"}}},{"name":"Business Status","item":[],"id":"ae18df06-8bb4-488a-839b-ab0dfb72b30d","description":"| Value | \nDescription | \n
|---|---|
INACTIVE | \n Inactive | \n
OK | \n Active | \n
PROVISIONAL | \n Provisional | \n
WAITING_APPROVAL | \n Waiting approval | \n
Used to specify the nature of the authorization. See below for allowed values.
\n","_postman_id":"695e8363-6451-4d97-8ef3-ba35f0e67a95","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","name":"Data Types","type":"folder"}}},{"name":"Card Storage Type","item":[],"id":"72e87212-12d8-400c-9ad9-864714110469","description":"Used to specify if you are storing the card you are providing, and whether or not it is CIT or MIT (see here). See below for allowed values.
\n","_postman_id":"72e87212-12d8-400c-9ad9-864714110469","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","name":"Data Types","type":"folder"}}},{"name":"Card Transaction Process Type","item":[],"id":"f73a0e2f-1664-4b80-9199-dd6edd93f667","description":"| Value | \nDescription | \n
|---|---|
COMPLETE | \n Full sale - Funds are fully collected and ready to be settled to your business | \n
PREAUTH | \n Pre-authorisation only - Funds are reserved on the person's card and will not be collected until you use the Capture function. Pre-auths that aren't captured automatically expire (usually occurs within 2-3 days) | \n
VERIFY | \n This allows you to perform a zero-dollar pre-authorisation for the purpose of checking that a particular card is valid and active.\n\n It also assists in meeting card-on-file storage obligations, and customer-initiated-transaction/merchant-initiated-transaction mandates, by allowing you to verify a card using customer authentication before storage, and obtain a reference that can be provided with future recurring transactions on that card to link them to the initial authorisation. \nPLEASE NOTE: This ability is not currently available for all business setups and regions. Please contact us if you wish to use this function to confirm its availability. | \n
| Value | \nDescription | \n
|---|---|
AliPay | \n Alipay | \n
Amex | \n American Express | \n
Diners | \n Diners Club | \n
Discover | \n Discover | \n
JCB | \n JCB | \n
Mastercard | \n Mastercard | \n
PINDebit | \n PIN Debit | \n
Unknown | \n Card type not known | \n
Visa | \n Visa | \n
| Base Type | \nDescription | \n
|---|---|
| string(25) | \nISO 8601 format with UTC / timezone, excluding fractional seconds; e.g. 2018-01-09T11:07:15+00:00 | \n
| Base Type | \nDescription | \n
|---|---|
| string(254) | \nRegular expression: [A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])? | \n
| Value | \nDescription | \n
|---|---|
BadRequest | \n The request details were not valid. | \n
DuplicateInvoice | \n An invoice with the same identifier already exists. | \n
DuplicatePayer | \n A payer with the same identifier already exists. | \n
DuplicateTransaction | \n A transaction with the same identifier already exists. | \n
Forbidden | \n Your login does not have permission to access that information. | \n
FunctionNotAllowed | \n The requested function cannot be used at this time. | \n
InternalServerError | \n A server-side error occurred during processing of your request. | \n
InvalidApiToken | \n The specified api token identifier is not valid for your request. | \n
InvalidBusiness | \n The specified business identifier is not valid for your request. | \n
InvalidInvoice | \n The specified invoice identifier is not valid for your request. | \n
InvalidPayer | \n The specified payer identifier is not valid for your request. | \n
InvalidPaymentMethod | \n The specified card, bank account or orther payment method information is not valid for your request. | \n
InvalidScheduledPayment | \n The specified scheduled payment identifier is not valid for your request. | \n
InvalidTemplate | \n The specified template identifier is not valid for your request. | \n
InvalidTransaction | \n The specified transaction identifier is not valid for your request. | \n
LimitsExceeded | \n One of the transaction processing limits set for you business has been exceeded. | \n
NotFound | \n No resource matching the specified identifier was found. | \n
ServiceUnavailable | \n The requested service is unavailable currently. Please try again later. | \n
ThreeDSecureException | \n An error occurred during 3-D Secure validation. | \n
Timeout | \n A requested operation could not be completed in a reasonable time. | \n
TooManyRequests | \n Your request rate has exceeded your permissible limits. | \n
TooManyTransactions | \n Your transaction rate has exceeded your permissible limits. | \n
Unauthorized | \n The requested operation requires authorization. | \n
| Value | \nDescription | \n
|---|---|
PROCEED | \n Minimal risk of fraud - it is ok to immediately proceed to process the payment | \n
SUSPICIOUS_HIGH | \n Moderate risk of fraud - it is recommended that the transaction be reviewed or escalated | \n
SUSPICIOUS_LOW | \n Moderate risk of fraud - it is recommended that the transaction be reviewed or escalated | \n
DECLINE | \n High risk of fraud - the transaction should not be processed | \n
USE3DS | \n Moderate to High risk of fraud - your customer needs to be redirected to the 3-D Secure site specified in the \"RedirectUrl\" parameter to mitigate the risk. | \n
NO3DS | \n Use of 3-D Secure is not possible as the enrollment status of the customer's card could not be completed. You can make a determination of whether or not you want to proceed with the transaction. | \n
ERROR | \n An error occurred while performing the fraud check and the risk of fraud was not able to be determined at this time | \n
| Value | \nDescription | \n
|---|---|
CREATED | \n An invoice created event. | \n
EMAILED | \n An invoice emailed event (most recent email only). | \n
PAID | \n An invoice paid event. | \n
VOIDED | \n An invoice voided event. | \n
| InvoiceStatus | \nValue | \nDescription | \n
|---|---|---|
| 0 | \nPENDING | \n The invoice has not been paid. | \n
| 1 | \nPAID | \n The invoice has been paid. | \n
| 2 | \nVOIDED | \n The invoice has been voided. | \n
| 3 | \nOVERDUE | \n The invoice is overdue for payment. | \n
| Value | \nDescription | \n
|---|---|
A | \n Active | \n
A-FNL | \n Active - Contract Finalised | \n
A-NCT | \n Active - Unable to Contact | \n
A-UDC* | \n Active - Until Date (Cancel) | \n
A-UDS* | \n Active - Until Date (Suspend) | \n
C | \n Cancelled | \n
S | \n Suspended | \n
S-DBC | \n Suspend - Debt Collection | \n
S-DTE* | \n Suspend - Until Date | \n
S-INC | \n Suspend - Incomplete Setup | \n
S-MRJ | \n Suspend - Multiple Rejections | \n
S-NCT | \n Suspend - Unable to Contact | \n
* Use the statusChangeDate parameter with these statuses.
| Value | \nDescription | \n
|---|---|
A | \n Active | \n
A-BPAY | \n Active - BPAY | \n
A-CLP | \n Active - Cancellation Payment Plan | \n
A-CRR | \n Active - Cancellation Request Revoked | \n
A-EXT | \n Active - Extended Term | \n
A-FNL | \n Active - Contract Finalised | \n
A-NCE | \n Active - Unable to Contact (Extended) | \n
A-NCT | \n Active - Unable to Contact | \n
A-NEW | \n Active - New | \n
A-RNW | \n Active - Renewal | \n
A-SPC | \n Active - Suspension Period Completed | \n
A-UDC | \n Active - Until Date (Cancel) | \n
A-UDS | \n Active - Until Date (Suspend) | \n
ALL-A* | \n All Active Status Types | \n
ALL-C* | \n All Cancelled Status Types | \n
ALL-S* | \n All Suspended Status Types | \n
C | \n Cancelled | \n
C-ADM | \n Cancelled - Administration | \n
C-CPS | \n Cancelled - Payment Stop By Customer | \n
C-DED | \n Cancelled - Customer Deceased | \n
C-INA | \n Cancelled - Cancelled due to inactivity | \n
S | \n Suspended | \n
S-BAC | \n Suspended - Bank Account Closed | \n
S-BRR | \n Suspended - Waiting Bank Registration | \n
S-CLM | \n Suspended - Claim | \n
S-CRD | \n Suspended - Invalid Creditor Profile | \n
S-DBC | \n Suspended - Debt Collection | \n
S-DDR | \n Suspended - Invalid DDR provided | \n
S-DTE | \n Suspended - Until Date | \n
S-EXP | \n Suspended - Expired Credit Card | \n
S-IBA | \n Suspended - Invalid Bank Account Number | \n
S-IBB | \n Suspended - Invalid Bank Account BSB | \n
S-ICC | \n Suspended - Invalid Credit Card Data | \n
S-ICD | \n Suspended - Invalid Contact Details | \n
S-INC | \n Suspended - Incomplete Setup | \n
S-MOW | \n Suspended - Money Order | \n
S-MRJ | \n Suspended - Multiple Rejections | \n
S-NCT | \n Suspended - Unable to Contact | \n
S-PCL | \n Suspended - Pending Cancellation | \n
* Available for payer search only
\n","event":[{"listen":"prerequest","script":{"id":"3450e426-9a04-417a-b49b-d6dab8228fd5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e430704d-4361-4274-a184-7dba3cb15ef9","type":"text/javascript","exec":[""]}}],"_postman_id":"1356883b-008e-4390-a72f-772264ff3dd6","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","id":"4db792ba-b4b2-46d1-9b9b-0c981e2a4ddd","name":"Data Types","type":"folder"}}},{"name":"Payer Status","item":[],"id":"e3ac32c2-93fa-4d67-b922-ced05cfbc74d","description":"| Value | \nDescription | \n
|---|---|
ACTIVE | \n Active | \n
CANCELLED | \n Cancelled | \n
SUSPENDED | \n Suspended | \n
| Value | \nDescription | \n
|---|---|
ALIPAY | \n Alipay | \n
AMEX | \n American Express Card | \n
BANKACCOUNT | \n Bank Account | \n
BPAY | \n BPAY Payment | \n
CUP | \n Cup | \n
DINERS | \n Diners Club Card | \n
DISCOVER | \n Discover Card | \n
JCB | \n JCB Card | \n
MASTERCARD | \n Mastercard | \n
PINDEBIT | \n PIN Debit | \n
VISA | \n Visa Card | \n
CARD | \n Unidentified credit/debit card | \n
CASH | \n Cash | \n
CHEQUE | \n Cheque / check | \n
STORECREDIT | \n Store credit / Credit Note | \n
BANKTRANSFER | \n Bank Transfer / Direct Credit / ACH | \n
INVOICEACCOUNT | \n Invoice / Account | \n
PAYPAL | \n Paypal | \n
APP | \n Application (e.g. Uber Eats, Clipp) | \n
GIFTCARD | \n Gift card / Gift voucher | \n
| Base Type | \nDescription | \n
|---|---|
| string(20) | \nRegular expression: [0-9-+()\\s]{1,20} | \n
| Value | \nDescription | \n
|---|---|
CARD | \n Credit/debit card | \n
CASH | \n Cash | \n
CHEQUE | \n Cheque / check | \n
STORECREDIT | \n Store credit / Credit Note | \n
BANKTRANSFER | \n Bank Transfer / Direct Credit / ACH | \n
INVOICEACCOUNT | \n Invoice / Account | \n
PAYPAL | \n Paypal | \n
APP | \n Application (e.g. Uber Eats, Clipp) | \n
GIFTCARD | \n Gift card / Gift voucher | \n
| Value | \nDescription | \n
|---|---|
DAILY | \n Once every day | \n
WEEKLY | \n Once every week | \n
FORTNIGHTLY | \n Once every two weeks | \n
MONTHLY | \n Once every month | \n
| Value | \nDescription | \n
|---|---|
LIMITED | \n A schedule that is limited to a particular number of payments (set via the limitToTransactionCount parameter) or until a particular amount of money has been collected (set via the limitToTransactionAmount parameter). For limited schedules, if a payment is rejected it will be re-added into the schedule to be attempted again. | \n
UNENDING | \n Payments will continue to be debited at the given frequency until the payer is either cancelled or suspended or a new schedule is generated. | \n
| Value | \nDescription | \n
|---|---|
BILL | \n Collection of funds for a one-off bill that was added to your account for a special service or circumstance | \n
CHARGEBACK | \n Recovery of funds for a credit card chargeback | \n
CLAIM | \n Recovery of funds for a bank account claim | \n
EARLY_SETTLEMENT | \n Funds paid to you upfront if you are using our early settlement service | \n
EARLY_SETTLEMENT_REPAY | \n Pay back of funds paid to you upfront if you are using our early settlement service | \n
LATE_REJECTION | \n Recovery of funds for a transaction that was initially settled to you but was later rejected due to late notification by the bank | \n
MISCELLANEOUS | \n Collection of fees for other types of non-transaction related services not included in the above categories | \n
OTHER_TRANSACTION | \n Payment of funds or collection of fees for transaction activities not included in the above categories | \n
REFUND | \n Recovery of funds from a refunded transaction | \n
REJECTION | \n Collection of funds for a rejected transaction | \n
SETTLEMENT | \n Payment of funds to you for a successful transaction process using our merchant facility | \n
SETTLEMENT_DIRECT | \n Collection of funds for a transaction settled directly to you through use of your own merchant facilities | \n
FEE | \n Incurred transaction fees | \n
| Value | \nDescription | \n
|---|---|
S | \n Successful - the transaction was processed successfully and the funds have been transferred. | \n
F | \n Failed/Rejected/Declined - The transaction reached the bank but the funds were not able to be obtained and the payment was dishonoured. See the Transaction Sub Status Code for the reason for the transaction failing. | \n
R | \n Unable to process - retry later - the transaction was not processed, possibly due to bank unavailability or technical malfunction. The transaction may be able to be processed at a later time (please note that if you wish to re-attempt to process the transaction again later you will need to provide a different transaction reference). | \n
N | \n In Progress - the transaction is still being processed and the result is not yet determined. | \n
V | \n Verification Required - 3-D Secure Only - if you are using 3-D Secure, this means the challenge scenario has been triggered and you must redirect your customer to the URL that is included in the transaction response (see here). | \n
A rejection fee will be charged if detailed below. If the Payer Status changes, and a transaction is scheduled when the Payer is in any status other than Active, the transaction fee will not be charged. If the transaction is not associated with a payer, and a rejection fee is possible, the rejection will always be charged.
\n| Value | \nDescription | \nPayer Status Changed to | \nRejection Fee Possible? | \n
|---|---|---|---|
R1 | \n Insufficient funds | \nA | \nYes | \n
R2 | \n Invalid bank account number | \nS-IBA | \nYes | \n
R3 | \n Invalid credit card | \nS-ICC | \nYes | \n
R4 | \n Expired credit card | \nS-EXP | \nYes | \n
R5 | \n Invalid transaction | \n- | \nNo | \n
R6 | \n Transaction declined | \n- | \nYes | \n
R7 | \n Authority revoked by payer | \nC-CPS | \nYes | \n
R8 | \n Payer deceased | \nC-DED | \nYes | \n
R9 | \n Invalid bank account BSB | \nS-IBB | \nYes | \n
R10 | \n Bank account closed | \nS-BAC | \nYes | \n
R11 | \n Invalid payer contact details | \nS-ICD | \nYes | \n
R12 | \n Direct debit claim | \nS-CLM | \nYes | \n
R13 | \n Credit card chargeback | \nS-CLM | \nYes | \n
R14 | \n Stolen/pick up card | \nS-ICC | \nYes | \n
R15 | \n Limits exceeded | \n- | \nNo | \n
R16 | \n Pre-auth expired | \n- | \nNo | \n
R17 | \n Not processed (payer inactive) | \n- | \nNo | \n
R18 | \n Fraud protection triggered | \n- | \nNo | \n
R19 | \n Voided | \n- | \nNo | \n
R20 | \n Fraud Check / 3-D Secure: Authentication Failed | \n- | \nNo | \n
R21 | \n Fraud Check / 3-D Secure: Unable to Authenticate | \n- | \nNo | \n
R22 | \n Fraud Check / 3-D Secure: Transaction Abandoned | \n- | \nNo | \n
R23 | \n Fraud Check / 3-D Secure: Error Occurred | \n- | \nNo | \n
RF | \n Partially refunded | \n\n | - | \n
UR | \n Under review | \n- | \n- | \n
| Value | \nDescription | \n
|---|---|
BD | \n Business fee debit | \n
BPAY | \n BPAY payment | \n
CST | \n Creditor settlement | \n
PDB | \n Payer scheduled bank account debit | \n
PDC | \n Payer scheduled credit card debit | \n
PLN | \n Payer loan | \n
POS | \n Point-of-sale card payments | \n
RT | \n Real-time card payment | \n
STL | \n Business settlement | \n
STLU | \n Business upfront settlement | \n
ZDA | \n Card verification (zero dollar authorization) | \n
| Value | \nDescription | \n
|---|---|
IVR | \n The real-time transaction was initiated via an IVR phone system | \n
| Value | \nDescription | \n
|---|---|
EDDR | \n Electronic direct debit request | \n
HPP | \n Hosted payment page | \n
VAULT | \n Hosted vault service | \n
The purpose of this section of the document is to guide you through moving from a SOAP integration to a RESTful integration.
\nThe table below maps the SOAP Functions to the equivalent REST Function.
\nREST offers you advanced documentation, support and functionality.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"9c8f8a72-b090-4387-903d-16df8369c1b0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"281b9fa5-5019-4bf9-bb0e-503866d0329a","type":"text/javascript","exec":[""]}}],"_postman_id":"3eda1f73-2194-4ae2-af02-b28def4730d2"},{"name":"FAQ","item":[],"id":"2ce9cee7-197d-4337-a584-a25a0a7f012e","description":"You can browse the topics below to find answers to Frequently Asked Questions.
\nYou can find details of test cards that can be used in sandbox
\n\nReal Time transactions will receive a status of Cleared (Successful) or Rejected immediately after being processed.
The status will be returned in the response to the API. Please see the model for the specific API call being used.
Recurring Transactions will be scheduled and all being well the response to the API call would be 200.
This means the transaction has been scheduled successfully but will not indicate if funds have been collected.
To find if a transaction has been successful or rejected use the
endpoint to track how these change, from Pending to Cleared to Successful or Rejected.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"9e06d548-2004-414a-8499-a2ee02c8cf0d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0387d226-f150-458f-a893-52b1af34a7c2","type":"text/javascript","exec":[""]}}],"_postman_id":"2ce9cee7-197d-4337-a584-a25a0a7f012e"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"70e764f7-da38-4401-9768-c29bb728ad23","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6cc3a94f-ad56-42e4-8801-2e51db0c9d48","type":"text/javascript","exec":[""]}}]}