{"info":{"_postman_id":"f144cea2-ad12-4ce5-83db-b959589d267f","name":"Nexio API Reference","description":"Nexio API Documentation\n\nContact Support:\n Name: Nexio Integrations Team\n Email: integrations@nexiopay.com","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Ecommerce","item":[{"name":"Create one-time-use token","id":"f1788360-17e3-4ed4-a681-94a08c57504c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"01\",\n \"expirationYear\": \"0565\",\n \"classification\": \"personal\",\n \"businessNumber\": \"\",\n \"password\": \"\"\n },\n \"data\": {\n \"allowedCardTypes\": [\n \"visa\",\n \"jcb\"\n ],\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"processingOptions\": {\n \"checkFraud\": true,\n \"verifyAvs\": 0,\n \"verifyCvc\": false,\n \"verboseResponse\": false\n },\n \"uiOptions\": {\n \"css\": \"\",\n \"customTextUrl\": \"\",\n \"displaySubmitButton\": false,\n \"hideBilling\": {\n \"hideAddressOne\": false,\n \"hideAddressTwo\": false,\n \"hideCity\": false,\n \"hideState\": false,\n \"hidePostal\": false,\n \"hideCountry\": false,\n \"hidePhone\": true\n },\n \"hideCvc\": false,\n \"requireCvc\": true,\n \"forceExpirationSelection\": true,\n \"limitCountriesTo\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/token","description":"Use this endpoint to generate a temporary token prior to loading an ecommerce iframe. The available and required parameters differ based on the iframe to be loaded. See the dropdown below to determinee which parameters are available and required for each iframe. All processing options and UI options for your iframes must be sent in the body of this request. \n\nIf you want to have the system pre-fill an iframe form, you must include that data (for example, card or customer information) in the request for this endpoint. Any parameter included here will be overwritten if the same parameter is included in the iframe’s event body.\n\nFor more information about the parameters that continue from the one-time-use token to the saved card token and beyond, see [What data is saved with tokens?](doc:what-data-is-saved-with-tokens) in Guides.\n\n\n> πŸ“˜ Note\n> \n> Once a token has been used to submit an iframe it cannot be used to load another. You must request a new one-time-use token prior to submitting each iframe.\n\n\n Note\n\n Once a token has been used to submit an iframe it cannot be used to load another. You must request a new one-time-use token prior to submitting each iframe.\n\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

Include any other parameters that you need for the body of the request, depending on what you are using the one-time-use token for.\n\n\n
\n\n## Request parameters\n- bank\n- bank.accountHolderName\n- bank.routingNumber\n- card\n- card.businessNumber\n- card.cardHolderName\n- card.cardType\n- card.classification\n- card.expirationMonth\n- card.expirationYear\n- card.password\n- data\n- data.allowedCardTypes\n- data.amount\n- data.currency\n- data.customer\n- data.customer.customerRef\n- data.customer.orderNumber\n- data.customer.orderDate\n- data.customer.invoice\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.birthDate\n- data.customer.nationalIdentificationNumber\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.birthDate\n- data.customer.createdAtDate\n- data.customer.email\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.customFields\n- data.customFields.exampleKey\n- data.description\n- data.descriptor\n- data.descriptor.name\n- data.descriptor.address\n- data.descriptor.city\n- data.descriptor.state\n- data.descriptor.postal\n- data.descriptor.country\n- data.descriptor.phone\n- data.descriptor.url\n- data.descriptor.merchantId\n- data.descriptor.mcc\n- data.lodging\n- data.lodging.advanceDeposit\n- data.lodging.checkInDate\n- data.lodging.checkOutDate\n- data.lodging.noShow\n- data.lodging.roomNumber\n- data.lodging.roomRate\n- data.surcharge\n- installment\n- installment.period\n- isAuthOnly\n- processingOptions\n- processingOptions.checkFraud\n- processingOptions.verboseResponse\n- processingOptions.verifyAvs\n- processingOptions.verifyCvc\n- processingOptions.customerRedirectUrl\n- processingOptions.merchantId\n- processingOptions.paymentOptionTag\n- processingOptions.saveCardToken\n- processingOptions.shouldUseFingerprint\n- shouldUpdateCard\n- uiOptions\n- uiOptions.css\n- uiOptions.customTextUrl\n- uiOptions.displaySubmitButton\n- uiOptions.hideBilling\n- uiOptions.hideBilling.hideAddressOne\n- uiOptions.hideBilling.hideAddressTwo\n- uiOptions.hideBilling.hideCity\n- uiOptions.hideBilling.hideCountry\n- uiOptions.hideBilling.hidePostal\n- uiOptions.hideBilling.hidePhone\n- uiOptions.hideBilling.hideState\n- uiOptions.hideCvc\n- uiOptions.limitCountriesTo\n- uiOptions.requireCvc\n- uiOptions.forceExpirationSelection\n\n\n## Response parameters\n- expiration\n- fraudUrlc\n- token\n\n
"},"response":[{"id":"2e6096e4-3256-400e-900e-0ef04e28e177","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"01\",\n \"expirationYear\": \"0565\",\n \"classification\": \"personal\",\n \"businessNumber\": \"\",\n \"password\": \"\"\n },\n \"data\": {\n \"allowedCardTypes\": [\n \"visa\",\n \"jcb\"\n ],\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"processingOptions\": {\n \"checkFraud\": true,\n \"verifyAvs\": 0,\n \"verifyCvc\": false,\n \"verboseResponse\": false\n },\n \"uiOptions\": {\n \"css\": \"\",\n \"customTextUrl\": \"\",\n \"displaySubmitButton\": false,\n \"hideBilling\": {\n \"hideAddressOne\": false,\n \"hideAddressTwo\": false,\n \"hideCity\": false,\n \"hideState\": false,\n \"hidePostal\": false,\n \"hideCountry\": false,\n \"hidePhone\": true\n },\n \"hideCvc\": false,\n \"requireCvc\": true,\n \"forceExpirationSelection\": true,\n \"limitCountriesTo\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"expiration\": \"\",\n \"fraudUrl\": \"\",\n \"token\": \"\"\n}"},{"id":"989fbc23-889f-490e-a6b0-db1f4794bba5","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"01\",\n \"expirationYear\": \"0565\",\n \"classification\": \"personal\",\n \"businessNumber\": \"\",\n \"password\": \"\"\n },\n \"data\": {\n \"allowedCardTypes\": [\n \"visa\",\n \"jcb\"\n ],\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"processingOptions\": {\n \"checkFraud\": true,\n \"verifyAvs\": 0,\n \"verifyCvc\": false,\n \"verboseResponse\": false\n },\n \"uiOptions\": {\n \"css\": \"\",\n \"customTextUrl\": \"\",\n \"displaySubmitButton\": false,\n \"hideBilling\": {\n \"hideAddressOne\": false,\n \"hideAddressTwo\": false,\n \"hideCity\": false,\n \"hideState\": false,\n \"hidePostal\": false,\n \"hideCountry\": false,\n \"hidePhone\": true\n },\n \"hideCvc\": false,\n \"requireCvc\": true,\n \"forceExpirationSelection\": true,\n \"limitCountriesTo\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"f1788360-17e3-4ed4-a681-94a08c57504c"},{"name":"Save card token with iframe","id":"c3f9a0b7-18ff-4379-9c30-424ae64b0c89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/pay/v3/saveCard?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","saveCard"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in that request for the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]},"description":"Returns an iframe that can be used to securely save a token for a credit or debit card. You can later use this card token to run a card transaction using the [Run card transaction with iframe](ref:runcardtransactioniframe) or [Run card transaction](ref:runcardtransaction) endpoint.\n\nCard tokens can be used to process transactions through any MID on your account. They are not restricted to a specific merchant account or currency.\n\nFor instructions on how to implement this endpoint, see the recipes (listed below) or see [Creating a save card page with the iframe](doc:creating-a-save-card-page-with-the-iframe). \n\nFor a tutorial about running a transaction with the saved card token, see the [Creating a card checkout page with the iframe](doc:creating-a-card-checkout-page-with-the-iframe), [Creating a card checkout page with your own form](doc:creating-a-card-checkout-page-with-your-own-form), or [Running a card transaction with the API](doc:running-a-card-transaction-with-the-api) topic.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must first request a [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in that request for the display and functionality of the iframe.\n\n\n
\n\n## Request parameters\n- shouldReturnHtml\n- token\n\n## Response parameters\n- HTML form\n\n
"},"response":[{"id":"267c9e0d-719b-45fc-8089-1c9025af58d4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/saveCard?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","saveCard"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in that request for the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"a3b24e1c-c4dd-4113-8412-271e89830e50","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/saveCard?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","saveCard"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in that request for the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"c3f9a0b7-18ff-4379-9c30-424ae64b0c89"},{"name":"Save card token","id":"7d60d230-f898-4c92-a2f0-823be0432923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\",\n \"encryptedNumber\": \"\",\n \"cardType\": \"mastercard\",\n \"securityCode\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/saveCard","description":"Allows you to securely save a card token [using your own form](doc:creating-a-save-card-page-with-your-own-form) or [using the API directly](doc:saving-a-card-token-with-the-api) (potentially without a web browser). You can use this endpoint to save a new card token or add pre-existing TokenEx tokens that you would like to start using through Nexio. \n\nYou can use this saved card token to run a card transaction using the [Run card transaction with iframe](ref:runcardtransactioniframe) or [Run card transaction](ref:runcardtransaction) endpoint. \n\nCard tokens can be used to process transactions through any MID on your account. They are not restricted to a specific merchant account or currency.\n\nFor instructions on how to implement this endpoint, see [Creating a save card page with your own form](doc:creating-a-save-card-page-with-your-own-form) or [Saving a card token with the API](doc:saving-a-card-token-with-the-api). \n\nFor a tutorial about running a transaction with the saved card token, see the [Creating a card checkout page with the iframe](doc:creating-a-card-checkout-page-with-the-iframe), [Creating a card checkout page with your own form](doc:creating-a-card-checkout-page-with-your-own-form), or [Running a card transaction with the API](doc:running-a-card-transaction-with-the-api) topic.\n\n\n> πŸ“˜ Note \n> \n> Processing options must be sent in the request for a [one-time-use token](ref:createonetimeusetoken). For more information, see [What data is saved with tokens?](doc:what-data-is-saved-with-tokens) in Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, include at least the following in the body of the request:\n> - A [one-time-use token](ref:createonetimeusetoken) - this replaces the standard username/password and authentication header\n> - `card.cardHolderName`\n> - `card.expirationMonth`\n> - `card.expirationYear`\n> - Either `card.encryptedNumber` or `tokenex.token` (an existing TokenEx card token)\n> For information about test card numbers and values you can use, see the documentation for the specific [gateway/connection integration guide](doc:connections) or, if you are testing Account Updater, see the [Test cards for account updater](doc:checking-a-cards-enrollment-tag#test-cards-for-account-updater) section of the \"Checking a card's enrollment tag\" topic.\n\n\n
\n\n## Request parameters\n- card\n- card.cardHolderName\n- card.encryptedNumber\n- card.expirationMonth\n- card.expirationYear\n- card.cardType\n- card.securityCode\n- card.firstSix\n- card.lastFour\n- token\n- data\n- data.customer\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.birthDate\n- data.customer.createdAtDate\n- data.customer.email\n- data.customer.firstName\n- data.customer.invoice\n- data.customer.lastName\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- shouldUpdateCard\n- tokenex\n- tokenex.token\n- tokenex.firstSix\n- tokenex.lastFour\n- merchantId\n\n## Response parameters\n- card\n- card.cardHolderName\n- card.expirationMonth\n- card.expirationYear\n- card.cardType\n- data\n- data.customer\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.birthDate\n- data.customer.email\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- kountResponse\n- kountResponse.status\n- kountResponse.rules\n- merchantId\n- shouldUpdateCard\n- token\n- token.token\n- token.firstSix\n- token.lastFour\n- token.cardType\n- cvcResults\n- cvcResults.matchCvv\n- cvcResults.error\n- cvcResults.gatewayMessage\n- cvcResults.gatewayMessage.cvvresponse\n- cvcResults.gatewayMessage.message\n- avsResults\n- avsResults.matchAddress\n- avsResults.matchPostal\n- avsResults.error\n- avsResults.gatewayMessage\n- avsResults.gatewayMessage.avsresponse\n- avsResults.gatewayMessage.message\n- cardType\n\n
"},"response":[{"id":"f03878be-dfbd-4ba9-9ba0-76630faf178c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\",\n \"encryptedNumber\": \"\",\n \"cardType\": \"mastercard\",\n \"securityCode\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/saveCard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"cardType\": \"amex\"\n },\n \"card\": {\n \"cardType\": \"visa\",\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"08\",\n \"expirationYear\": \"55\",\n \"classification\": \"business\",\n \"businessNumber\": \"\",\n \"password\": \"\"\n },\n \"cardType\": \"jcb\",\n \"data\": {\n \"customer\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n }\n },\n \"merchantId\": \"\",\n \"shouldUpdateCard\": true,\n \"kountResponse\": {\n \"status\": \"\",\n \"rules\": \"\"\n },\n \"avsResults\": {\n \"error\": \"\",\n \"matchAddress\": \"\",\n \"matchPostal \": \"\",\n \"gatewayMessage\": {\n \"avsresponse\": \"\",\n \"message\": \"\"\n }\n },\n \"cvcResults\": {\n \"matchCvv\": \"\",\n \"error\": \"\",\n \"gatewayMessage\": {\n \"cvvresponse\": \"X\",\n \"message\": \"\"\n }\n }\n}"},{"id":"6156439d-d759-4ab4-8e9e-0e80ad89b65a","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\",\n \"encryptedNumber\": \"\",\n \"cardType\": \"mastercard\",\n \"securityCode\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/saveCard"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\",\n \"cvcResults\": {\n \"matchCvv\": \"\",\n \"error\": \"\",\n \"gatewayMessage\": {\n \"cvvresponse\": \"\",\n \"message\": \"\"\n }\n },\n \"merchantId\": \"\"\n}"},{"id":"ecb8b2e9-1afe-473b-ba73-c71a02c97cd7","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\",\n \"encryptedNumber\": \"\",\n \"cardType\": \"mastercard\",\n \"securityCode\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/saveCard"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"7d60d230-f898-4c92-a2f0-823be0432923"},{"name":"View surcharge recommendation","id":"2be7745b-024d-40a1-9083-eb80e11d5223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"customer\": {\n \"billToState\": \"\"\n }\n },\n \"card\": {\n \"firstSix\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/surcharge","description":"Allows you to get a surcharge recommendation for a transaction based on the customer's billing state and information about the payment. The response provides information about whether surcharging is recommended or what restrictions apply for surcharging with the transaction.\n\nIf the saved card token includes `data.customer.billToState`, you only need to include that token in the request. Otherwise, you must explicitly include `data.customer.billToState` and just one of the following parameters:\n- `card.firstSix`\n- `card.pan`\n- `tokenex.token`\n- `tokenex.firstSix`\n\n\n\n> πŸ“˜ Note\n>\n> In order to use this endpoint, the Surcharging feature must be enabled for the account and the new agreement must be accepted (which displays upon logging into the [Dashboard](https://dashboard.nexiopaysandbox.com/)).\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n> \n> If the saved card token includes `data.customer.billToState`, you only need to include that token in the request. Otherwise, you must include `data.customer.billToState` plus just one of the following parameters: `card.firstSix`, `card.pan`, `tokenex.token`, or `tokenex.firstSix`.\n\n\n
\n\n## Request parameters\n- data\n- data.amount\n- data.surcharge\n- data.currency\n- data.allowedCardTypes\n- data.cart\n- data.cart.items\n- data.cart.items.item\n- data.cart.items.description\n- data.cart.items.quantity\n- data.cart.items.price\n- data.cart.items.type\n- data.customer\n- data.customer.customerRef\n- data.customer.orderNumber\n- data.customer.orderDate\n- data.customer.invoice\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.birthDate\n- data.customer.nationalIdentificationNumber\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.createdAtDate\n- data.customer.email\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.customFields\n- data.customFields.exampleKey\n- data.description\n- data.descriptor\n- data.descriptor.name\n- data.descriptor.address\n- data.descriptor.city\n- data.descriptor.state\n- data.descriptor.postal\n- data.descriptor.country\n- data.descriptor.phone\n- data.descriptor.url\n- data.descriptor.merchantId\n- data.descriptor.mcc\n- data.lodging\n- data.lodging.advanceDeposit\n- data.lodging.checkInDate\n- data.lodging.checkOutDate\n- data.lodging.noShow\n- data.lodging.roomNumber\n- data.lodging.roomRate\n- paymentMethod\n- tokenex\n- tokenex.token\n- tokenex.firstSix\n- tokenex.lastFour\n- card\n- card.cardType\n- card.cardHolderName\n- card.encryptedNumber\n- card.expirationMonth\n- card.expirationYear\n- card.securityCode\n- card.firstSix\n- card.lastFour\n- card.classification\n- card.businessNumber\n- card.password\n- card.pan\n- card.expirationMonth\n- card.expirationYear\n- tokenex.token\n- tokenex.firstSix\n- recurringId\n- shouldUpdateCard\n- merchantId\n- processingOptions\n- processingOptions.merchantId\n- processingOptions.check3ds\n- processingOptions.paymentType\n- processingOptions.customerRedirectUrl\n- processingOptions.checkFraud\n- processingOptions.paymentOptionTag\n- processingOptions.retryOnSoftDecline\n- processingOptions.shouldUseFingerprint\n- processingOptions.verboseResponse\n- clientIp\n- isAuthOnly\n- installment\n- installment.period\n- external3ds\n- external3ds.eci\n- external3ds.cavv\n- external3ds.xid\n- external3ds.version\n\n## Response parameters\n- surchargeAllowed\n- cardType\n- message\n\n
"},"response":[{"id":"e383aba8-d8d9-47d6-a600-21e218e09311","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"customer\": {\n \"billToState\": \"\"\n }\n },\n \"card\": {\n \"firstSix\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/surcharge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"surchargeAllowed\": \"\",\n \"cardType\": \"mastercard\",\n \"message\": \"\",\n \"random-nnnnnnn\": \"\"\n}"},{"id":"ae82c7f7-8dde-4397-824d-e825d62df5b8","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"customer\": {\n \"billToState\": \"\"\n }\n },\n \"card\": {\n \"firstSix\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/surcharge"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNum\": \"\",\n \"status\": \"\"\n },\n \"merchantId\": \"\"\n}"},{"id":"8d3f5098-3cbb-4db1-8d34-d00ac7ecb2f5","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"customer\": {\n \"billToState\": \"\"\n }\n },\n \"card\": {\n \"firstSix\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/surcharge"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"2be7745b-024d-40a1-9083-eb80e11d5223"},{"name":"Run card transaction with iframe","id":"538f2042-41ae-4b9d-8150-2e652496bc6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/pay/v3?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved card token in the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]},"description":"Returns an iframe that can be used to securely run a credit or debit card transaction.\n\nFor instructions on how to implement this endpoint, see the [Creating a card checkout page with the iframe](doc:creating-a-card-checkout-page-with-the-iframe) topic.\n\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must first request a [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved card token in the display and functionality of the iframe.\n\n
\n\n## Request parameters\n- shouldReturnHtml\n- token\n\n## Response parameters\n- HTML form\n\n
"},"response":[{"id":"c860bdc4-2b47-4151-afb6-b027ef0d32cd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved card token in the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"4949b255-a4ff-49ed-83d7-6e5c8de39dbd","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved card token in the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"538f2042-41ae-4b9d-8150-2e652496bc6c"},{"name":"Run card transaction","id":"15879aef-7100-4b30-acd6-b6e007d63f4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"surcharge\": \"\",\n \"currency\": \"USD\",\n \"allowedCardTypes\": [\n \"jcb\",\n \"amex\"\n ],\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"descriptor\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"processingOptions\": {\n \"paymentType\": \"initialUnscheduled\",\n \"paymentOptionTag\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"4\",\n \"expirationYear\": \"1887\",\n \"cardType\": \"discover\",\n \"securityCode\": \"\",\n \"classification\": \"personal\",\n \"businessNumber\": \"\",\n \"password\": \"\"\n },\n \"clientIp\": \"\",\n \"isAuthOnly\": false,\n \"paymentMethod\": \"card\",\n \"installment\": {\n \"period\": \"\"\n },\n \"external3ds\": {\n \"eci\": \"\",\n \"cavv\": \"\",\n \"xid\": \"\",\n \"version\": \"\",\n \"enrolled\": \"\",\n \"pAResStatus\": \"\",\n \"commerceIndicator\": \"\",\n \"ucafAuthenticationData\": \"\",\n \"ucafCollectionIndicator\": \"\",\n \"directoryServerTransactionId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/process","description":"Allows you to process a card transaction in any of the following situations: \n\n- An initial transaction that uses a saved card token.\n- An initial transaction that uses the full (raw) card information (where supported).\n- A subsequent transaction that uses a saved card token.\n- A subsequent transaction that uses the full (raw) card information (where supported).\n- A subsequent transaction that uses a saved terminal token.\n\nFor more information about how to implement this endpoint, see the recipes (listed below) or the [Creating a card checkout page with your own form](doc:creating-a-card-checkout-page-with-your-own-form), [Running a card transaction using full card information](doc:running-a-card-transaction-using-raw-card-information), or [Running a card transaction with the API](doc:running-a-card-transaction-with-the-api) topic.\n\nAside from the fields marked required here, the gateway you are using may require additional fields. For information on gateway-specific required fields, see the [Connections](doc:connections) documentation.\n\nFor the 3DS workflow, the system returns a `redirectUrl` instead of the standard response, along with an `asyncTraceId` that you can use with the [View transaction async status](ref:viewtransactionasyncstatus) endpoint for tracking progress and status. For a tutorial, see [Using 3DS to run transactions](doc:using-3ds-to-run-transactions).\n\n\n> πŸ›‘ Important\n>\n> Parameters passed with a process request override any data points that are saved with the card token.\n> \n> For example, if the value for `data.customer.billToAddressOne` is saved with the card token as `729 Jay Road`, but the value for that field is passed with the process request as `2147 West Silverlake Drive`, the system uses the address at `Silverlake Drive`.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`\n>\n> Provide the following as body parameters, depending on which payment flow you are using:\n> - **For an initial or subsequent transaction with a saved card token:** Include at least the `data.amount`, `processingOptions.paymentType`, and `tokenex.token`.\n> - **For a subsequent transaction with a saved terminal token:** Include at least the `data.amount`, `processingOptions.paymentType`, and `terminal.token`.\n> - **With the full card information:** Include at least the `data.amount`, `processingOptions.paymentType`, `card.pan`, `card.expirationYear`, and `card.expirationMonth`.
**Note:** Sending full card information may increase your PCI scope.\n> - **For a subsequent transaction with the full card information:** Include at least the `data.amount`, `processingOptions.paymentType`, `card.pan`, `card.expirationYear`, `card.expirationMonth`, and `recurringId`.\n>\n> For information about test card numbers and values you can use, see the documentation for the specific [gateway/connection integration guide](doc:connections) you want to use or, if you are testing Account Updater, see the [Test cards for account updater](doc:checking-a-cards-enrollment-tag#test-cards-for-account-updater) section of the \"Checking a card's enrollment tag\" topic.\n\n\n
\n\n## Request parameters\n- data\n- data.amount\n- data.surcharge\n- data.currency\n- data.allowedCardTypes\n- data.cart\n- data.cart.items\n- data.cart.items.item\n- data.cart.items.description\n- data.cart.items.quantity\n- data.cart.items.price\n- data.cart.items.type\n- data.customer\n- data.customer.customerRef\n- data.customer.orderNumber\n- data.customer.orderDate\n- data.customer.invoice\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.birthDate\n- data.customer.nationalIdentificationNumber\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.createdAtDate\n- data.customer.email\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.customFields\n- data.customFields.exampleKey\n- data.description\n- data.descriptor\n- data.descriptor.name\n- data.descriptor.address\n- data.descriptor.city\n- data.descriptor.state\n- data.descriptor.postal\n- data.descriptor.country\n- data.descriptor.phone\n- data.descriptor.url\n- data.descriptor.merchantId\n- data.descriptor.mcc\n- data.lodging\n- data.lodging.advanceDeposit\n- data.lodging.checkInDate\n- data.lodging.checkOutDate\n- data.lodging.noShow\n- data.lodging.roomNumber\n- data.lodging.roomRate\n- paymentMethod\n- tokenex\n- tokenex.token\n- tokenex.firstSix\n- tokenex.lastFour\n- card\n- card.cardType\n- card.cardHolderName\n- card.encryptedNumber\n- card.expirationMonth\n- card.expirationYear\n- card.securityCode\n- card.firstSix\n- card.lastFour\n- card.classification\n- card.businessNumber\n- card.password\n- card.pan\n- recurringId\n- merchantId\n- processingOptions\n- processingOptions.merchantId\n- processingOptions.check3ds\n- processingOptions.paymentType\n- processingOptions.customerRedirectUrl\n- processingOptions.checkFraud\n- processingOptions.paymentOptionTag\n- processingOptions.retryOnSoftDecline\n- processingOptions.shouldUseFingerprint\n- processingOptions.verboseResponse\n- clientIp\n- isAuthOnly\n- installment\n- installment.period\n- external3ds\n- external3ds.eci\n- external3ds.cavv\n- external3ds.xid\n- external3ds.version\n- external3ds.enrolled\n- external3ds.pAResStatus\n- external3ds.commerceIndicator\n- external3ds.ucafAuthenticationData\n- external3ds.ucafCollectionIndicator\n- external3ds.directoryServerTransactionId\n\n## Response parameters\n- id\n- merchantId\n- authCode\n- amount\n- currency\n- transactionDate\n- transactionStatus\n- transactionType\n- shouldUpdateCard\n- card\n- card.cardHolder\n- card.expirationMonth\n- card.expirationYear\n- card.cardType\n- card.cardNumber\n- card.firstSix\n- card.lastFour\n- token\n- token.token\n- token.firstSix\n- token.lastFour\n- token.cardType\n- data\n- data.amount\n- data.currency\n- data.settlementCurrency\n- data.customer\n- data.customer.customerRef\n- data.customer.orderNumber\n- data.customer.orderDate\n- data.customer.invoice\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.birthDate\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.email\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.customer.createdAt\n- data.cart\n- data.cart.items\n- data.cart.items.item\n- data.cart.items.description\n- data.cart.items.quantity\n- data.cart.items.price\n- data.cart.items.type\n- data.lodging\n- data.lodging.advanceDeposit\n- data.lodging.checkInDate\n- data.lodging.checkOutDate\n- data.lodging.noShow\n- data.lodging.roomNumber\n- data.lodging.roomRate\n- data.customFields\n- data.customFields.exampleKey\n- data.nsu\n- kountResponse\n- kountResponse.status\n- kountResponse.rules\n- installment\n- installment.period\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n- recurringData\n- recurringData.recurringId\n- recurringData.recurringIdType\n- status\n- message\n- redirectUrl\n- asyncTraceId\n\n
"},"response":[{"id":"5f7b9074-4fe8-44cd-a7a1-00b4dceefa5c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"surcharge\": \"\",\n \"currency\": \"USD\",\n \"allowedCardTypes\": [\n \"jcb\",\n \"amex\"\n ],\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"descriptor\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"processingOptions\": {\n \"paymentType\": \"initialUnscheduled\",\n \"paymentOptionTag\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"4\",\n \"expirationYear\": \"1887\",\n \"cardType\": \"discover\",\n \"securityCode\": \"\",\n \"classification\": \"personal\",\n \"businessNumber\": \"\",\n \"password\": \"\"\n },\n \"clientIp\": \"\",\n \"isAuthOnly\": false,\n \"paymentMethod\": \"card\",\n \"installment\": {\n \"period\": \"\"\n },\n \"external3ds\": {\n \"eci\": \"\",\n \"cavv\": \"\",\n \"xid\": \"\",\n \"version\": \"\",\n \"enrolled\": \"\",\n \"pAResStatus\": \"\",\n \"commerceIndicator\": \"\",\n \"ucafAuthenticationData\": \"\",\n \"ucafCollectionIndicator\": \"\",\n \"directoryServerTransactionId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/process"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"amount\": \"\",\n \"surcharge\": \"\",\n \"currency\": \"USD\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"transactionType\": \"\",\n \"shouldUpdateCard\": true,\n \"card\": {\n \"cardHolder\": \"\",\n \"cardNumber\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"token\": {\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"token\": \"\",\n \"cardType\": \"discover\"\n },\n \"terminal\": {\n \"token\": \"\"\n },\n \"recurringData\": {\n \"recurringId\": \"\",\n \"recurringIdType\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAt\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n },\n \"nsu\": \"\"\n },\n \"kountResponse\": {\n \"status\": \"\",\n \"rules\": \"\"\n },\n \"installment\": {\n \"period\": \"\"\n },\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"random-nnnnnnn\": \"\"\n}"},{"id":"0df14bde-113b-4aca-a0d2-bdd8bff8342e","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"surcharge\": \"\",\n \"currency\": \"USD\",\n \"allowedCardTypes\": [\n \"jcb\",\n \"amex\"\n ],\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"descriptor\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"processingOptions\": {\n \"paymentType\": \"initialUnscheduled\",\n \"paymentOptionTag\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"4\",\n \"expirationYear\": \"1887\",\n \"cardType\": \"discover\",\n \"securityCode\": \"\",\n \"classification\": \"personal\",\n \"businessNumber\": \"\",\n \"password\": \"\"\n },\n \"clientIp\": \"\",\n \"isAuthOnly\": false,\n \"paymentMethod\": \"card\",\n \"installment\": {\n \"period\": \"\"\n },\n \"external3ds\": {\n \"eci\": \"\",\n \"cavv\": \"\",\n \"xid\": \"\",\n \"version\": \"\",\n \"enrolled\": \"\",\n \"pAResStatus\": \"\",\n \"commerceIndicator\": \"\",\n \"ucafAuthenticationData\": \"\",\n \"ucafCollectionIndicator\": \"\",\n \"directoryServerTransactionId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/process"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNum\": \"\",\n \"status\": \"\"\n },\n \"merchantId\": \"\"\n}"},{"id":"ca024fa1-04dd-43cb-9937-22a1f409ac05","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"surcharge\": \"\",\n \"currency\": \"USD\",\n \"allowedCardTypes\": [\n \"jcb\",\n \"amex\"\n ],\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"descriptor\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"processingOptions\": {\n \"paymentType\": \"initialUnscheduled\",\n \"paymentOptionTag\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"card\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"4\",\n \"expirationYear\": \"1887\",\n \"cardType\": \"discover\",\n \"securityCode\": \"\",\n \"classification\": \"personal\",\n \"businessNumber\": \"\",\n \"password\": \"\"\n },\n \"clientIp\": \"\",\n \"isAuthOnly\": false,\n \"paymentMethod\": \"card\",\n \"installment\": {\n \"period\": \"\"\n },\n \"external3ds\": {\n \"eci\": \"\",\n \"cavv\": \"\",\n \"xid\": \"\",\n \"version\": \"\",\n \"enrolled\": \"\",\n \"pAResStatus\": \"\",\n \"commerceIndicator\": \"\",\n \"ucafAuthenticationData\": \"\",\n \"ucafCollectionIndicator\": \"\",\n \"directoryServerTransactionId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/process"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"15879aef-7100-4b30-acd6-b6e007d63f4d"},{"name":"View transaction async status","id":"ef73ffc6-8772-4744-bd5c-04903d38a30f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/pay/v3/transactionAsyncStatus/:asyncTraceId","host":["{{baseUrl}}"],"path":["pay","v3","transactionAsyncStatus",":asyncTraceId"],"variable":[{"id":"7ad7b7df-9bed-4f5b-89cf-c4dd818347c7","key":"asyncTraceId","value":"","description":"(Required) The high-level ID of an unprocessed transaction for tracking progress and status. This is a path parameter."}]},"description":"Gets information about the specified asynchronous transaction. Use this for tracking 3D Secure (3DS) transactions submitted through the [Run card transaction](ref:runcardtransaction) or [Run card transaction with iframe](ref:runcardtransactioniframe) endpoint.\n\nSet the `check3ds` parameter to `true` in the [Create one-time-use token](ref:createonetimeusetoken) endpoint to have the system return the `asyncTraceId` parameter for use in the path parameter for this endpoint. For a tutorial on the entire 3DS workflow, see the [Using 3DS to run transactions](doc:using-3ds-to-run-transactions) topic. \n\nFor 3DS transactions, the history object progresses through the following flow for a successful payment:
  • `processFromApi`
  • `iframe`
  • `popup`
  • `finale`
    • \n\n### See also\nFor tracking transactions for alternative payment methods (APMs), see the [View APM transaction async status](ref:viewapmtransactionasyncstatus) endpoint.\n\n\n
    \n\n## Request parameters\n- asyncTraceId\n\n## Response parameters\n- gatewayResponse\n- gatewayResponse.refNumber\n- gatewayResponse.gatewayName\n- history.processFromApi\n- history.processFromApi.initiatedAt\n- history.processFromApi.updatedAt\n- history.processFromApi.state\n- history.iframe\n- history.iframe.initiatedAt\n- history.iframe.updatedAt\n- history.iframe.state\n- history.popup\n- history.popup.initiatedAt\n- history.popup.updatedAt\n- history.popup.state\n- history.finale\n- history.finale.initiatedAt\n- history.finale.updatedAt\n- history.finale.state\n- updatedAt\n- initialTransactionStatus\n- createdAt\n- asyncTraceId\n\n
    "},"response":[{"id":"b871bbcf-9fa3-4057-8285-4f41b1accd7f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/transactionAsyncStatus/:asyncTraceId","host":["{{baseUrl}}"],"path":["pay","v3","transactionAsyncStatus",":asyncTraceId"],"variable":[{"key":"asyncTraceId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"history\": {\n \"processFromApi\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"redirectUrlReturnedFromGateway\"\n },\n \"iframe\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"loaded\"\n },\n \"popup\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"submitted\"\n },\n \"finale\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"error\"\n }\n },\n \"updatedAt\": \"\",\n \"initialTransactionStatus\": \"\",\n \"createdAt\": \"\",\n \"asyncTraceId\": \"\"\n}"},{"id":"228284a7-01f6-4c7b-ad2f-0170ef90002f","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/transactionAsyncStatus/:asyncTraceId","host":["{{baseUrl}}"],"path":["pay","v3","transactionAsyncStatus",":asyncTraceId"],"variable":[{"key":"asyncTraceId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"ef73ffc6-8772-4744-bd5c-04903d38a30f"},{"name":"Save echeck token with iframe","id":"647543db-6bfc-4eaf-9ca5-c56c4372d2d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"}],"url":{"raw":"{{baseUrl}}/pay/v3/saveECheck?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","saveECheck"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in that request for the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]},"description":"Returns an iframe that can be used to securely save a bank account information.\n\nFor instructions on how to implement this endpoint, see [Creating a save echeck page with the iframe](doc:creating-a-save-echeck-page-with-the-iframe). \n\nFor a tutorial about running a transaction with the saved echeck token, see the [Creating a card checkout page with the iframe](doc:creating-a-card-checkout-page-with-the-iframe), [Creating a card checkout page with your own form](doc:creating-a-card-checkout-page-with-your-own-form), or [Running a card transaction with the API](doc:running-a-card-transaction-with-the-api) topic.\n\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must first request a [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in that request for the display and functionality of the iframe. \n\n
    \n\n## Request parameters\n- shouldReturnHtml\n- token\n\n## Response parameters\n- HTML form\n\n
    "},"response":[{"id":"21b23b73-bc63-4def-a21e-b773cb0b266e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/saveECheck?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","saveECheck"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in that request for the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":""},{"id":"825105e5-21c1-4495-ab0e-8d8d7b55e780","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/saveECheck?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","saveECheck"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in that request for the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"647543db-6bfc-4eaf-9ca5-c56c4372d2d8"},{"name":"Save echeck token","id":"2c52e220-2e15-4514-a837-28ec9849232e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\",\n \"encryptedBankAccountNumber\": \"\"\n },\n \"tokenex\": {\n \"token\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n }\n },\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/saveECheck","description":"Allows you to securely save bank account information without a browser [using the API](doc:saving-an-echeck-token-with-the-api) or [using your own form](doc:creating-a-save-echeck-page-with-your-own-form).\n\nYou may save a new e-check by including the `card` object or add existing TokenEx echeck token for use in Nexio by including the `token` object. Echeck tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.\n\n\n> πŸ“˜ Note \n> \n> Processing options must be sent in the request for a [one-time-use token](ref:createonetimeusetoken). For more information, see [What data is saved with tokens?](doc:what-data-is-saved-with-tokens) in Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include at least a one-time-use token, `bank.accountHolderName`, `bank.accountHolderName`, and either the `bank.encryptedBankAccountNumber` or the `tokenex.token` parameter.\n\n
    \n\n## Request parameters\n- bank\n- bank.accountHolderName\n- bank.routingNumber\n- bank.encryptedBankAccountNumber\n- token\n- data\n- data.customer\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.companyName\n- data.customer.createdAtDate\n- data.customer.email\n- data.customer.firstName\n- data.customer.invoice\n- data.customer.lastName\n- data.customer.orderNumber\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.customFields\n- data.customFields.exampleKey\n- tokenex\n- tokenex.token\n- tokenex.lastFour\n\n## Response parameters\n- token\n- token.token\n- tokenx.lastFour\n- data\n- data.customer\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.companyName\n- data.customer.email\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- bank\n- bank.accountHolderName\n- bank.routingNumber\n- merchantId\n\n
    "},"response":[{"id":"3f512f86-3bcc-4152-a096-92951e30430a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\",\n \"encryptedBankAccountNumber\": \"\"\n },\n \"tokenex\": {\n \"token\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n }\n },\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/saveECheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": {\n \"token\": \"\",\n \"lastFour\": \"\"\n },\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n }\n },\n \"merchantId\": \"\"\n}"},{"id":"0d37d5c3-8a42-42e1-a136-a970d5e5eb2f","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\",\n \"encryptedBankAccountNumber\": \"\"\n },\n \"tokenex\": {\n \"token\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n }\n },\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/saveECheck"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"2c52e220-2e15-4514-a837-28ec9849232e"},{"name":"Run echeck transaction with iframe","id":"de0bbc22-4140-479e-87a9-ae9d73c06457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"}],"url":{"raw":"{{baseUrl}}/pay/v3/processECheck?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","processECheck"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved echeck token in the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]},"description":"Returns an iframe that can be used to securely process an echeck transaction.\n\nFor instructions on how to implement this endpoint, see the [Creating an echeck checkout page with the iframe](doc:creating-an-echeck-checkout-page-with-the-iframe) topic.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must first request a [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved echeck token in the display and functionality of the iframe.\n\n
    \n\n## Request parameters\n- shouldReturnHtml\n- token\n\n## Response parameters\n- HTML form\n\n
    "},"response":[{"id":"09b40cc4-cd25-44bd-9934-fb2559b13d62","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/processECheck?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","processECheck"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved echeck token in the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":""},{"id":"557bfd1f-8e92-4181-89a8-95e8c3dbf12c","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/processECheck?token=&shouldReturnHtml=false","host":["{{baseUrl}}"],"path":["pay","v3","processECheck"],"query":[{"description":"(Required) Your [one-time-use token](ref:createonetimeusetoken). This is a query parameter. The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved echeck token in the display and functionality of the iframe.","key":"token","value":""},{"description":"By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to `true` in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to `true` can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see [Handling errors and declines](doc:handling-errors-and-declines) in Guides.","key":"shouldReturnHtml","value":"false"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"de0bbc22-4140-479e-87a9-ae9d73c06457"},{"name":"Run echeck transaction","id":"3930593b-3648-4ff0-b551-65ed416df76e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\",\n \"secCode\": \"\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"tokenex\": {\n \"token\": \"\",\n \"customerRefNumber\": \"\",\n \"lastFour\": \"\"\n },\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\"\n },\n \"processingOptions\": {\n \"merchantId\": \"\",\n \"verboseResponse\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/processECheck","description":"Allows you to process an echeck transaction in any of the following situations:\n\n- An initial transaction that uses a saved echeck token.\n- A subsequent transaction that uses a saved echeck token.\n\nFor more information about how to implement this endpoint, see the [Creating an echeck checkout page with your own form](doc:creating-an-echeck-checkout-page-with-your-own-form) or [Running an echeck transaction with the API](doc:running-an-echeck-transaction-with-the-api) topic.\n\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include at least an `amount`, `currency`, and `tokenex.token` (the saved echeck token) as body parameters.\n\n
    \n\n## Request parameters\n- data\n- data.amount\n- data.currency\n- data.cart\n- data.cart.items\n- data.cart.items.item\n- data.cart.items.description\n- data.cart.items.quantity\n- data.cart.items.price\n- data.cart.items.type\n- data.customer\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.companyName\n- data.customer.createdAtDate\n- data.customer.customerRef\n- data.customer.email\n- data.customer.firstName\n- data.customer.invoice\n- data.customer.lastName\n- data.customer.orderNumber\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.customFields\n- data.customFields.exampleKey\n- secCode\n- settlementCurrency\n- tokenex\n- tokenex.token\n- tokenex.customerRefNumber\n- tokenex.lastFour\n- bank\n- bank.accountHolderName\n- bank.routingNumber\n- processingOptions\n- processingOptions.verboseResponse\n- processingOptions.merchantId\n\n## Response parameters\n- amount\n- authCode\n- bank\n- bank.accountHolderName\n- bank.routingNumber\n- bank.accountNumber\n- currency\n- data\n- data.amount\n- data.cart\n- data.cart.items\n- data.cart.items.item\n- data.cart.items.description\n- data.cart.items.quantity\n- data.cart.items.price\n- data.cart.items.type\n- data.currency\n- data.customFields\n- data.customFields.exampleKey\n- data.customer\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.companyName\n- data.customer.createdAtDate\n- data.customer.customerRef\n- data.customer.email\n- data.customer.firstName\n- data.customer.invoice\n- data.customer.lastName\n- data.customer.orderNumber\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.lodging\n- data.lodging.advanceDeposit\n- data.lodging.checkInDate\n- data.lodging.checkOutDate\n- data.lodging.noShow\n- data.lodging.roomNumber\n- data.lodging.roomRate\n- data.settlementCurrency\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n- id\n- merchantId\n- transactionDate\n- transactionStatus\n- transactionType\n\n
    "},"response":[{"id":"4725d3f2-cf68-44c9-9d48-80d2ad80bca6","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\",\n \"secCode\": \"\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"tokenex\": {\n \"token\": \"\",\n \"customerRefNumber\": \"\",\n \"lastFour\": \"\"\n },\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\"\n },\n \"processingOptions\": {\n \"merchantId\": \"\",\n \"verboseResponse\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/processECheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"transactionType\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\",\n \"accountNumber\": \"\"\n },\n \"currency\": \"USD\",\n \"amount\": \"\",\n \"data\": {\n \"amount\": \"\",\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n }\n}"},{"id":"4a766106-577c-4527-91ef-368f88edc549","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\",\n \"secCode\": \"\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"tokenex\": {\n \"token\": \"\",\n \"customerRefNumber\": \"\",\n \"lastFour\": \"\"\n },\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\"\n },\n \"processingOptions\": {\n \"merchantId\": \"\",\n \"verboseResponse\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/processECheck"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"3930593b-3648-4ff0-b551-65ed416df76e"},{"name":"View currency conversion rates","id":"fb9358d8-4c24-471f-87e2-a7939ff4b232","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/pay/v3/conversionRates","description":"\"Convert\" For multi-currency pricing (MCP), use this endpoint to retrieve a list of currencies and their current conversion rates in order to convert your prices into the customer's local currency. This endpoint only works with a gateway connection that supports MCP. To enable your merchant account for retrieving the currency conversion rates, contact [Integrations Support](page:contact-us).\n\nThe rates are based on the settlement currency that is specified in the merchant account. To use this endpoint, take the price (in the based currency) and divide by the rate for the customer's currency.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments) and have a gateway connection that supports MCP.\n\n\n
    \n\n## Response parameters\n- merchantId\n- rates\n- rates.currency\n- rates.rate\n\n
    \n"},"response":[{"id":"9c7ebc77-dfc5-464b-8ce5-2f6731e68fe3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/pay/v3/conversionRates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantId\": \"\",\n \"rates\": [\n {\n \"currency\": \"\",\n \"rate\": \"\"\n },\n {\n \"currency\": \"\",\n \"rate\": \"\"\n }\n ]\n}"},{"id":"1c671ae7-e5f0-4d98-8023-08a0e614b842","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/pay/v3/conversionRates"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"fb9358d8-4c24-471f-87e2-a7939ff4b232"},{"name":"Capture a transaction","id":"c0bbacf3-d856-4c1e-ba9c-804da2caa260","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/capture","description":"Allows you to capture an auth only transaction. To do this, you must complete the following steps:\n1. Run an auth only transaction using the [Run card transaction](ref:runcardtransaction) endpoint (by setting the `isAuthOnly` parameter to `true`).\n2. Retrieve the `id` from the response. This is the Nexio Payment ID.\n3. Include that `id` in the body of your request to this endpoint.\n\nIf you do not know the `paymentId` or `amount` to use, make a call with the [View transactions](ref:viewtransactions) endpoint with the query filter of `transactionStatus=11` and `plugin=` to get an array of possible transactions.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include the ID as indicated above for an <> transaction.\n\n
    \n\n## Request parameters\n- id\n- data\n- data.amount\n\n## Response parameters\n- amount\n- authCode\n- currency\n- data\n- data.amount\n- data.currency\n- data.settlementCurrency\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n- id\n- merchantId\n- message\n- transactionDate\n- transactionStatus\n- transactionType\n\n
    "},"response":[{"id":"04404225-e548-4a9c-82da-3ae56a439ace","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/capture"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"transactionType\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"message\": \"\",\n \"currency\": \"USD\",\n \"amount\": \"\",\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\"\n }\n}"},{"id":"b6d69e3a-5859-49fa-b98a-7d073a1d0bb2","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/capture"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"c0bbacf3-d856-4c1e-ba9c-804da2caa260"},{"name":"Void a transaction","id":"ee00f119-8915-46a9-b180-e68b05bfdfa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/void","description":"Allows you to void a credit card, debit card, or echeck transaction using the Nexio Payment ID. In order to void a transaction, it must have been authorized but not yet settled.\n\nThe entire process for voiding a transaction is as follows: \n1. A transaction using the [Run card transaction](ref:runcardtransaction) or [Run echeck transaction](ref:runechecktransaction) endpoint occurs.\n2. Retrieve the `id` from the response. This is the Nexio Payment ID.\n3. Include that `id` in the body of your request for this endpoint in order to void the transaction.\n\nIf you do not know the `paymentId`, you can get an array of possible transactions that have authorized but are not yet settled with the [View transactions](ref:viewtransactions) endpoint and at least the following query filters:
    `transactionStatus=10`
    `plugin=`\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include the ID as indicated above.\n\n
    \n\n## Request parameters\n- id\n\n## Response parameters\n- id\n- merchantId\n- transactionDate\n- authCode\n- transactionStatus\n- transactionType\n- currency\n- message\n- data\n- data.currency\n- data.settlementCurrency\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n\n
    "},"response":[{"id":"91883395-3be2-4949-96d1-396a62502c5c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"transactionType\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"message\": \"\",\n \"currency\": \"\",\n \"data\": {\n \"currency\": \"\",\n \"settlementCurrency\": \"\"\n },\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"random-nnnnnnn\": \"\"\n}"},{"id":"c10a6263-d7df-4ac3-a91b-5dc598d5bee5","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/void"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"033bab8c-8ca1-4cd6-96e5-7286db1976ad","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/void"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"ee00f119-8915-46a9-b180-e68b05bfdfa8"},{"name":"Refund a transaction","id":"6915db03-b245-4876-9467-cadd9c9b3ecd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n },\n \"refundReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/refund","description":"Allows you to refund all or part of a previous credit card, debit card, or echeck transaction using the Nexio Payment ID. In order to refund a transaction, it must have already settled.\n\nThe entire process for refunding a transaction is as follows: \n1. Run a transaction using the [Run card transaction](ref:runcardtransaction) or [Run echeck transaction](ref:runechecktransaction) endpoint.\n2. Retrieve the `id` from the response. This is the Nexio Payment ID.\n3. Use the dashboard from the gateway connection that processed the transaction to manually settle the transaction if that is possible (or wait for the transaction to settle). Note that you can use the [Nexio mock gateway](doc:nexio-mock-gateway-integration-guide) and the `paymentOptionTag` of `nexioAuto` to immediately make a transaction settle. \n4. Include the payment `id` in the body of your request for this endpoint, along with an `amount` that is less than or equal to the original transaction amount. Note that some gateway connections allow multiple refunds per transaction. In this situation, you should ensure that the total of all refunds does not exceed the amount charged in the original transaction.\n\nIf you do not know the `paymentId` or the maximum `amount` to refund, you can get an array of possible transactions that have settled with the [View transactions](ref:viewtransactions) endpoint and at least the following query filters:
    `transactionStatus=20`
    `plugin=`\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include the ID and a refund amount, as indicated above. You may also include a description of why you are issuing the refund.\n\n
    \n\n## Request parameters\n- id\n- data\n- data.amount\n- refundReason\n\n## Response parameters\n- id\n- merchantId\n- transactionDate\n- authCode\n- transactionStatus\n- transactionType\n- currency\n- amount\n- message\n- data\n- data.currency\n- data.settlementCurrency\n- data.amount\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n- recurringData\n- recurringData.recurringId\n- recurringData.recurringIdType\n\n
    "},"response":[{"id":"eb45ae79-558e-4cb0-a12b-f35808500a49","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n },\n \"refundReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"transactionType\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"message\": \"\",\n \"refundReason\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\"\n },\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"recurringData\": {\n \"recurringId\": \"\",\n \"recurringIdType\": \"\"\n },\n \"random-nnnnnnn\": \"\"\n}"},{"id":"f67df2db-7800-4d80-b247-6b9d4d8f6039","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n },\n \"refundReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNum\": \"\",\n \"status\": \"\"\n },\n \"merchantId\": \"\",\n \"random-nnnnnnn\": \"\"\n}"},{"id":"5ff2d6b2-a1b0-4e6d-9382-d3bbd439499b","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n },\n \"refundReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"6915db03-b245-4876-9467-cadd9c9b3ecd"},{"name":"View card tokens","id":"4dbd4e2f-c746-4ee3-aac3-fcf57448cbe6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/card/v3?limit=10&offset=0&createdAt=&updatedAt=&merchantId=&merchantIds=&customerRef=&expirationMonth=&expirationYear=&cardType=&cardHolderName=&firstSix=&lastFour=&accountUpdaterStatus=&lastAccountUpdaterUpdate=&pauseAccountUpdater=&shouldUpdateCard=","host":["{{baseUrl}}"],"path":["card","v3"],"query":[{"description":"The number of records to return. ","key":"limit","value":"10"},{"description":"The offset. Used to view records further along the list.","key":"offset","value":"0"},{"description":"The date and time the payment record was created in Nexio.","key":"createdAt","value":""},{"description":"The date and time at which the payment record was most recently updated in Nexio.","key":"updatedAt","value":""},{"description":"The merchant ID associated with the card token. This value is used as the input for an exact search.","key":"merchantId","value":""},{"description":"A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a card token.","key":"merchantIds","value":""},{"description":"Customer identifier. If included in the request, the system only searches for exact matches to the value.","key":"customerRef","value":""},{"description":"The one-digit or two-digit month in which the card expires. This value is used as the input for an exact search.","key":"expirationMonth","value":""},{"description":"The year (typically two-digit) in which the card will expire. This value is used as the input for an exact search.","key":"expirationYear","value":""},{"description":"The card type specified when the card token was created. This value is used as the input for a fuzzy search.","key":"cardType","value":""},{"description":"The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.","key":"cardHolderName","value":""},{"description":"The first six digits of the card number. This value is used as the input for a fuzzy search.","key":"firstSix","value":""},{"description":"The last four digits of the card number. This value is used as the input for a fuzzy search.","key":"lastFour","value":""},{"description":"The card's account updater status with legacy providers. This parameter has been deprecated. For a list of possible values and meanings, see the account updater [card status](doc:checking-a-cards-enrollment-tag#card-status) table in Guides. This value is used as the input for a fuzzy search.","key":"accountUpdaterStatus","value":""},{"description":"The most recent update to the card token from Account Updater. Possible values to search are cardExpiration, cardNumber, or accountClosed. This value is used as the input for a fuzzy search.","key":"lastAccountUpdaterUpdate","value":""},{"description":"This parameter has been deprecated. For Nexio internal use only. ","key":"pauseAccountUpdater","value":""},{"description":"The Boolean value that indicates whether Account Updater is enabled for this card token. This value is used as the input for an exact search.","key":"shouldUpdateCard","value":""}]},"description":"Allows you to view all saved card tokens based on the given criteria. \n\n\n> πŸ“˜ Note \n> \n> Nexio does not currently support returning terminal tokens from this endpoint. Instead, use the terminal's token with the [View card token details](ref:viewcardtokendetails) endpoint.\n\nSaved card tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).\n> \n> You can include any of the possible filters, or none of them, in your request. For example, `/card/v3/?expirationYear<2024&merchantId=000999` to return all records for the given merchantId and a card expiration year before 2024.\n\n
    \n\n## Request parameters\n- limit\n- offset\n- createdAt\n- updatedAt\n- merchantId\n- merchantIds\n- customerRef\n- expirationMonth\n- expirationYear\n- accountUpdaterStatus\n- shouldUpdateCard\n- lastAccountUpdaterUpdate\n- pauseAccountUpdater\n- cardType\n- firstSix\n- lastFour\n- token\n- cardHolderName\n\n\n## Response parameters\n- limit\n- offset\n- hasMore\n- rows.key\n- rows.merchantId\n- rows.customerRef\n- rows.expirationMonth\n- rows.expirationYear\n- rows.accountUpdaterStatus\n- rows.shouldUpdateCard\n- rows.lastAccountUpdaterUpdate\n- rows.pauseAccountUpdater\n- rows.createdAt\n- rows.updatedAt\n- rows.cardType\n- rows.firstSix\n- rows.lastFour\n- rows.token\n- rows.cardHolderName\n- random-nnnn\n\n
    "},"response":[{"id":"bf4c8efa-0860-4d03-934b-1668681430a0","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/card/v3?limit=10&offset=0&createdAt=&updatedAt=&merchantId=&merchantIds=&customerRef=&expirationMonth=&expirationYear=&cardType=&cardHolderName=&firstSix=&lastFour=&accountUpdaterStatus=&lastAccountUpdaterUpdate=&pauseAccountUpdater=&shouldUpdateCard=","host":["{{baseUrl}}"],"path":["card","v3"],"query":[{"description":"The number of records to return. ","key":"limit","value":"10"},{"description":"The offset. Used to view records further along the list.","key":"offset","value":"0"},{"description":"The date and time the payment record was created in Nexio.","key":"createdAt","value":""},{"description":"The date and time at which the payment record was most recently updated in Nexio.","key":"updatedAt","value":""},{"description":"The merchant ID associated with the card token. This value is used as the input for an exact search.","key":"merchantId","value":""},{"description":"A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a card token.","key":"merchantIds","value":""},{"description":"Customer identifier. If included in the request, the system only searches for exact matches to the value.","key":"customerRef","value":""},{"description":"The one-digit or two-digit month in which the card expires. This value is used as the input for an exact search.","key":"expirationMonth","value":""},{"description":"The year (typically two-digit) in which the card will expire. This value is used as the input for an exact search.","key":"expirationYear","value":""},{"description":"The card type specified when the card token was created. This value is used as the input for a fuzzy search.","key":"cardType","value":""},{"description":"The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.","key":"cardHolderName","value":""},{"description":"The first six digits of the card number. This value is used as the input for a fuzzy search.","key":"firstSix","value":""},{"description":"The last four digits of the card number. This value is used as the input for a fuzzy search.","key":"lastFour","value":""},{"description":"The card's account updater status with legacy providers. This parameter has been deprecated. For a list of possible values and meanings, see the account updater [card status](doc:checking-a-cards-enrollment-tag#card-status) table in Guides. This value is used as the input for a fuzzy search.","key":"accountUpdaterStatus","value":""},{"description":"The most recent update to the card token from Account Updater. Possible values to search are cardExpiration, cardNumber, or accountClosed. This value is used as the input for a fuzzy search.","key":"lastAccountUpdaterUpdate","value":""},{"description":"This parameter has been deprecated. For Nexio internal use only. ","key":"pauseAccountUpdater","value":""},{"description":"The Boolean value that indicates whether Account Updater is enabled for this card token. This value is used as the input for an exact search.","key":"shouldUpdateCard","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 10,\n \"offset\": 0,\n \"hasMore\": \"\",\n \"rows\": [\n {\n \"key\": \"\",\n \"token\": \"\",\n \"customerRef\": \"\",\n \"merchantId\": \"\",\n \"cardType\": \"mastercard\",\n \"cardHolderName\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"shouldUpdateCard\": true,\n \"accountUpdaterStatus\": \"isExcluded\",\n \"lastAccountUpdaterUpdate\": \"\",\n \"pauseAccountUpdater\": \"\"\n },\n {\n \"key\": \"\",\n \"token\": \"\",\n \"customerRef\": \"\",\n \"merchantId\": \"\",\n \"cardType\": \"jcb\",\n \"cardHolderName\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"shouldUpdateCard\": true,\n \"accountUpdaterStatus\": \"isExcluded\",\n \"lastAccountUpdaterUpdate\": \"\",\n \"pauseAccountUpdater\": \"\"\n }\n ],\n \"random-nnnn\": \"\"\n}"},{"id":"c542333b-35e2-4e00-ae01-8bb7c31d5dc0","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/card/v3?limit=10&offset=0&createdAt=&updatedAt=&merchantId=&merchantIds=&customerRef=&expirationMonth=&expirationYear=&cardType=&cardHolderName=&firstSix=&lastFour=&accountUpdaterStatus=&lastAccountUpdaterUpdate=&pauseAccountUpdater=&shouldUpdateCard=","host":["{{baseUrl}}"],"path":["card","v3"],"query":[{"description":"The number of records to return. ","key":"limit","value":"10"},{"description":"The offset. Used to view records further along the list.","key":"offset","value":"0"},{"description":"The date and time the payment record was created in Nexio.","key":"createdAt","value":""},{"description":"The date and time at which the payment record was most recently updated in Nexio.","key":"updatedAt","value":""},{"description":"The merchant ID associated with the card token. This value is used as the input for an exact search.","key":"merchantId","value":""},{"description":"A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a card token.","key":"merchantIds","value":""},{"description":"Customer identifier. If included in the request, the system only searches for exact matches to the value.","key":"customerRef","value":""},{"description":"The one-digit or two-digit month in which the card expires. This value is used as the input for an exact search.","key":"expirationMonth","value":""},{"description":"The year (typically two-digit) in which the card will expire. This value is used as the input for an exact search.","key":"expirationYear","value":""},{"description":"The card type specified when the card token was created. This value is used as the input for a fuzzy search.","key":"cardType","value":""},{"description":"The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.","key":"cardHolderName","value":""},{"description":"The first six digits of the card number. This value is used as the input for a fuzzy search.","key":"firstSix","value":""},{"description":"The last four digits of the card number. This value is used as the input for a fuzzy search.","key":"lastFour","value":""},{"description":"The card's account updater status with legacy providers. This parameter has been deprecated. For a list of possible values and meanings, see the account updater [card status](doc:checking-a-cards-enrollment-tag#card-status) table in Guides. This value is used as the input for a fuzzy search.","key":"accountUpdaterStatus","value":""},{"description":"The most recent update to the card token from Account Updater. Possible values to search are cardExpiration, cardNumber, or accountClosed. This value is used as the input for a fuzzy search.","key":"lastAccountUpdaterUpdate","value":""},{"description":"This parameter has been deprecated. For Nexio internal use only. ","key":"pauseAccountUpdater","value":""},{"description":"The Boolean value that indicates whether Account Updater is enabled for this card token. This value is used as the input for an exact search.","key":"shouldUpdateCard","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"4dbd4e2f-c746-4ee3-aac3-fcf57448cbe6"},{"name":"View card token details","id":"60ac6458-1240-4311-960e-00f5c20c86f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/pay/v3/vault/card/:cardToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","card",":cardToken"],"variable":[{"id":"29ca7cd7-666b-42f8-984d-d012d06d181f","key":"cardToken","value":"","description":"(Required) The card or terminal token you want to view. This is a path parameter."}]},"description":"Allows you to view details of a specific card or terminal token. \n\nCard tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include a saved card token in the path parameter of the request. (Due to technical limitations, the **Try It** feature does not support the use of a terminal token.)\n\n
    \n\n## Request parameters\n- cardToken\n\n## Response parameters\n- accountUpdaterStatus\n- card.expirationMonth\n- card.expirationYear\n- card.cardHolderName\n- card.firstSix\n- card.lastFour\n- card.token\n- card.cardType\n- data\n- data.customer\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.birthDate\n- data.customer.createdAtDate\n- data.customer.customerRef\n- data.customer.email\n- data.customer.firstName\n- data.customer.invoice\n- data.customer.lastName\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- dateCreated\n- dateLastModified\n- merchantId\n- shouldUpdateCard\n- tokenex\n- tokenex.cardType\n- tokenex.firstSix\n- tokenex.lastFour\n- tokenex.token\n\n
    "},"response":[{"id":"818c69a7-bc91-4803-a423-3673aef68595","name":"Success.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/vault/card/:cardToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","card",":cardToken"],"variable":[{"key":"cardToken"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"merchantId\": \"\",\n \"card\": {\n \"cardType\": \"amex\",\n \"cardHolderName\": \"\",\n \"cardNumber\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\",\n \"token\": \"\"\n },\n \"tokenex\": {\n \"cardType\": \"discover\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"token\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"accountUpdaterStatus\": \"isExcluded\",\n \"random\": \"\"\n}"},{"id":"4b51a258-1716-49ea-8567-b9dab3b52491","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/vault/card/:cardToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","card",":cardToken"],"variable":[{"key":"cardToken"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"60ac6458-1240-4311-960e-00f5c20c86f8"},{"name":"Update card token","id":"b57607b3-943f-4114-a481-c5c4a7e5d7aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"card\": {\n \"cardType\": \"jcb\",\n \"cardHolderName\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"customerRef\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n }\n },\n \"shouldUpdateCard\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/pay/v3/vault/card/:cardToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","card",":cardToken"],"variable":[{"id":"9635659d-e135-4f05-9b25-76bae5a8da2b","key":"cardToken","value":"","description":"(Required) The card token you want to edit. (Sent as a path parameter)."}]},"description":"Allows you to edit the card information, account updater status, and customer information for an existing card or terminal token. To get the current card information for a token, see the [View card tokens](ref:viewcardtokens) or [View card token details](ref:viewcardtokendetails) endpoints.\n\n\n> πŸ“˜ Note\n> \n> - Card tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.\n> - Use this endpoint to register/deregister card tokens with the account updater service.\n> - Cards registered with the account updater service may take up to 72 hours to be deregistered.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include a saved card or terminal token in the path parameter of the request, along with the new token information in the body of the request. (Due to technical limitations, the **Try It** feature does not support the use of a terminal token.)\n\n
    \n\n## Request parameters\n- cardToken\n- card\n- card.expirationMonth\n- card.expirationYear\n- card.cardHolderName\n- card.cardType\n- card.firstSix\n- card.lastFour\n- data\n- data.customer\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.birthDate\n- data.customer.customerRef\n- data.customer.email\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- shouldUpdateCard\n\n## Response parameters\n- accountUpdaterStatus\n- dateCreated\n- dateLastModified\n- merchantId\n- shouldUpdateCard\n- currencyCode\n- card\n- card.expirationMonth\n- card.expirationYear\n- card.cardHolderName\n- card.cardType\n- card.cardNumber\n- card.firstSix\n- card.lastFour\n- data\n- data.customer\n- data.customer.customerRef\n- data.customer.birthDate\n- data.customer.email\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.phone\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToState\n- data.customer.billToPostal\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToState\n- data.customer.shipToPostal\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- tokenex\n- tokenex.cardType\n- tokenex.firstSix\n- tokenex.lastFour\n- tokenex.token\n- originalCard\n- originalCard.cardHolderName\n- originalCard.expirationMonth\n- originalCard.expirationYear\n\n
    "},"response":[{"id":"dc05c21d-6b3a-4b5d-87c7-aedd651c424a","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"card\": {\n \"cardType\": \"jcb\",\n \"cardHolderName\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"customerRef\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n }\n },\n \"shouldUpdateCard\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/pay/v3/vault/card/:cardToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","card",":cardToken"],"variable":[{"key":"cardToken"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"merchantId\": \"\",\n \"currencyCode\": \"\",\n \"card\": {\n \"cardType\": \"discover\",\n \"cardHolderName\": \"\",\n \"cardNumber\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"originalCard\": {\n \"cardHolderName\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"tokenex\": {\n \"token\": \"\",\n \"cardType\": \"mastercard\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"customerRef\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"accountUpdaterStatus\": \"isExcluded\",\n \"random\": \"\"\n}"},{"id":"5a1d3673-e323-4366-b584-0b59fc0d92d6","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"card\": {\n \"cardType\": \"jcb\",\n \"cardHolderName\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"customerRef\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n }\n },\n \"shouldUpdateCard\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/pay/v3/vault/card/:cardToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","card",":cardToken"],"variable":[{"key":"cardToken"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"b57607b3-943f-4114-a481-c5c4a7e5d7aa"},{"name":"Delete card tokens","id":"57a48b51-b245-4a10-912f-d2c3e9bea8e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"tokens\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/deleteToken","description":"Allows you to delete card or terminal tokens from the card vault.\n\n\n> πŸ“˜ Note\n> \n> Cards registered with the account updater service may take up to 72 hours to be removed.\n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include an array of one or more existing card or terminal tokens in the body of the request.\n\n
    \n\n## Request parameters\n- tokens\n\n## Response parameters\n- key\n- message\n- status\n- error\n- error.0\n- error.0.message\n- error.0.tableName\n- error.1\n- error.1.message\n- error.1.cardError\n\n
    "},"response":[{"id":"5eb7c865-2034-4b82-922b-0065de3fe724","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"tokens\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/deleteToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"error\": {\n \"0\": {\n \"message\": \"\",\n \"tableName\": \"\"\n },\n \"1\": {\n \"cardError\": true,\n \"message\": \"\"\n }\n },\n \"status\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"error\": {\n \"0\": {\n \"message\": \"\",\n \"tableName\": \"\"\n },\n \"1\": {\n \"cardError\": true,\n \"message\": \"\"\n }\n },\n \"status\": \"\"\n }\n]"},{"id":"dd9c932f-f2b6-483a-8f4e-a03e91896045","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"tokens\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/deleteToken"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"57a48b51-b245-4a10-912f-d2c3e9bea8e1"},{"name":"View echeck token details","id":"df854e79-0f4d-4a54-ac2d-033c56dfbf9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/pay/v3/vault/echeck/:echeckToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","echeck",":echeckToken"],"variable":[{"id":"a5f8e530-bbad-4fd8-b987-91e146d005c6","key":"echeckToken","value":"","description":"(Required) The echeck token you want to view. This is a path parameter."}]},"description":"Allows you to view details of a specific echeck token. \n\nEcheck tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include a saved echeck token in the path parameter of the request.\n\n
    \n\n## Request parameters\n- echeckToken\n\n## Response parameters\n- bank\n- bank.accountHolderName\n- bank.routingNumber\n- tokenex\n- tokenex.lastFour\n- tokenex.token\n- data\n- data.customer\n- data.customer.orderNumber\n- data.customer.invoice\n- data.customer.customerRef\n- data.customer.companyName\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.birthDate\n- data.customer.email\n- data.customer.phone\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToState\n- data.customer.billToPostal\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToState\n- data.customer.shipToPostal\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- dateCreated\n- dateLastModified\n- merchantId\n\n
    "},"response":[{"id":"fdbbeaf4-c358-4944-a3e4-76ca7c29e7b9","name":"Success.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/vault/echeck/:echeckToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","echeck",":echeckToken"],"variable":[{"key":"echeckToken"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"bank\": {\n \"accountHolderName\": \"\",\n \"routingNumber\": \"\"\n },\n \"tokenex\": {\n \"lastFour\": \"\",\n \"token\": \"\"\n },\n \"data\": {\n \"customer\": {\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"customerRef\": \"\",\n \"companyName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n }\n },\n \"merchantId\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"random\": \"\"\n}"},{"id":"c0404fcb-33ab-4c01-b2ea-f926b238260d","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/vault/echeck/:echeckToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","echeck",":echeckToken"],"variable":[{"key":"echeckToken"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"},{"id":"6f20e354-3c6e-4f6f-b342-52395263a444","name":"Not Found.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/vault/echeck/:echeckToken","host":["{{baseUrl}}"],"path":["pay","v3","vault","echeck",":echeckToken"],"variable":[{"key":"echeckToken"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"error\": \"\"\n}"}],"_postman_id":"df854e79-0f4d-4a54-ac2d-033c56dfbf9a"}],"id":"bbfac55d-4843-46a9-ae6d-4d353653b34e","description":"APIs for ecommerce payments","_postman_id":"bbfac55d-4843-46a9-ae6d-4d353653b34e"},{"name":"Retail","item":[{"name":"Create simple login","id":"18d93431-8168-42fa-b50a-532e3189faaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/auth/v3/createSimpleLogin","description":"Simple Login allows trusted users to proceed directly to the retail/MOTO iframe without entering a Nexio username and password. This option is useful for cases in which multiple users will be using a single Nexio account. It can also save time for internal users by eliminating the need to enter a username and password upon each use.\n\nUse the `key` value from the response as a query parameter in the request to load Nexio's retail iframe. For additional information about using this endpoint, see the [Using simple login for authentication](doc:using-simple-login-for-authentication) tutorial.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments) that you want to use for transactions and other tasks with the retail iframe.\n\n
    \n\n## Response parameters\n- exp\n- jwt\n- key\n- refreshToken\n- username\n\n
    "},"response":[{"id":"e6e6928f-c050-4edb-b8af-f51e8d530748","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/auth/v3/createSimpleLogin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"username\": \"\",\n \"exp\": \"\",\n \"key\": \"\",\n \"jwt\": \"\",\n \"refreshToken\": \"\"\n}"},{"id":"0353498a-d045-42fd-83f6-ceccb46d9f77","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/auth/v3/createSimpleLogin"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"18d93431-8168-42fa-b50a-532e3189faaf"},{"name":"View terminal list","id":"9aafbc63-c2bb-4bac-ab4d-89f04274f97d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/pay/v3/getTerminalList","description":"Retrieves a list of available terminals. You use the `terminalId` from this response in order to send a POST request to the [Process transaction from terminal](ref:processtransactionfromterminal) endpoint.\n\n\n> πŸ“˜ Note \n> \n> Terminals must be configured before they are available for processing. Depending on the terminal and your merchant account configuration, you need to either [pair the terminal](ref:pairterminal) or [register the terminal](ref:registerterminal). For additional information about this process, see the [Getting started with retail](doc:getting-started-with-retail) topic in Guides.\n> \n> If you do not see your terminal in the list retrieved through this endpoint, contact [Integrations Support](page:contact-us) for assistance.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n
    \n\n## Response parameters\n- gatewayLabel\n- gatewayName\n- gatewayType\n- merchantId\n- merchantName\n- terminalId\n- terminalName\n- terminalSerialNumber\n- terminalKey\n- terminalStatus\n\n
    "},"response":[{"id":"29c58721-ecea-474d-a54f-465e0a60f551","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/pay/v3/getTerminalList"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"terminalId\": \"\",\n \"terminalSerialNumber\": \"\",\n \"deviceId\": \"\",\n \"terminalKey\": \"\",\n \"terminalName\": \"\",\n \"terminalStatus\": \"disconnected\",\n \"merchantId\": \"\",\n \"merchantName\": \"\",\n \"gatewayName\": \"\",\n \"gatewayType\": \"\",\n \"gatewayLabel\": \"\"\n },\n {\n \"terminalId\": \"\",\n \"terminalSerialNumber\": \"\",\n \"deviceId\": \"\",\n \"terminalKey\": \"\",\n \"terminalName\": \"\",\n \"terminalStatus\": \"disconnected\",\n \"merchantId\": \"\",\n \"merchantName\": \"\",\n \"gatewayName\": \"\",\n \"gatewayType\": \"\",\n \"gatewayLabel\": \"\"\n }\n]"},{"id":"06c5e966-84d8-47f4-8aed-f743495e6c2f","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/pay/v3/getTerminalList"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"9aafbc63-c2bb-4bac-ab4d-89f04274f97d"},{"name":"Process transaction from terminal","id":"8c6383d3-148d-493e-b6e5-1ffcc590da82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"terminalId\": \"\",\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"card\": {\n \"cardHolderName\": \"\"\n },\n \"isAuthOnly\": false,\n \"clientIp\": \"\",\n \"processingOptions\": {\n \"saveCardToken\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/processFromTerminal","description":"Initiates a transaction through a terminal through the Nexio API rather than using the retail iframe. For more information on how to use this endpoint, see the steps in [Processing a transaction with a terminal](doc:processing-a-transaction-with-a-terminal) in Guides.\n\nYou can also specify to save the card token from the terminal transaction so that you can use it for future transactions (through the [Run card transaction](ref:runcardtransaction) endpoint).\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments). \n> \n> You must also have a terminal connected to the Nexio account. For more information, see the [Pair terminal](ref:pairterminal) or [Register terminal](ref:registerterminal) endpoints.\n\n
    \n\n## Request parameters\n- data\n- data.amount\n- data.currency\n- data.customFields\n- data.customer\n- data.customer.customerRef\n- data.customer.orderNumber\n- data.customer.orderDate\n- data.customer.invoice\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.birthDate\n- data.customer.nationalIdentificationNumber\n- data.customer.email\n- data.customer.phone\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToState\n- data.customer.billToPostal\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToState\n- data.customer.shipToPostal\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.description\n- data.lodging\n- data.lodging.advanceDeposit\n- data.lodging.checkInDate\n- data.lodging.checkOutDate\n- data.lodging.noShow\n- data.lodging.roomNumber\n- data.lodging.roomRate\n- terminalId\n- processingOptions.saveCardToken\n- isAuthOnly\n- card\n- card.cardHolderName\n\n## Response parameters\n- terminalRequestId\n- terminalRequestStatus\n\n
    "},"response":[{"id":"907b210c-3ff1-41aa-b765-c074a5b7f8f1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"terminalId\": \"\",\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"card\": {\n \"cardHolderName\": \"\"\n },\n \"isAuthOnly\": false,\n \"clientIp\": \"\",\n \"processingOptions\": {\n \"saveCardToken\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/processFromTerminal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"terminalRequestId\": \"\",\n \"terminalRequestStatus\": \"initialized\",\n \"random\": \"\"\n}"},{"id":"97fddf2a-8e23-4525-b7db-7123188a65fe","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"terminalId\": \"\",\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"card\": {\n \"cardHolderName\": \"\"\n },\n \"isAuthOnly\": false,\n \"clientIp\": \"\",\n \"processingOptions\": {\n \"saveCardToken\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/processFromTerminal"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"8c6383d3-148d-493e-b6e5-1ffcc590da82"},{"name":"View terminal transaction status","id":"69b18b25-933f-489f-a371-1d07b452c181","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/pay/v3/processFromTerminal/:terminalRequestId","host":["{{baseUrl}}"],"path":["pay","v3","processFromTerminal",":terminalRequestId"],"variable":[{"id":"f1e92021-ed64-4d97-bf3f-5594b2389f50","key":"terminalRequestId","value":"","description":"(Required) The terminal request ID. Found in the response of [Process transaction from terminal](ref:processtransactionfromterminal) endpoint. This is submitted as a path parameter."}]},"description":"Checks the status of a transaction run through a terminal.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n
    \n\n## Request parameters\n- terminalRequestId\n\n## Response parameters\n- gatewayResponse\n- gatewayResponse.gatewayName\n- currency\n- transactionStatus\n- terminal.token\n- terminalRequestId\n- authCode\n- transactionType\n- card\n- card.cardType\n- card.cardHolder\n- card.cardNumber\n- card.firstSix\n- card.lastFour\n- card.expirationMonth\n- card.expirationYear\n- processingOptions\n- processingOptions.merchantId\n- terminalRequestStatus\n- data\n- data.description\n- data.amount\n- data.currency\n- data.cart\n- data.cart.items\n- data.cart.items.item\n- data.cart.items.description\n- data.cart.items.quantity\n- data.cart.items.price\n- data.cart.items.type\n- data.customFields\n- data.customFields.exampleKey\n- data.customer\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.customerRef\n- data.customer.orderNumber\n- data.customer.invoice\n- data.customer.email\n- data.customer.phone\n- data.customer.billToPhone\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToState\n- data.customer.billToPostal\n- data.customer.billToCountry\n- data.customer.shipToPhone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToState\n- data.customer.shipToPostal\n- data.customer.shipToCountry\n- data.lodging\n- data.lodging.advanceDeposit\n- data.lodging.checkInDate\n- data.lodging.checkOutDate\n- data.lodging.noShow\n- data.lodging.roomNumber\n- data.lodging.roomRate\n- amount\n- transactionDate\n- id (this is the paymentId)\n\n\n
    "},"response":[{"id":"a7a5132d-d36d-4824-8869-48fad5c9a288","name":"Success.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/processFromTerminal/:terminalRequestId","host":["{{baseUrl}}"],"path":["pay","v3","processFromTerminal",":terminalRequestId"],"variable":[{"key":"terminalRequestId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"terminalRequestId\": \"\",\n \"terminalRequestStatus\": \"failed\",\n \"id\": \"\",\n \"transactionStatus\": \"\",\n \"transactionType\": \"\",\n \"transactionDate\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"authCode\": \"\",\n \"currency\": \"USD\",\n \"amount\": \"\",\n \"card\": {\n \"cardHolder\": \"\",\n \"cardNumber\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\",\n \"cardType\": \"discover\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"processingOptions\": {\n \"merchantId\": \"\"\n },\n \"terminal\": {\n \"token\": \"\"\n },\n \"gatewayResponse\": {\n \"gatewayName\": \"\"\n },\n \"random\": \"\"\n}"},{"id":"8254974b-b394-408a-b85a-bcbe5cb3a2ca","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/processFromTerminal/:terminalRequestId","host":["{{baseUrl}}"],"path":["pay","v3","processFromTerminal",":terminalRequestId"],"variable":[{"key":"terminalRequestId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"},{"id":"1dc20ab5-adc7-4c7a-b7bb-aed17b6f68d9","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/pay/v3/processFromTerminal/:terminalRequestId","host":["{{baseUrl}}"],"path":["pay","v3","processFromTerminal",":terminalRequestId"],"variable":[{"key":"terminalRequestId"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"error\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\"\n }\n}"}],"_postman_id":"69b18b25-933f-489f-a371-1d07b452c181"},{"name":"Pair terminal","id":"08984319-4499-4e9d-86a8-a6492d34a11a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"terminalName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/pairTerminal","description":"Initiates pairing with a terminal. \n\nDepending on the merchant account configuration, when you add a terminal, you either need to request a pairing code or [add a registration code](ref:registerterminal). Some accounts may be configured to do both terminal setup options if the account is configured with multiple eligible gateways.\n\nFor more information on how to pair a terminal, see [Pairing the terminal](doc:configuring-your-terminal-for-usaepay#pairing-the-terminal) in Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n
    \n\n## Request parameters\n- merchantId\n- terminalName\n\n## Response parameters\n- terminalName\n- pairingCode\n- expirationDate\n- key\n\n
    "},"response":[{"id":"b1398bfc-4512-478f-bad7-c65036ba05c0","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"terminalName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/pairTerminal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"terminalName\": \"\",\n \"pairingCode\": \"\",\n \"expirationDate\": \"\",\n \"key\": \"\",\n \"random-4611765\": \"\"\n}"},{"id":"defb1df6-ed4f-451e-a7df-3d5e097a6e8f","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"terminalName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/pairTerminal"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"08984319-4499-4e9d-86a8-a6492d34a11a"},{"name":"Register terminal","id":"cdc3b4ce-c83a-4472-8576-46d805527dce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"terminalRegistrationCode\": \"\",\n \"terminalName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/registerTerminal","description":"Provides a registration (or activation) code from a terminal to Nexio's API in order to register the terminal with the appropriate gateway.\n\nDepending on the merchant account configuration, when you add a terminal, you either need to add a registration code or [request a pairing code](ref:pairterminal). Some accounts may be configured to do both terminal setup options if the account is configured with multiple eligible gateways.\n\nIf you are unsure which endpoint to use, please contact [Support](https://docs.nexiopay.com/page/contact-us).\n\nFor a tutorial on how to use this endpoint, see the [Registering and deregistering terminals](doc:registering-and-deregistering-terminals) topic in **Guides**.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments) and you must have an account with a gateway that requires terminal registration.\n\n
    \n\n## Request parameters\n- merchantId\n- terminalRegistrationCode\n- terminalName\n\n## Response parameters\n- terminalName\n- deviceId\n- terminalSerialNumber\n- terminalRegistrationStatus\n- terminalId\n\n
    "},"response":[{"id":"e1fcfa03-7fc7-4fe4-9b90-cc99df165675","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"terminalRegistrationCode\": \"\",\n \"terminalName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/registerTerminal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"terminalId\": \"\",\n \"terminalSerialNumber\": \"\",\n \"terminalRegistrationStatus\": \"failed\",\n \"terminalName\": \"\",\n \"deviceId\": \"\",\n \"random-4611765\": \"\"\n}"},{"id":"52bf759e-154a-4590-94c2-ead2de1d8524","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"terminalRegistrationCode\": \"\",\n \"terminalName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/registerTerminal"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\",\n \"random\": \"\"\n}"},{"id":"3462998d-744e-4a58-bf2e-a15f42706350","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"terminalRegistrationCode\": \"\",\n \"terminalName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/registerTerminal"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"cdc3b4ce-c83a-4472-8576-46d805527dce"},{"name":"Deregister terminal","id":"c6fb5b60-1539-4bf1-8501-7256c734310b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"terminalId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/deregisterTerminal","description":"Removes a terminal's registration through the Nexio API. \n\n\n> πŸ“˜ Notes\n> \n> - In addition to this API, you can deregister a terminal directly within the gateway user interface.\n> - You can only deregister terminals that have already been [registered](ref:registerterminal) with Nexio. \n> - You may need to deregister a terminal in situations such as when the terminal needs to be used with a different gateway account.\n\nFor a tutorial on how to use this endpoint, see the [Registering and deregistering terminals](doc:registering-and-deregistering-terminals) topic in **Guides**.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments) and you must have an account with a gateway that supports terminal registration.\n\n
    \n\n## Request parameters\n- terminalId\n\n## Response parameters\n- terminalRegistrationStatus\n\n
    "},"response":[{"id":"69175aa3-bbc0-4b13-8892-a60f2fb2e70f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"terminalId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/deregisterTerminal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"terminalRegistrationStatus\": \"failed\",\n \"random-4611765\": \"\"\n}"},{"id":"de906e9f-7e10-47ba-a977-92b54d474854","name":"Bad Request.\r\n\r\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"terminalId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/deregisterTerminal"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\",\n \"random\": \"\"\n}"},{"id":"684618e9-2d91-4568-a452-fcc2e233e69a","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"terminalId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/pay/v3/deregisterTerminal"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"c6fb5b60-1539-4bf1-8501-7256c734310b"}],"id":"dffe2f0b-a29e-4d60-a09d-e246ed38ec98","description":"APIs for retail payments","_postman_id":"dffe2f0b-a29e-4d60-a09d-e246ed38ec98"},{"name":"Subscriptions","item":[{"name":"Create a subscription","id":"e488cb78-734b-4d94-808e-4c719bd2947d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"settlementCurrency\": \"\"\n },\n \"processingOptions\": {\n \"paymentType\": \"initialScheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": true,\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"isAuthOnly\": false,\n \"shouldUpdateCard\": true\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscription/v3","description":"\n> πŸ›‘ Important\n> \n> Nexio does not currently recommend using the Subscription service for a 3DS flow. For other options, see [Getting started with subscriptions](doc:getting-started-with-subscriptions) in Guides.\n> \n\nCreates a recurring payment as a subscription or payment plan. For guides to using this endpoint, see the [Recurring billing overview](doc:recurring-billing-overview) topic.\n\nA successful request to this endpoint processes an initial transaction using a saved card token and schedules recurring transactions. All transactions are processed with the values provided in the `payment` object or the [data saved in the card token](doc:what-data-is-saved-with-tokens). The scheduled transaction runs according to the values provided in the `schedule` object.\n\nAlso, in order to have a customer skip a month for an existing subscription or payment plan, you need to delete the current one and then recreate it to start with an `initialBillingAmount` of `0` and have the `dateInitialBillingEnd` happen a month before the next scheduled payment.\n\n\n> πŸ“˜ Note\n> \n> If the initial transaction is declined, the subscription or payment plan will not be created. It must be re-created with a new card token.\n>\n> After the subscription or payment plan is created, if a subsequent transaction gets declined or has an error, the system retries the transaction up to three times, one minute apart. On the third failure, the system stops trying for that installment, the subscription or payment plan remains active, and the system tries again at the next scheduled payment date. In this instance, the merchant would need to contact the customer about the missed payment or transaction. Also, if you have webhooks configured, you will receive a webhook for each of the failures. For additional information about this, see the [Creating a Nexio-scheduled card subscription](doc:creating-a-subscription) or [Creating a Nexio-scheduled card payment plan](doc:creating-a-pay-plan) tutorial.\n> \n> However, with [Decline recovery](doc:decline-recovery-overview) and when the subscription or payment plan was created with the `retryOnSoftDecline` parameter, instead of doing the three retries at a minute apart, the system retries according to the recommendation received from the Decline recovery system.\n\n\n> πŸ›‘ Important\n> \n> When needing to use a 3DS flow to create a subscription, you must first run a customer-facing transaction where the customer proceeds through the 3DS flow (see the [Using 3DS to run transactions](doc:using-3ds-to-run-transactions) tutorial). Make sure you use a `paymentType` of `initialScheduled` and also save the card token as part of the process. \n> \n> Then, use this endpoint to create the subscription with that saved card token and a `paymentType` of `scheduled`.\n> \n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include at least a saved card token in the `tokenex.token` parameter, the amount and currency for the transaction, the payment type, and a customer reference number. You can also include the appropriate subscription parameters.\n\n
    \n\n## Request parameters\n- payment\n- payment.tokenex\n- payment.tokenex.token\n- payment.tokenex.firstSix\n- payment.tokenex.lastFour\n- payment.isAuthOnly\n- payment.shouldUpdateCard\n- payment.processingOptions\n- payment.processingOptions.saveCardToken\n- payment.processingOptions.retryOnSoftDecline\n- payment.processingOptions.checkFraud\n- payment.processingOptions.shouldUseFingerprint\n- payment.processingOptions.check3ds\n- payment.processingOptions.verboseResponse\n- payment.processingOptions.paymentType\n- payment.processingOptions.paymentOptionTag\n- payment.processingOptions.merchantId\n- payment.processingOptions.customerRedirectUrl\n- payment.data\n- payment.data.amount\n- payment.data.currency\n- payment.data.settlementCurrency\n- payment.data.customer\n- payment.data.customer.customerRef\n- payment.data.customer.invoice\n- payment.data.customer.orderNumber\n- payment.data.customer.orderDate\n- payment.data.customer.birthDate\n- payment.data.customer.nationalIdentificationNumber\n- payment.data.customer.companyName\n- payment.data.customer.firstName\n- payment.data.customer.lastName\n- payment.data.customer.email\n- payment.data.customer.phone\n- payment.data.customer.billToAddressOne\n- payment.data.customer.billToAddressTwo\n- payment.data.customer.billToCity\n- payment.data.customer.billToState\n- payment.data.customer.billToPostal\n- payment.data.customer.billToCountry\n- payment.data.customer.billToPhone\n- payment.data.customer.shipToAddressOne\n- payment.data.customer.shipToAddressTwo\n- payment.data.customer.shipToCity\n- payment.data.customer.shipToState\n- payment.data.customer.shipToPostal\n- payment.data.customer.shipToCountry\n- payment.data.customer.shipToPhone\n- payment.data.customer.createdAtDate\n- schedule\n- schedule.interval\n- schedule.intervalCount\n- schedule.balance\n- schedule.duration\n- schedule.dateInitialBillingEnd\n- schedule.intialBillingAmount\n- schedule.dateCancelAfter\n\n## Response parameters\n- customerRef\n- active\n- accountId\n- id\n- payment\n- payment.tokenex\n- payment.tokenex.token\n- payment.tokenex.firstSix\n- payment.tokenex.lastFour\n- payment.shouldUpdateCard\n- payment.isAuthOnly\n- payment.processingOptions\n- payment.processingOptions.saveCardToken\n- payment.processingOptions.retryOnSoftDecline\n- payment.processingOptions.checkFraud\n- payment.processingOptions.shouldUseFingerprint\n- payment.processingOptions.check3ds\n- payment.processingOptions.verboseResponse\n- payment.processingOptions.paymentType\n- payment.processingOptions.paymentOptionTag\n- payment.processingOptions.merchantId\n- payment.processingOptions.customerRedirectUrl\n- payment.data\n- payment.data.amount\n- payment.data.currency\n- payment.data.settlementCurrency\n- payment.data.customer\n- payment.data.customer.customerRef\n- payment.data.customer.invoice\n- payment.data.customer.orderNumber\n- payment.data.customer.orderDate\n- payment.data.customer.birthDate\n- payment.data.customer.nationalIdentificationNumber\n- payment.data.customer.companyName\n- payment.data.customer.firstName\n- payment.data.customer.lastName\n- payment.data.customer.email\n- payment.data.customer.phone\n- payment.data.customer.billToAddressOne\n- payment.data.customer.billToAddressTwo\n- payment.data.customer.billToCity\n- payment.data.customer.billToState\n- payment.data.customer.billToPostal\n- payment.data.customer.billToCountry\n- payment.data.customer.billToPhone\n- payment.data.customer.shipToAddressOne\n- payment.data.customer.shipToAddressTwo\n- payment.data.customer.shipToCity\n- payment.data.customer.shipToState\n- payment.data.customer.shipToPostal\n- payment.data.customer.shipToCountry\n- payment.data.customer.shipToPhone\n- payment.data.customer.createdAtDate\n- schedule\n- schedule.interval\n- schedule.intervalCount\n- schedule.initialBalance\n- schedule.balance\n- schedule.duration\n- schedule.dateInitialBillingEnd\n- schedule.intialBillingAmount\n- schedule.dateCancelAfter\n- schedule.scheduleType\n- userName\n- dateCreated\n- dateLastModified\n- dateLastRun\n- dateNextRun\n- paymentResult\n- paymentResult.amount\n- paymentResult.authCode\n- paymentResult.transactionStatus\n- paymentResult.transactionDate\n- paymentResult.transactionType\n- paymentResult.merchantId\n- paymentResult.currency\n- paymentResult.id\n- paymentResult.asyncTraceId\n- paymentResult.redirectUrl\n- paymentResult.message\n- paymentResult.status\n- paymentResult.gatewayResponse\n- paymentResult.gatewayResponse.gatewayName\n- paymentResult.gatewayResponse.refNumber\n- paymentResult.data\n- paymentResult.data.amount\n- paymentResult.data.currency\n- paymentResult.data.settlementCurrency\n- paymentResult.data.customer\n- paymentResult.data.customer.customerRef\n- paymentResult.data.customer.orderNumber\n- paymentResult.data.customer.orderDate\n- paymentResult.data.customer.invoice\n- paymentResult.data.customer.birthDate\n- paymentResult.data.customer.nationalIdentificationNumber\n- paymentResult.data.customer.companyName\n- paymentResult.data.customer.firstName\n- paymentResult.data.customer.lastName\n- paymentResult.data.customer.email\n- paymentResult.data.customer.phone\n- paymentResult.data.customer.billToAddressOne\n- paymentResult.data.customer.billToAddressTwo\n- paymentResult.data.customer.billToCity\n- paymentResult.data.customer.billToState\n- paymentResult.data.customer.billToPostal\n- paymentResult.data.customer.billToCountry\n- paymentResult.data.customer.billToPhone\n- paymentResult.data.customer.shipToAddressOne\n- paymentResult.data.customer.shipToAddressTwo\n- paymentResult.data.customer.shipToCity\n- paymentResult.data.customer.shipToState\n- paymentResult.data.customer.shipToPostal\n- paymentResult.data.customer.shipToCountry\n- paymentResult.data.customer.shipToPhone\n- paymentResult.data.customer.createdAt\n- paymentResult.card\n- paymentResult.card.cardHolder\n- paymentResult.card.cardNumber\n- paymentResult.card.expirationMonth\n- paymentResult.card.expirationYear\n- paymentResult.token\n- paymentResult.token.firstSix\n- paymentResult.token.lastFour\n- paymentResult.token.token\n- paymentResult.kountResponse\n- paymentResult.kountResponse.status\n- paymentResult.kountResponse.rules\n- lastPaymentStatus\n- lastSuccessfulPaymentDate\n- exp\n\n
    "},"response":[{"id":"3126ef1c-8008-4467-93f5-5189ce282539","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"settlementCurrency\": \"\"\n },\n \"processingOptions\": {\n \"paymentType\": \"initialScheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": true,\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"isAuthOnly\": false,\n \"shouldUpdateCard\": true\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscription/v3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customerRef\": \"\",\n \"active\": \"\",\n \"accountId\": \"\",\n \"id\": \"\",\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentType\": \"initialScheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": \"\",\n \"shouldUseFingerprint\": \"\",\n \"check3ds\": \"\",\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": \"\"\n }\n },\n \"schedule\": {\n \"scheduleType\": \"\",\n \"interval\": \"week\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBalance\": \"\",\n \"balance\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n },\n \"userName\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"dateLastRun\": \"\",\n \"dateNextRun\": \"\",\n \"paymentResult\": {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"transactionDate\": \"\",\n \"transactionType\": \"\",\n \"transactionStatus\": \"\",\n \"card\": {\n \"cardHolder\": \"\",\n \"cardNumber\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"token\": {\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"token\": \"\",\n \"cardType\": \"discover\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"kountResponse\": {\n \"status\": \"\",\n \"rules\": \"\"\n },\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"asyncTraceId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"redirectUrl\": \"\",\n \"random\": \"\"\n },\n \"lastPaymentStatus\": \"\",\n \"lastSuccessfulPaymentDate\": \"\",\n \"exp\": \"\",\n \"random\": \"\"\n}"},{"id":"66a25d7a-a720-4b37-8126-dedc4764a7c6","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"settlementCurrency\": \"\"\n },\n \"processingOptions\": {\n \"paymentType\": \"initialScheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": true,\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"isAuthOnly\": false,\n \"shouldUpdateCard\": true\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscription/v3"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"e488cb78-734b-4d94-808e-4c719bd2947d"},{"name":"View subscriptions","id":"61106ab1-ff8b-4238-b364-8a016576623d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscription/v3?limit=&accountId=&active=","host":["{{baseUrl}}"],"path":["subscription","v3"],"query":[{"description":"Specifies the maximum number of subscriptions (or payment plans) to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 subscriptions. By default, if you do not include this query parameter, the system returns all possible records.","key":"limit","value":""},{"description":"Specifies to limit results to the user who created the subscription or payment plan. This value is the Nexio account number of the user. You can get this value from the response for the [Who am I](ref:whoami) endpoint. By default, if you do not include this query parameter, the system returns all subscriptions and payment plans that for the merchant account associated with the API credentials used.","key":"accountId","value":""},{"description":"Specifies whether to include only active subscriptions (or payment plans) or only inactive ones. By default, if you do not include this query parameter, the system returns active and inactive subscriptions and payment plans.","key":"active","value":""}]},"description":"Returns the payment information and schedule for one or more existing subscriptions (or payment plans) based on the specified filter parameters.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    You do not have to include any query parameters, but you can include a value for how many results to return (`limit`), which Nexio account ID to limit results to (`accountId`), and whether to return only active subscriptions or payment plans (`active=true`).\n\n\n
    \n\n## Request parameters\n- limit\n- accountId\n- active\n\n## Response parameters\n- customerRef\n- active\n- accountId\n- id\n- payment\n- payment.tokenex\n- payment.tokenex.token\n- payment.tokenex.requestToken\n- payment.tokenex.firstSix\n- payment.tokenex.lastFour\n- payment.data\n- payment.data.amount\n- payment.data.currency\n- payment.data.customer\n- payment.data.customer.customerRef\n- payment.isPreExistingToken\n- payment.isProcessedFromServer\n- payment.subscriptionMetadata\n- payment.subscriptionMetadata.subscriptionId\n- payment.subscriptionMetadata.accountId\n- payment.subscriptionMetadata.isSubscriptionService\n- payment.clientIp\n- schedule\n- schedule.interval\n- schedule.intervalCount\n- schedule.initialBalance\n- schedule.balance\n- schedule.duration\n- schedule.dateInitialBillingEnd\n- schedule.intialBillingAmount\n- schedule.dateCancelAfter\n- schedule.scheduleType\n- userName\n- dateCreated\n- dateLastModified\n- dateLastRun\n- dateNextRun\n- paymentResult\n- paymentResult.gatewayProcessingError\n- paymentResult.message\n- paymentResult.gatewayResponse\n- paymentResult.gatewayResponse.gatewayName\n- paymentResult.gatewayResponse.refNumber\n- paymentResult.kountResults\n- paymentResult.kountResults.result\n- paymentResult.kountResults.message\n- paymentResult.merchantId\n- lastPaymentStatus\n- lastSuccessfulPaymentDate\n- exp\n\n
    "},"response":[{"id":"4dfbe94c-63ec-4d8b-a519-11d0cc4b9345","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3?limit=&accountId=&active=","host":["{{baseUrl}}"],"path":["subscription","v3"],"query":[{"description":"Specifies the maximum number of subscriptions (or payment plans) to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 subscriptions. By default, if you do not include this query parameter, the system returns all possible records.","key":"limit","value":""},{"description":"Specifies to limit results to the user who created the subscription or payment plan. This value is the Nexio account number of the user. You can get this value from the response for the [Who am I](ref:whoami) endpoint. By default, if you do not include this query parameter, the system returns all subscriptions and payment plans that for the merchant account associated with the API credentials used.","key":"accountId","value":""},{"description":"Specifies whether to include only active subscriptions (or payment plans) or only inactive ones. By default, if you do not include this query parameter, the system returns active and inactive subscriptions and payment plans.","key":"active","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": \"\",\n \"items\": [\n {\n \"customerRef\": \"\",\n \"active\": \"\",\n \"accountId\": \"\",\n \"id\": \"\",\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"requestToken\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"customerRef\": \"\"\n }\n },\n \"isPreExistingToken\": true,\n \"isProcessedFromServer\": true,\n \"subscriptionMetadata\": {\n \"subscriptionId\": \"\",\n \"accountId\": \"\",\n \"isSubscriptionService\": true\n },\n \"clientIp\": \"\"\n },\n \"schedule\": {\n \"scheduleType\": \"\",\n \"interval\": \"week\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBalance\": \"\",\n \"balance\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n },\n \"userName\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"dateLastRun\": \"\",\n \"dateNextRun\": \"\",\n \"paymentResult\": {\n \"gatewayProcessingError\": false,\n \"message\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"kountResults\": {\n \"result\": \"\",\n \"message\": \"\"\n },\n \"merchantId\": \"\"\n },\n \"lastPaymentStatus\": \"\",\n \"lastSuccessfulPaymentDate\": \"\",\n \"exp\": \"\"\n },\n {\n \"customerRef\": \"\",\n \"active\": \"\",\n \"accountId\": \"\",\n \"id\": \"\",\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"requestToken\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"customerRef\": \"\"\n }\n },\n \"isPreExistingToken\": true,\n \"isProcessedFromServer\": true,\n \"subscriptionMetadata\": {\n \"subscriptionId\": \"\",\n \"accountId\": \"\",\n \"isSubscriptionService\": true\n },\n \"clientIp\": \"\"\n },\n \"schedule\": {\n \"scheduleType\": \"\",\n \"interval\": \"day\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBalance\": \"\",\n \"balance\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n },\n \"userName\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"dateLastRun\": \"\",\n \"dateNextRun\": \"\",\n \"paymentResult\": {\n \"gatewayProcessingError\": false,\n \"message\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"kountResults\": {\n \"result\": \"\",\n \"message\": \"\"\n },\n \"merchantId\": \"\"\n },\n \"lastPaymentStatus\": \"\",\n \"lastSuccessfulPaymentDate\": \"\",\n \"exp\": \"\"\n }\n ],\n \"hasMore\": \"\"\n}"},{"id":"c8a8dc41-2e6f-4582-a09e-ee35b7625322","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3?limit=&accountId=&active=","host":["{{baseUrl}}"],"path":["subscription","v3"],"query":[{"description":"Specifies the maximum number of subscriptions (or payment plans) to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 subscriptions. By default, if you do not include this query parameter, the system returns all possible records.","key":"limit","value":""},{"description":"Specifies to limit results to the user who created the subscription or payment plan. This value is the Nexio account number of the user. You can get this value from the response for the [Who am I](ref:whoami) endpoint. By default, if you do not include this query parameter, the system returns all subscriptions and payment plans that for the merchant account associated with the API credentials used.","key":"accountId","value":""},{"description":"Specifies whether to include only active subscriptions (or payment plans) or only inactive ones. By default, if you do not include this query parameter, the system returns active and inactive subscriptions and payment plans.","key":"active","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"61106ab1-ff8b-4238-b364-8a016576623d"},{"name":"View a subscription","id":"ae410e52-2741-4349-b4c1-e4e8cc1b63c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"id":"ca3c4af8-bd9a-40d8-bbf8-789cb4edfa16","key":"id","value":"","description":"(Required) The subscription ID."}]},"description":"Returns the payment information and schedule for an existing subscription (or pay plan) based on the specified `id`.\n\nThe ID needed for the path parameter is returned in the response for the [Create a subscription](ref:createsubscription) endpoint. Alternately, you can get the `id` for a subscription if you have a `customerRef` for the [View customer subscriptions](ref:viewcustomersubscriptions) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include a subscription ID in the path parameter of the request for a subscription created by the test account.\n\n\n
    \n\n## Request parameters\n- id\n\n## Response parameters\n- customerRef\n- active\n- accountId\n- id\n- payment\n- payment.tokenex\n- payment.tokenex.token\n- payment.tokenex.firstSix\n- payment.tokenex.lastFour\n- payment.shouldUpdateCard\n- payment.isAuthOnly\n- payment.processingOptions\n- payment.processingOptions.saveCardToken\n- payment.processingOptions.retryOnSoftDecline\n- payment.processingOptions.checkFraud\n- payment.processingOptions.shouldUseFingerprint\n- payment.processingOptions.check3ds\n- payment.processingOptions.verboseResponse\n- payment.processingOptions.paymentType\n- payment.processingOptions.paymentOptionTag\n- payment.processingOptions.merchantId\n- payment.processingOptions.customerRedirectUrl\n- payment.data\n- payment.data.amount\n- payment.data.currency\n- payment.data.settlementCurrency\n- payment.data.customer\n- payment.data.customer.customerRef\n- payment.data.customer.invoice\n- payment.data.customer.orderNumber\n- payment.data.customer.orderDate\n- payment.data.customer.birthDate\n- payment.data.customer.nationalIdentificationNumber\n- payment.data.customer.companyName\n- payment.data.customer.firstName\n- payment.data.customer.lastName\n- payment.data.customer.email\n- payment.data.customer.phone\n- payment.data.customer.billToAddressOne\n- payment.data.customer.billToAddressTwo\n- payment.data.customer.billToCity\n- payment.data.customer.billToState\n- payment.data.customer.billToPostal\n- payment.data.customer.billToCountry\n- payment.data.customer.billToPhone\n- payment.data.customer.shipToAddressOne\n- payment.data.customer.shipToAddressTwo\n- payment.data.customer.shipToCity\n- payment.data.customer.shipToState\n- payment.data.customer.shipToPostal\n- payment.data.customer.shipToCountry\n- payment.data.customer.shipToPhone\n- payment.data.customer.createdAtDate\n- schedule\n- schedule.interval\n- schedule.intervalCount\n- schedule.initialBalance\n- schedule.balance\n- schedule.duration\n- schedule.dateInitialBillingEnd\n- schedule.intialBillingAmount\n- schedule.dateCancelAfter\n- schedule.scheduleType\n- userName\n- dateCreated\n- dateLastModified\n- dateLastRun\n- dateNextRun\n- paymentResult\n- paymentResult.amount\n- paymentResult.authCode\n- paymentResult.transactionStatus\n- paymentResult.transactionDate\n- paymentResult.transactionType\n- paymentResult.merchantId\n- paymentResult.currency\n- paymentResult.id\n- paymentResult.asyncTraceId\n- paymentResult.redirectUrl\n- paymentResult.message\n- paymentResult.status\n- paymentResult.gatewayResponse\n- paymentResult.gatewayResponse.gatewayName\n- paymentResult.gatewayResponse.refNumber\n- paymentResult.data\n- paymentResult.data.amount\n- paymentResult.data.currency\n- paymentResult.data.settlementCurrency\n- paymentResult.data.customer\n- paymentResult.data.customer.customerRef\n- paymentResult.data.customer.orderNumber\n- paymentResult.data.customer.orderDate\n- paymentResult.data.customer.invoice\n- paymentResult.data.customer.birthDate\n- paymentResult.data.customer.nationalIdentificationNumber\n- paymentResult.data.customer.companyName\n- paymentResult.data.customer.firstName\n- paymentResult.data.customer.lastName\n- paymentResult.data.customer.email\n- paymentResult.data.customer.phone\n- paymentResult.data.customer.billToAddressOne\n- paymentResult.data.customer.billToAddressTwo\n- paymentResult.data.customer.billToCity\n- paymentResult.data.customer.billToState\n- paymentResult.data.customer.billToPostal\n- paymentResult.data.customer.billToCountry\n- paymentResult.data.customer.billToPhone\n- paymentResult.data.customer.shipToAddressOne\n- paymentResult.data.customer.shipToAddressTwo\n- paymentResult.data.customer.shipToCity\n- paymentResult.data.customer.shipToState\n- paymentResult.data.customer.shipToPostal\n- paymentResult.data.customer.shipToCountry\n- paymentResult.data.customer.shipToPhone\n- paymentResult.data.customer.createdAt\n- paymentResult.card\n- paymentResult.card.cardHolder\n- paymentResult.card.cardNumber\n- paymentResult.card.expirationMonth\n- paymentResult.card.expirationYear\n- paymentResult.token\n- paymentResult.token.firstSix\n- paymentResult.token.lastFour\n- paymentResult.token.token\n- paymentResult.kountResponse\n- paymentResult.kountResponse.status\n- paymentResult.kountResponse.rules\n- lastPaymentStatus\n- lastSuccessfulPaymentDate\n- exp\n\n
    "},"response":[{"id":"8aa24bdb-e0c0-4d50-8c04-978916465cbf","name":"Success.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customerRef\": \"\",\n \"active\": \"\",\n \"accountId\": \"\",\n \"id\": \"\",\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentType\": \"initialScheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": \"\",\n \"shouldUseFingerprint\": \"\",\n \"check3ds\": \"\",\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": \"\"\n }\n },\n \"schedule\": {\n \"scheduleType\": \"\",\n \"interval\": \"week\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBalance\": \"\",\n \"balance\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n },\n \"userName\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"dateLastRun\": \"\",\n \"dateNextRun\": \"\",\n \"paymentResult\": {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"transactionDate\": \"\",\n \"transactionType\": \"\",\n \"transactionStatus\": \"\",\n \"card\": {\n \"cardHolder\": \"\",\n \"cardNumber\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"token\": {\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"token\": \"\",\n \"cardType\": \"discover\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"kountResponse\": {\n \"status\": \"\",\n \"rules\": \"\"\n },\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"asyncTraceId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"redirectUrl\": \"\",\n \"random\": \"\"\n },\n \"lastPaymentStatus\": \"\",\n \"lastSuccessfulPaymentDate\": \"\",\n \"exp\": \"\",\n \"random\": \"\"\n}"},{"id":"95fe4d17-a2f6-478e-b427-f5709d95ff72","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"},{"id":"a18411c0-177b-4b15-9ab1-16a0ca3e2eb0","name":"Not Found.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"error\": \"\"\n}"}],"_postman_id":"ae410e52-2741-4349-b4c1-e4e8cc1b63c8"},{"name":"Update a subscription","id":"534af192-2ad4-4730-8acc-df7c29ff683a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payment\": {\n \"data\": {\n \"amount\": \"\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"settlementCurrency\": \"\"\n },\n \"isAuthOnly\": \"\",\n \"processingOptions\": {\n \"paymentType\": \"scheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": true,\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"shouldUpdateCard\": true\n },\n \"schedule\": {\n \"interval\": \"week\",\n \"intervalCount\": \"\",\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"id":"8e260a54-1cec-4143-b077-cb3f559c0fcf","key":"id","value":"","description":"(Required) The subscription ID."}]},"description":"Updates an existing payment subscription or payment plan for the given `id`.\n\nThe ID needed for the path parameter is returned in the response for the [Create a subscription](ref:createsubscription) endpoint. Alternately, you can get the `id` for a subscription if you have a `customerRef` for the [View customer subscriptions](ref:viewcustomersubscriptions) endpoint.\n\n\n> πŸ“˜ Note\n> \n> - Card token, currency, and customer reference number cannot be updated. If you need to change any of these values, [delete](ref:deletesubscription) the existing subscription or payment plan and [create](ref:createsubscription) a new one.\n> - For an existing payment plan, none of the schedule parameters can be updated. If you need to change any of those, [delete](ref:deletesubscription) the existing payment plan and [create](ref:createsubscription) a new one.\n> - The only user with rights to edit the subscription or payment plan is the original creator. See the `user` parameter that is returned in the [View a subscription](ref:viewsubscription) or [View customer subscriptions](ref:viewcustomersubscriptions) endpoints.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include a subscription ID in the path parameter of the request for a subscription created by the test account.\n\n\n
    \n\n## Request parameters\n- id\n- payment\n- payment.tokenex\n- payment.tokenex.firstSix\n- payment.tokenex.lastFour\n- payment.isAuthOnly\n- payment.shouldUpdateCard\n- payment.processingOptions\n- payment.processingOptions.saveCardToken\n- payment.processingOptions.retryOnSoftDecline\n- payment.processingOptions.checkFraud\n- payment.processingOptions.shouldUseFingerprint\n- payment.processingOptions.check3ds\n- payment.processingOptions.verboseResponse\n- payment.processingOptions.paymentType\n- payment.processingOptions.paymentOptionTag\n- payment.processingOptions.merchantId\n- payment.processingOptions.customerRedirectUrl\n- payment.data\n- payment.data.settlementCurrency\n- payment.data.customer\n- payment.data.customer.invoice\n- payment.data.customer.orderNumber\n- payment.data.customer.orderDate\n- payment.data.customer.birthDate\n- payment.data.customer.nationalIdentificationNumber\n- payment.data.customer.companyName\n- payment.data.customer.firstName\n- payment.data.customer.lastName\n- payment.data.customer.email\n- payment.data.customer.phone\n- payment.data.customer.billToAddressOne\n- payment.data.customer.billToAddressTwo\n- payment.data.customer.billToCity\n- payment.data.customer.billToState\n- payment.data.customer.billToPostal\n- payment.data.customer.billToCountry\n- payment.data.customer.billToPhone\n- payment.data.customer.shipToAddressOne\n- payment.data.customer.shipToAddressTwo\n- payment.data.customer.shipToCity\n- payment.data.customer.shipToState\n- payment.data.customer.shipToPostal\n- payment.data.customer.shipToCountry\n- payment.data.customer.shipToPhone\n- payment.data.customer.createdAtDate\n- schedule\n- schedule.interval\n- schedule.intervalCount\n- schedule.duration\n- schedule.dateInitialBillingEnd\n- schedule.intialBillingAmount\n- schedule.dateCancelAfter\n\n## Response parameters\n- customerRef\n- active\n- accountId\n- id\n- payment\n- payment.tokenex\n- payment.tokenex.token\n- payment.tokenex.firstSix\n- payment.tokenex.lastFour\n- payment.shouldUpdateCard\n- payment.isAuthOnly\n- payment.processingOptions\n- payment.processingOptions.saveCardToken\n- payment.processingOptions.retryOnSoftDecline\n- payment.processingOptions.checkFraud\n- payment.processingOptions.shouldUseFingerprint\n- payment.processingOptions.check3ds\n- payment.processingOptions.verboseResponse\n- payment.processingOptions.paymentType\n- payment.processingOptions.paymentOptionTag\n- payment.processingOptions.merchantId\n- payment.processingOptions.customerRedirectUrl\n- payment.data\n- payment.data.amount\n- payment.data.currency\n- payment.data.settlementCurrency\n- payment.data.customer\n- payment.data.customer.customerRef\n- payment.data.customer.invoice\n- payment.data.customer.orderNumber\n- payment.data.customer.orderDate\n- payment.data.customer.birthDate\n- payment.data.customer.nationalIdentificationNumber\n- payment.data.customer.companyName\n- payment.data.customer.firstName\n- payment.data.customer.lastName\n- payment.data.customer.email\n- payment.data.customer.phone\n- payment.data.customer.billToAddressOne\n- payment.data.customer.billToAddressTwo\n- payment.data.customer.billToCity\n- payment.data.customer.billToState\n- payment.data.customer.billToPostal\n- payment.data.customer.billToCountry\n- payment.data.customer.billToPhone\n- payment.data.customer.shipToAddressOne\n- payment.data.customer.shipToAddressTwo\n- payment.data.customer.shipToCity\n- payment.data.customer.shipToState\n- payment.data.customer.shipToPostal\n- payment.data.customer.shipToCountry\n- payment.data.customer.shipToPhone\n- payment.data.customer.createdAtDate\n- schedule\n- schedule.interval\n- schedule.intervalCount\n- schedule.initialBalance\n- schedule.balance\n- schedule.duration\n- schedule.dateInitialBillingEnd\n- schedule.intialBillingAmount\n- schedule.dateCancelAfter\n- schedule.scheduleType\n- userName\n- dateCreated\n- dateLastModified\n- dateLastRun\n- dateNextRun\n- paymentResult\n- paymentResult.amount\n- paymentResult.authCode\n- paymentResult.transactionStatus\n- paymentResult.transactionDate\n- paymentResult.transactionType\n- paymentResult.merchantId\n- paymentResult.currency\n- paymentResult.id\n- paymentResult.asyncTraceId\n- paymentResult.redirectUrl\n- paymentResult.message\n- paymentResult.status\n- paymentResult.gatewayResponse\n- paymentResult.gatewayResponse.gatewayName\n- paymentResult.gatewayResponse.refNumber\n- paymentResult.data\n- paymentResult.data.amount\n- paymentResult.data.currency\n- paymentResult.data.settlementCurrency\n- paymentResult.data.customer\n- paymentResult.data.customer.customerRef\n- paymentResult.data.customer.orderNumber\n- paymentResult.data.customer.orderDate\n- paymentResult.data.customer.invoice\n- paymentResult.data.customer.birthDate\n- paymentResult.data.customer.nationalIdentificationNumber\n- paymentResult.data.customer.companyName\n- paymentResult.data.customer.firstName\n- paymentResult.data.customer.lastName\n- paymentResult.data.customer.email\n- paymentResult.data.customer.phone\n- paymentResult.data.customer.billToAddressOne\n- paymentResult.data.customer.billToAddressTwo\n- paymentResult.data.customer.billToCity\n- paymentResult.data.customer.billToState\n- paymentResult.data.customer.billToPostal\n- paymentResult.data.customer.billToCountry\n- paymentResult.data.customer.billToPhone\n- paymentResult.data.customer.shipToAddressOne\n- paymentResult.data.customer.shipToAddressTwo\n- paymentResult.data.customer.shipToCity\n- paymentResult.data.customer.shipToState\n- paymentResult.data.customer.shipToPostal\n- paymentResult.data.customer.shipToCountry\n- paymentResult.data.customer.shipToPhone\n- paymentResult.data.customer.createdAt\n- paymentResult.card\n- paymentResult.card.cardHolder\n- paymentResult.card.cardNumber\n- paymentResult.card.expirationMonth\n- paymentResult.card.expirationYear\n- paymentResult.token\n- paymentResult.token.firstSix\n- paymentResult.token.lastFour\n- paymentResult.token.token\n- paymentResult.kountResponse\n- paymentResult.kountResponse.status\n- paymentResult.kountResponse.rules\n- lastPaymentStatus\n- lastSuccessfulPaymentDate\n- exp\n\n
    "},"response":[{"id":"c7f75d06-6222-4f15-9a87-f6239dc641e6","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"payment\": {\n \"data\": {\n \"amount\": \"\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"settlementCurrency\": \"\"\n },\n \"isAuthOnly\": \"\",\n \"processingOptions\": {\n \"paymentType\": \"scheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": true,\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"shouldUpdateCard\": true\n },\n \"schedule\": {\n \"interval\": \"week\",\n \"intervalCount\": \"\",\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customerRef\": \"\",\n \"active\": \"\",\n \"accountId\": \"\",\n \"id\": \"\",\n \"payment\": {\n \"isAuthOnly\": \"\",\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\",\n \"descriptor\": \"\",\n \"lodging\": {\n \"advanceDeposit\": \"\",\n \"checkInDate\": \"\",\n \"checkOutDate\": \"\",\n \"noShow\": \"\",\n \"roomNumber\": \"\",\n \"roomRate\": \"\"\n }\n },\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"processingOptions\": {\n \"paymentType\": \"initialUnscheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": \"\",\n \"shouldUseFingerprint\": \"\",\n \"check3ds\": \"\",\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": \"\"\n }\n },\n \"schedule\": {\n \"scheduleType\": \"\",\n \"interval\": \"month\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBalance\": \"\",\n \"balance\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n },\n \"userName\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"dateLastRun\": \"\",\n \"dateNextRun\": \"\"\n}"},{"id":"0c8817c3-63e0-4d51-b250-e44dc17394bd","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"payment\": {\n \"data\": {\n \"amount\": \"\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"settlementCurrency\": \"\"\n },\n \"isAuthOnly\": \"\",\n \"processingOptions\": {\n \"paymentType\": \"scheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": true,\n \"retryOnSoftDecline\": false,\n \"checkFraud\": true,\n \"shouldUseFingerprint\": true,\n \"check3ds\": false,\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": false\n },\n \"shouldUpdateCard\": true\n },\n \"schedule\": {\n \"interval\": \"week\",\n \"intervalCount\": \"\",\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"534af192-2ad4-4730-8acc-df7c29ff683a"},{"name":"Delete a subscription","id":"af409152-26f7-4ed7-9973-6d3f5a38e41f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"id":"1fef442f-7641-4015-adbf-ffa9fd7918ab","key":"id","value":"","description":"(Required) The subscription ID."}]},"description":"Deletes an existing payment subscription (or pay plan) based on the specified `id`. Deleting a subscription or payment plan cancels it so that the system does not run any more transactions for it. For a payment plan, this may mean that there is still an unpaid balance.\n\nThe ID needed for the path parameter is returned in the response for the [Create a subscription](ref:createsubscription) endpoint. Alternately, you can get the `id` for a subscription if you have a `customerRef` for the [View customer subscriptions](ref:viewcustomersubscriptions) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include a subscription ID in the path parameter of the request for a subscription created by the test account.\n\n\n
    \n\n## Request parameters\n- id\n\n## Response parameters\n- message\n\n
    "},"response":[{"id":"64e44133-ce50-4f34-bec1-938838b8aa2a","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ce4aeb47-3847-4a27-918e-459ae1406e2a","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"},{"id":"f604b3b8-1721-4702-a265-73ea940b15ee","name":"Not Found.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3/:id","host":["{{baseUrl}}"],"path":["subscription","v3",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"error\": \"\"\n}"}],"_postman_id":"af409152-26f7-4ed7-9973-6d3f5a38e41f"},{"name":"View customer subscriptions","id":"a56fd3aa-1ce1-428f-bd25-da880eb208d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscription/v3/customerRef/:customerRef","host":["{{baseUrl}}"],"path":["subscription","v3","customerRef",":customerRef"],"variable":[{"id":"6428e367-a1f2-48bb-9d2e-3c833bea8abb","key":"customerRef","value":"","description":"(Required) The customer reference number used when creating the subscription or payment plan."}]},"description":"Returns a list of subscriptions and payment plans for a given customer reference number. This `customerRef` must have been used when creating the subscription or payment plan (see the [Create a subscription](ref:createsubscription) endpoint).\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include a customer reference number in the path parameter of the request for a subscription created by the test account.\n\n
    \n\n## Request parameters\n- customerRef\n\n## Response parameters\n- customerRef\n- active\n- accountId\n- id\n- payment\n- payment.tokenex\n- payment.tokenex.token\n- payment.tokenex.firstSix\n- payment.tokenex.lastFour\n- payment.shouldUpdateCard\n- payment.isAuthOnly\n- payment.processingOptions\n- payment.processingOptions.saveCardToken\n- payment.processingOptions.retryOnSoftDecline\n- payment.processingOptions.checkFraud\n- payment.processingOptions.shouldUseFingerprint\n- payment.processingOptions.check3ds\n- payment.processingOptions.verboseResponse\n- payment.processingOptions.paymentType\n- payment.processingOptions.paymentOptionTag\n- payment.processingOptions.merchantId\n- payment.processingOptions.customerRedirectUrl\n- payment.data\n- payment.data.amount\n- payment.data.currency\n- payment.data.settlementCurrency\n- payment.data.customer\n- payment.data.customer.customerRef\n- payment.data.customer.invoice\n- payment.data.customer.orderNumber\n- payment.data.customer.orderDate\n- payment.data.customer.birthDate\n- payment.data.customer.nationalIdentificationNumber\n- payment.data.customer.companyName\n- payment.data.customer.firstName\n- payment.data.customer.lastName\n- payment.data.customer.email\n- payment.data.customer.phone\n- payment.data.customer.billToAddressOne\n- payment.data.customer.billToAddressTwo\n- payment.data.customer.billToCity\n- payment.data.customer.billToState\n- payment.data.customer.billToPostal\n- payment.data.customer.billToCountry\n- payment.data.customer.billToPhone\n- payment.data.customer.shipToAddressOne\n- payment.data.customer.shipToAddressTwo\n- payment.data.customer.shipToCity\n- payment.data.customer.shipToState\n- payment.data.customer.shipToPostal\n- payment.data.customer.shipToCountry\n- payment.data.customer.shipToPhone\n- payment.data.customer.createdAtDate\n- schedule\n- schedule.interval\n- schedule.intervalCount\n- schedule.initialBalance\n- schedule.balance\n- schedule.duration\n- schedule.dateInitialBillingEnd\n- schedule.intialBillingAmount\n- schedule.dateCancelAfter\n- schedule.scheduleType\n- userName\n- dateCreated\n- dateLastModified\n- dateLastRun\n- dateNextRun\n- paymentResult\n- paymentResult.amount\n- paymentResult.authCode\n- paymentResult.transactionStatus\n- paymentResult.transactionDate\n- paymentResult.transactionType\n- paymentResult.merchantId\n- paymentResult.currency\n- paymentResult.id\n- paymentResult.asyncTraceId\n- paymentResult.redirectUrl\n- paymentResult.message\n- paymentResult.status\n- paymentResult.gatewayResponse\n- paymentResult.gatewayResponse.gatewayName\n- paymentResult.gatewayResponse.refNumber\n- paymentResult.data\n- paymentResult.data.amount\n- paymentResult.data.currency\n- paymentResult.data.settlementCurrency\n- paymentResult.data.customer\n- paymentResult.data.customer.customerRef\n- paymentResult.data.customer.orderNumber\n- paymentResult.data.customer.orderDate\n- paymentResult.data.customer.invoice\n- paymentResult.data.customer.birthDate\n- paymentResult.data.customer.nationalIdentificationNumber\n- paymentResult.data.customer.companyName\n- paymentResult.data.customer.firstName\n- paymentResult.data.customer.lastName\n- paymentResult.data.customer.email\n- paymentResult.data.customer.phone\n- paymentResult.data.customer.billToAddressOne\n- paymentResult.data.customer.billToAddressTwo\n- paymentResult.data.customer.billToCity\n- paymentResult.data.customer.billToState\n- paymentResult.data.customer.billToPostal\n- paymentResult.data.customer.billToCountry\n- paymentResult.data.customer.billToPhone\n- paymentResult.data.customer.shipToAddressOne\n- paymentResult.data.customer.shipToAddressTwo\n- paymentResult.data.customer.shipToCity\n- paymentResult.data.customer.shipToState\n- paymentResult.data.customer.shipToPostal\n- paymentResult.data.customer.shipToCountry\n- paymentResult.data.customer.shipToPhone\n- paymentResult.data.customer.createdAt\n- paymentResult.card\n- paymentResult.card.cardHolder\n- paymentResult.card.cardNumber\n- paymentResult.card.expirationMonth\n- paymentResult.card.expirationYear\n- paymentResult.token\n- paymentResult.token.firstSix\n- paymentResult.token.lastFour\n- paymentResult.token.token\n- paymentResult.kountResponse\n- paymentResult.kountResponse.status\n- paymentResult.kountResponse.rules\n- lastPaymentStatus\n- lastSuccessfulPaymentDate\n- exp\n\n
    "},"response":[{"id":"19988386-c687-4315-b046-6c53a83dbfc6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3/customerRef/:customerRef","host":["{{baseUrl}}"],"path":["subscription","v3","customerRef",":customerRef"],"variable":[{"key":"customerRef"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"customerRef\": \"\",\n \"active\": \"\",\n \"accountId\": \"\",\n \"id\": \"\",\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentType\": \"initialUnscheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": \"\",\n \"shouldUseFingerprint\": \"\",\n \"check3ds\": \"\",\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": \"\"\n }\n },\n \"schedule\": {\n \"scheduleType\": \"\",\n \"interval\": \"day\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBalance\": \"\",\n \"balance\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n },\n \"userName\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"dateLastRun\": \"\",\n \"dateNextRun\": \"\",\n \"paymentResult\": {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"transactionDate\": \"\",\n \"transactionType\": \"\",\n \"transactionStatus\": \"\",\n \"card\": {\n \"cardHolder\": \"\",\n \"cardNumber\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"token\": {\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"token\": \"\",\n \"cardType\": \"mastercard\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"kountResponse\": {\n \"status\": \"\",\n \"rules\": \"\"\n },\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"asyncTraceId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"redirectUrl\": \"\",\n \"random\": \"\"\n },\n \"lastPaymentStatus\": \"\",\n \"lastSuccessfulPaymentDate\": \"\",\n \"exp\": \"\",\n \"random\": \"\"\n },\n {\n \"customerRef\": \"\",\n \"active\": \"\",\n \"accountId\": \"\",\n \"id\": \"\",\n \"payment\": {\n \"tokenex\": {\n \"token\": \"\",\n \"firstSix\": \"\",\n \"lastFour\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"shouldUpdateCard\": true,\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentType\": \"initialScheduled\",\n \"paymentOptionTag\": \"\",\n \"saveCardToken\": \"\",\n \"retryOnSoftDecline\": false,\n \"checkFraud\": \"\",\n \"shouldUseFingerprint\": \"\",\n \"check3ds\": \"\",\n \"customerRedirectUrl\": \"\",\n \"merchantId\": \"\",\n \"verboseResponse\": \"\"\n }\n },\n \"schedule\": {\n \"scheduleType\": \"\",\n \"interval\": \"year\",\n \"intervalCount\": 0,\n \"duration\": \"\",\n \"dateCancelAfter\": \"\",\n \"initialBalance\": \"\",\n \"balance\": \"\",\n \"initialBillingAmount\": \"\",\n \"dateInitialBillingEnd\": \"\"\n },\n \"userName\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"dateLastRun\": \"\",\n \"dateNextRun\": \"\",\n \"paymentResult\": {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"authCode\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"transactionDate\": \"\",\n \"transactionType\": \"\",\n \"transactionStatus\": \"\",\n \"card\": {\n \"cardHolder\": \"\",\n \"cardNumber\": \"\",\n \"expirationMonth\": \"\",\n \"expirationYear\": \"\"\n },\n \"token\": {\n \"firstSix\": \"\",\n \"lastFour\": \"\",\n \"token\": \"\",\n \"cardType\": \"discover\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"customerRef\": \"\",\n \"orderNumber\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"nationalIdentificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n }\n },\n \"kountResponse\": {\n \"status\": \"\",\n \"rules\": \"\"\n },\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"asyncTraceId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"redirectUrl\": \"\",\n \"random\": \"\"\n },\n \"lastPaymentStatus\": \"\",\n \"lastSuccessfulPaymentDate\": \"\",\n \"exp\": \"\",\n \"random\": \"\"\n }\n]"},{"id":"6644b866-8307-46f5-8b42-eb5c936712c8","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/subscription/v3/customerRef/:customerRef","host":["{{baseUrl}}"],"path":["subscription","v3","customerRef",":customerRef"],"variable":[{"key":"customerRef"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"a56fd3aa-1ce1-428f-bd25-da880eb208d7"}],"id":"b27b7162-c09f-4191-9efa-884c7995e5fe","description":"APIs for subscription payments","_postman_id":"b27b7162-c09f-4191-9efa-884c7995e5fe"},{"name":"Alternative Payment Methods","item":[{"name":"Create APM one-time-use token","id":"64bf35f6-cf02-4e90-802c-e465d49f1f9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n },\n \"applePayDomain\": \"\",\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\",\n \"imageUrl\": \"\",\n \"productUrl\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\",\n \"imageUrl\": \"\",\n \"productUrl\": \"\"\n }\n ]\n },\n \"description\": \"\",\n \"descriptor\": \"\",\n \"dueDate\": \"\",\n \"locale\": \"\",\n \"paymentMethod\": \"\"\n },\n \"customerRedirectUrl\": \"\",\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentOptionTag\": \"\",\n \"doNotProcessPayment\": false,\n \"saveRecurringToken\": false,\n \"merchantId\": \"\"\n },\n \"uiOptions\": {\n \"css\": \"\",\n \"displaySubmitButton\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/token","description":"A token from this endpoint is necessary prior to loading any of the Alternative Payment Method (APM) iframes or running a transaction using an APM.\n\nAny data (amount, currency, and so forth) that you want to be sent to the alternate payment method must be included in the body of this request. For details about each APM, as well as test cards and accounts, see [Payment methods](doc:payment-methods).\n\nFor a tutorial about how to make use of this endpoint, see the [Run a sale transaction](doc:run-a-sale-transaction) topic.\n\n\n> πŸ“˜ Note\n> \n> After a token has been used to submit an iframe it cannot be used to load another. You must request a new APM one-time-use token prior to submitting each iframe.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account (that is connected with [PayPal](doc:paypal-integration-guide)). Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include any other parameters that you need for the body of the request, depending on what you are using the one-time-use token for, and which payment method you want to use. For details about each one, as well as test cards and accounts, see [Payment methods](doc:payment-methods).\n\n
    \n\n## Request parameters\n- isAuthOnly\n- data\n- data.amount\n- data.currency\n- data.customer\n- data.customer.email\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.customerRef\n- data.customer.orderNumber\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.birthDate\n- data.customer.invoice\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.cart\n- data.cart.items\n- data.cart.items.item\n- data.cart.items.description\n- data.cart.items.quantity\n- data.cart.items.price\n- data.cart.items.type\n- data.cart.items.imageUrl\n- data.cart.items.productUrl\n- data.customFields\n- data.customFields.exampleKey\n- data.description\n- data.descriptor\n- data.descriptor.name\n- data.descriptor.address\n- data.descriptor.city\n- data.descriptor.state\n- data.descriptor.postal\n- data.descriptor.country\n- data.descriptor.phone\n- data.descriptor.url\n- data.descriptor.merchantId\n- data.descriptor.mcc\n- data.dueDate\n- data.locale\n- data.paymentMethod\n- customerRedirectUrl\n- processingOptions\n- processingOptions.merchantId\n- processingOptions.doNotProcessPayment\n- processingOptions.paymentOptionTag\n- processingOptions.saveRecurringToken\n- uiOptions\n- uiOptions.displaySubmitButton\n- uiOptions.css\n\n## Response parameters\n- expiration\n- token\n- asyncTraceId\n- expressIFrameUrl\n- redirectUrls\n- redirectUrls.paymentMethod\n- redirectUrls.url\n- buttonIFrameUrls\n- buttonIFrameUrls.paymentMethod\n- buttonIFrameUrls.url\n
    "},"response":[{"id":"3a713aaf-ce0e-49a9-b093-a7ffea296881","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n },\n \"applePayDomain\": \"\",\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\",\n \"imageUrl\": \"\",\n \"productUrl\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\",\n \"imageUrl\": \"\",\n \"productUrl\": \"\"\n }\n ]\n },\n \"description\": \"\",\n \"descriptor\": \"\",\n \"dueDate\": \"\",\n \"locale\": \"\",\n \"paymentMethod\": \"\"\n },\n \"customerRedirectUrl\": \"\",\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentOptionTag\": \"\",\n \"doNotProcessPayment\": false,\n \"saveRecurringToken\": false,\n \"merchantId\": \"\"\n },\n \"uiOptions\": {\n \"css\": \"\",\n \"displaySubmitButton\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"expiration\": \"\",\n \"token\": \"\",\n \"asyncTraceId\": \"\",\n \"expressIFrameUrl\": \"\",\n \"redirectUrls\": [\n {\n \"paymentMethod\": \"\",\n \"url\": \"\"\n },\n {\n \"paymentMethod\": \"\",\n \"url\": \"\"\n }\n ],\n \"buttonIFrameUrls\": [\n {\n \"paymentMethod\": \"\",\n \"url\": \"\"\n },\n {\n \"paymentMethod\": \"\",\n \"url\": \"\"\n }\n ]\n}"},{"id":"99a58e09-1ee1-46a3-b8b2-0c3a4a6ed887","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\"\n },\n \"applePayDomain\": \"\",\n \"cart\": {\n \"items\": [\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\",\n \"imageUrl\": \"\",\n \"productUrl\": \"\"\n },\n {\n \"item\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"type\": \"\",\n \"imageUrl\": \"\",\n \"productUrl\": \"\"\n }\n ]\n },\n \"description\": \"\",\n \"descriptor\": \"\",\n \"dueDate\": \"\",\n \"locale\": \"\",\n \"paymentMethod\": \"\"\n },\n \"customerRedirectUrl\": \"\",\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentOptionTag\": \"\",\n \"doNotProcessPayment\": false,\n \"saveRecurringToken\": false,\n \"merchantId\": \"\"\n },\n \"uiOptions\": {\n \"css\": \"\",\n \"displaySubmitButton\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"64bf35f6-cf02-4e90-802c-e465d49f1f9a"},{"name":"Get APM iframe","id":"f5e56a72-b731-4817-9b78-da3fefdff95b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"}],"url":{"raw":"{{baseUrl}}/apm/v3?token=","host":["{{baseUrl}}"],"path":["apm","v3"],"query":[{"description":"(Required) Your [APM one-time-use token](ref:createapmonetimeusetoken).","key":"token","value":""}]},"description":"Returns HTML for an iframe that allows a user to redirect to the chosen alternative payment method's web page in a new window.\n\nThe alternative payment method must be chosen upon retrieval of an [APM one-time-use token](ref:createapmonetimeusetoken).\n\n\n> πŸ“˜ Note\n> \n> Only use this endpoint when you are not using one of the standard integration methods. For more information about those standard methods, see the [Supported integration methods for APMs](doc:supported-integration-methods-for-apms) topic.\n> \n> This iframe emits events, alerting you when the transaction has been submitted, processed, and so forth.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must first request an [APM one-time-use token](ref:createapmonetimeusetoken).\n\n
    \n\n## Request parameters\n- token\n\n## Response parameters\n- HTML page\n\n
    "},"response":[{"id":"765dc88a-d3c6-488d-8ca7-2a0c2f73fb07","name":"Success. \r\n\r\nReturns the code for an APM payment page with HTML, CSS, and JavaScript.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/apm/v3?token=","host":["{{baseUrl}}"],"path":["apm","v3"],"query":[{"description":"(Required) Your [APM one-time-use token](ref:createapmonetimeusetoken).","key":"token","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":""},{"id":"e657e73a-d914-4142-8592-1f784e8ffc8f","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/apm/v3?token=","host":["{{baseUrl}}"],"path":["apm","v3"],"query":[{"description":"(Required) Your [APM one-time-use token](ref:createapmonetimeusetoken).","key":"token","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"f5e56a72-b731-4817-9b78-da3fefdff95b"},{"name":"Run APM transaction","id":"d7aec3cb-5a5c-445b-946f-b4b2e2597557","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apm\": {\n \"token\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\"\n },\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentOptionTag\": \"\",\n \"webhookFailUrl\": \"\",\n \"merchantId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/process","description":"Allows you to securely process an alternative payment method transaction without a browser, such as for merchant-initiated transactions using [PayPal (with Braintree)](doc:paypal-with-braintree-integration-guide).\n\n\n> πŸ“˜ Note\n> \n> In order to use this endpoint, the following two things must be true: \n> - You must have already set `processingOptions.saveRecurringToken` to `true` in the [APM one-time-use token](ref:createapmonetimeusetoken) request for the initial transaction.\n> - Your customer must have already checked out and paid through the alternative payment method for that initial transaction.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- apm\n- apm.token\n- data\n- data.amount\n- data.currency\n- data.customer\n- data.customer.orderNumber\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.birthDate\n- data.customer.companyName\n- data.customer.createdAtDate\n- data.customer.customerRef\n- data.customer.email\n- data.customer.invoice\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.orderDate\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.customFields\n- data.customFields.exampleKey\n- data.description\n- isAuthOnly\n- processingOptions\n- processingOptions.merchantId\n- processingOptions.paymentOptionTag\n- processingOptions.webhookFailUrl\n\n## Response parameters\n- id\n- merchantId\n- transactionDate\n- transactionStatus\n- amount\n- transactionType\n- currency\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n- data\n- data.amount\n- data.currency\n- data.settlementCurrency\n- data.customer\n- data.customer.customerRef\n- data.customer.orderNumber\n- data.customer.orderDate\n- data.customer.invoice\n- data.customer.firstName\n- data.customer.lastName\n- data.customer.birthDate\n- data.customer.billToAddressOne\n- data.customer.billToAddressTwo\n- data.customer.billToCity\n- data.customer.billToCountry\n- data.customer.billToPhone\n- data.customer.billToPostal\n- data.customer.billToState\n- data.customer.email\n- data.customer.phone\n- data.customer.shipToAddressOne\n- data.customer.shipToAddressTwo\n- data.customer.shipToCity\n- data.customer.shipToCountry\n- data.customer.shipToPhone\n- data.customer.shipToPostal\n- data.customer.shipToState\n- data.customer.createdAt\n- data.customFields\n- data.customFields.exampleKey\n- data.description\n- apm\n- apm.token\n\n
    "},"response":[{"id":"23cf22fb-7348-497a-b9e0-53f17f2c30b6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"apm\": {\n \"token\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\"\n },\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentOptionTag\": \"\",\n \"webhookFailUrl\": \"\",\n \"merchantId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/process"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"amount\": \"\",\n \"transactionType\": \"\",\n \"currency\": \"\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"billToPostal\": \"\",\n \"billToState\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"shipToPostal\": \"\",\n \"shipToState\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\"\n },\n \"apm\": {\n \"token\": \"\"\n }\n}"},{"id":"f20dbc34-4aae-422e-a78d-64137e4e4626","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"apm\": {\n \"token\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer\": {\n \"orderNumber\": \"\",\n \"customerRef\": \"\",\n \"orderDate\": \"\",\n \"invoice\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"companyName\": \"\",\n \"billToAddressOne\": \"\",\n \"billToAddressTwo\": \"\",\n \"billToCity\": \"\",\n \"billToState\": \"\",\n \"billToPostal\": \"\",\n \"billToCountry\": \"\",\n \"billToPhone\": \"\",\n \"shipToAddressOne\": \"\",\n \"shipToAddressTwo\": \"\",\n \"shipToCity\": \"\",\n \"shipToState\": \"\",\n \"shipToPostal\": \"\",\n \"shipToCountry\": \"\",\n \"shipToPhone\": \"\",\n \"createdAtDate\": \"\"\n },\n \"customFields\": {\n \"exampleKey\": \"\",\n \"exampleRefNumber\": \"\"\n },\n \"description\": \"\"\n },\n \"isAuthOnly\": false,\n \"processingOptions\": {\n \"paymentOptionTag\": \"\",\n \"webhookFailUrl\": \"\",\n \"merchantId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/process"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"d7aec3cb-5a5c-445b-946f-b4b2e2597557"},{"name":"View APM transaction async status","id":"2c1fb032-98fb-4ba4-bbc1-e9555d691753","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/apm/v3/transactionAsyncStatus/:asyncTraceId","host":["{{baseUrl}}"],"path":["apm","v3","transactionAsyncStatus",":asyncTraceId"],"variable":[{"id":"7265b57d-c4be-48d7-a1cc-4e91853d31c0","key":"asyncTraceId","value":"","description":"(Required) The high-level ID of an unprocessed APM transaction for tracking progress and status. Get this value from the response from the [Create APM one-time-use token](ref:createapmonetimeusetoken) endpoint. This is a path parameter."}]},"description":"Gets information about the specified alternative payment method (APM) asynchronous transaction. Use this for tracking APM transactions submitted through the [Run APM transaction](ref:runapmtransaction) or through any of the integration methods (for more information, see [Run a sale transaction](doc:run-a-sale-transaction) in the Alternative Payment Method section of Guides). \n\nThe [Create APM one-time-use token](ref:createapmonetimeusetoken) endpoint returns the `asyncTraceId` in the response for you to use with the path parameter for this endpoint. \n\n\nFor the [Multi Iframe (Express APM)](doc:multi-iframe-express-apm) and [Individual Iframe (Button URLs)](doc:individual-iframe-button-urls) integration methods for one-time payments (non-dropin-style), the history object progresses through the following flow for a successful payment:
    • `getToken`
    • `iframe`
    • `popup`
    • `finale`
    \n\nFor the [Custom Redirect (Redirect URLs)](doc:custom-redirect-redirect-urls) integration method, the history object progresses through the following flow for a successful payment:
    • `getToken`
    • `popup`
    • `finale`
    \n\nFor first transactions in a [merchant-initiated recurring transaction](doc:run-a-merchant-initiated-recurring-transaction), the history object progressess through the following flow for a successful payment:
    • `getToken`
    • `iframe`
    • `processFromApm`
    \n\n### See also\n- For tracking 3DS transactions, see the [View transaction async status](ref:viewtransactionasyncstatus) endpoint.\n\n\n
    \n\n## Request parameters\n- asyncTraceId\n\n## Response parameters\n- gatewayResponse\n- gatewayResponse.refNumber\n- gatewayResponse.gatewayName\n- history.processFromApm\n- history.processFromApm.initiatedAt\n- history.processFromApm.updatedAt\n- history.processFromApm.state\n- history.getToken\n- history.getToken.initiatedAt\n- history.getToken.updatedAt\n- history.getToken.state\n- history.iframe\n- history.iframe.initiatedAt\n- history.iframe.updatedAt\n- history.iframe.state\n- history.popup\n- history.popup.initiatedAt\n- history.popup.updatedAt\n- history.popup.state\n- history.finale\n- history.finale.initiatedAt\n- history.finale.updatedAt\n- history.finale.state\n- updatedAt\n- initialTransactionStatus\n- createdAt\n- asyncTraceId\n\n
    "},"response":[{"id":"b149c7ca-cf6c-4bed-8322-9cdab4f8c83d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/apm/v3/transactionAsyncStatus/:asyncTraceId","host":["{{baseUrl}}"],"path":["apm","v3","transactionAsyncStatus",":asyncTraceId"],"variable":[{"key":"asyncTraceId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"history\": {\n \"getToken\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"redirectUrlReturnedFromApm\"\n },\n \"iframe\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"submitted\"\n },\n \"popup\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"submitted\"\n },\n \"finale\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"responseSent\"\n },\n \"processFromApm\": {\n \"initiatedAt\": \"\",\n \"updatedAt\": \"\",\n \"state\": \"responseSent\"\n }\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\",\n \"initialTransactionStatus\": \"\",\n \"asyncTraceId\": \"\"\n}"},{"id":"71fc0912-0fa6-4620-9d1a-9f77ff8e1f89","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/apm/v3/transactionAsyncStatus/:asyncTraceId","host":["{{baseUrl}}"],"path":["apm","v3","transactionAsyncStatus",":asyncTraceId"],"variable":[{"key":"asyncTraceId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"2c1fb032-98fb-4ba4-bbc1-e9555d691753"},{"name":"Capture an APM transaction","id":"4646639c-48f0-4e61-b941-88723a879a83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/capture","description":"Captures a previously authorized (auth only) transaction run using an Alternative Payment Method (see the [Create APM one-time-use token\n](ref:createapmonetimeusetoken) endpoint).\n\nIf you do not know the `paymentId` or `amount` to use, make a call with the [View transactions](ref:viewtransactions) endpoint with the query filter of `transactionStatus=11` and `plugin=` to get an array of possible transactions.\n\nFor more help with this endpoint, see the [Capture an auth-only APM transaction](doc:capture-an-auth-only-apm-transaction) tutorial in Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account (that is connected with [PayPal](doc:paypal-integration-guide)). Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include the ID of the payment request and the amount of the transaction in your request.\n\n
    \n\n## Request parameters\n- id\n- data\n- data.amount\n\n## Response parameters\n- id\n- merchantId\n- transactionDate\n- amount\n- transactionType\n- currency\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n- data\n- data.amount\n- data.currency\n- data.settlementCurrency\n- message\n\n
    "},"response":[{"id":"19759f14-ec85-4f0c-8510-9a980d4adec5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/capture"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"transactionType\": \"\",\n \"currency\": \"USD\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\"\n },\n \"message\": \"\"\n}"},{"id":"37839aa8-8d40-464c-9813-6deb1e7ec756","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/capture"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"4646639c-48f0-4e61-b941-88723a879a83"},{"name":"Void an APM transaction","id":"c452cc45-197b-4a4b-9443-89a2e216159b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/void","description":"Voids a transaction run using an Alternative Payment Method.\n\nIf you do not know the `paymentId` or `amount` to use, make a call with the [View transactions](ref:viewtransactions) endpoint with the query filter of `transactionStatus=10` and `plugin=` to get an array of possible transactions that have authorized but are not yet settled.\n\nFor more help with this endpoint, see the [Void an APM transaction](doc:void-an-apm-transaction) tutorial in Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account (that is connected with [PayPal](doc:paypal-integration-guide)). Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include the paymentID of the transaction in your request.\n\n
    \n\n## Request parameters\n- id\n- data\n- data.amount\n\n## Response parameters\n- id\n- merchantId\n- transactionDate\n- amount\n- transactionType\n- currency\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n- data\n- data.amount\n- data.currency\n- data.settlementCurrency\n- message\n\n
    "},"response":[{"id":"e6c22198-b1e5-4e1f-9052-58969222ff7a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"transactionType\": \"\",\n \"currency\": \"USD\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\"\n },\n \"message\": \"\"\n}"},{"id":"dd2d51ae-1fa4-4605-9c7d-d5e20ff2fa64","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/void"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"c452cc45-197b-4a4b-9443-89a2e216159b"},{"name":"Refund an APM transaction","id":"3d91e805-9eb1-4821-85d3-8937cb7208c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/refund","description":"Refunds a transaction using an Alternative Payment Method.\n\nIf you do not know the `paymentId` or `amount` to use, make a call with the [View transactions](ref:viewtransactions) endpoint with the query filter of `transactionStatus=10` and `plugin=` to get an array of possible transactions that have authorized or `transactionStatus=20` and `plugin=` for transactions that are settled.\n\nFor more help with this endpoint, see the [Refund a transaction](doc:refund-a-transaction) tutorial in Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account (that is connected with [PayPal](doc:paypal-integration-guide)). Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include the ID of the payment request and the amount of the transaction in your request.\n\n
    \n\n## Request parameters\n- id\n- data\n- data.amount\n\n## Response parameters\n- id\n- merchantId\n- transactionDate\n- amount\n- transactionType\n- currency\n- gatewayResponse\n- gatewayResponse.gatewayName\n- gatewayResponse.refNumber\n- data\n- data.amount\n- data.currency\n- data.settlementCurrency\n- message\n\n
    "},"response":[{"id":"25616362-3e85-4721-8fb9-57a4c1cee53f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"transactionType\": \"\",\n \"currency\": \"USD\",\n \"gatewayResponse\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\"\n },\n \"data\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"settlementCurrency\": \"\"\n },\n \"message\": \"\"\n}"},{"id":"35edd0c4-4fdf-4396-bca1-d15e91458065","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"data\": {\n \"amount\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/apm/v3/refund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"3d91e805-9eb1-4821-85d3-8937cb7208c0"}],"id":"ecd2c2c4-5657-4e14-ae7a-334506a1ef5d","description":"APIs for APM payments","_postman_id":"ecd2c2c4-5657-4e14-ae7a-334506a1ef5d"},{"name":"Recipients","item":[{"name":"Create a recipient","id":"0cff8cac-3bc9-49f5-8760-0960abedbbf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"recipientRef\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"country\": \"\",\n \"providerId\": \"\",\n \"userType\": \"BUSINESS\",\n \"gender\": \"MALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"currency\": \"\",\n \"addressType\": \"RESIDENTIAL\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberCountry\": \"\",\n \"mobileNumber\": \"\",\n \"mobileNumberCountry\": \"\",\n \"governmentIdType\": \"\",\n \"recipientIdNumbers\": {\n \"governmentId\": \"\",\n \"passportId\": \"\",\n \"driversLicenseId\": \"\",\n \"employerId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/recipient","description":"Creates a recipient profile to which payments can be sent. A recipient is the individual or business receiving payments. Before paying out to a recipient, you must first create a recipient profile, either as a separate process or at the same time as the [payout request](ref:submitpayouts).\n\n\n> πŸ“˜ Note \n> \n> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with [Update recipient](ref:updaterecipient) endpoint.\n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include at least a `recipientRef`, recipient `email`, recipient `firstName` and `lastName`, and the `country` for the recipient.\n\n
    \n\n## Request parameters\n- recipientRef\n- email\n- firstName\n- lastName\n- country\n- providerId\n- userType\n- gender\n- birthDate\n- countryOfBirth\n- countryOfNationality\n- currency\n- addressType\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- phoneNumber\n- phoneNumberCountry\n- mobileNumber\n- mobileNumberCountry\n- governmentIdType\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n\n## Response parameters\n- recipientRef\n- recipientId\n- payoutAccountId\n- providerId\n- providerType\n- providerRecipientRef\n- userType\n- firstName\n- lastName\n- gender\n- birthDate\n- countryOfBirth\n- countryOfNationality\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- country\n- email\n- phoneNumber\n- mobileNumber\n- governmentIdType\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"469e9861-6fe1-4197-91ec-0fe9661fa466","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"recipientRef\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"country\": \"\",\n \"providerId\": \"\",\n \"userType\": \"BUSINESS\",\n \"gender\": \"MALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"currency\": \"\",\n \"addressType\": \"RESIDENTIAL\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberCountry\": \"\",\n \"mobileNumber\": \"\",\n \"mobileNumberCountry\": \"\",\n \"governmentIdType\": \"\",\n \"recipientIdNumbers\": {\n \"governmentId\": \"\",\n \"passportId\": \"\",\n \"driversLicenseId\": \"\",\n \"employerId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/recipient"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"recipientRef\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 30,\n \"providerRecipientRef\": \"\",\n \"userType\": \"BUSINESS\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"governmentIdType\": \"\",\n \"recipientIdNumbers\": {\n \"driversLicenseId\": \"\",\n \"employerId\": \"\",\n \"governmentId\": \"\",\n \"passportId\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"44af6b6e-c8ed-44ed-87ec-a03ed9de48e8","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"recipientRef\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"country\": \"\",\n \"providerId\": \"\",\n \"userType\": \"BUSINESS\",\n \"gender\": \"MALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"currency\": \"\",\n \"addressType\": \"RESIDENTIAL\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberCountry\": \"\",\n \"mobileNumber\": \"\",\n \"mobileNumberCountry\": \"\",\n \"governmentIdType\": \"\",\n \"recipientIdNumbers\": {\n \"governmentId\": \"\",\n \"passportId\": \"\",\n \"driversLicenseId\": \"\",\n \"employerId\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/recipient"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"0cff8cac-3bc9-49f5-8760-0960abedbbf8"},{"name":"View recipients","id":"aacf67de-269b-48ef-8f49-bf57b5f8fa06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient?limit=10&offset=0&startDate=&endDate=&recipientId=&recipientRef=&providerRecipientRef=&providerType=10&email=&firstName=&lastName=&phoneNumber=&mobileNumber=&addressLine1=&addressLine2=&city=®ion=&postalCode=&country=&countryOfBirth=&countryOfNationality=&providerId=&payoutAccountId=&recipientIdNumbers.=&recipientIdNumbers.governmentId=&recipientIdNumbers.passportId=&recipientIdNumbers.employerId=&recipientIdNumbers.driversLicenseId=&userType=BUSINESS&birthDate=&gender=MALE&addressType=BUSINESS&phoneNumberCountry=&mobileNumberCountry=&governmentIdType=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3","recipient"],"query":[{"description":"The maximum number of recipients to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many recipient records before beginning to return recipients in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset recipients are skipped before starting to count the recipients to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a recipient record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all recipients created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date. ","key":"startDate","value":""},{"description":"The end date to use for a search of when a recipient record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all recipients created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"Payer's unique reference value for the recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"Reference value for the recipient from the payout provider. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerRecipientRef","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"The recipient's email address. This value is used to perform a 'contains' search.","key":"email","value":""},{"description":"The recipient's first name. This value is used to perform a 'contains' search.","key":"firstName","value":""},{"description":"The recipient's last name. This value is used to perform a 'contains' search.","key":"lastName","value":""},{"description":"The recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumber","value":""},{"description":"The recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumber","value":""},{"description":"The recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine1","value":""},{"description":"Additional information about the recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine2","value":""},{"description":"The recipient's city. This value is used to perform a 'contains' search.","key":"city","value":""},{"description":"The recipient's state, province, or region. This value is used to perform a 'contains' search.","key":"region","value":""},{"description":"The recipient's postal code. This value is used to perform a 'contains' search.","key":"postalCode","value":""},{"description":"The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the recipient's address. This value is used to perform a 'contains' search.","key":"country","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the country where the recipient was born. This value is used to perform a 'contains' search.","key":"countryOfBirth","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the recipient's country of citizenship or nationality. This value is used to perform a 'contains' search.","key":"countryOfNationality","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"Send this as an empty query parameter in order to have all recipient ID number data for the recipient returned in the response. For example, `https://{api_url}/payout/v3/recipient?recipientIdNumbers.`, returns all recipients for the API user (as a paged list) and gives all information from the `recipientIdNumbers` object in the response. Alternatively, you can instead send a specific `recipientIdNumbers` parameter (such as `governmentId`) to match against and you will get the entire `recipientIdNumbers` object for each of the matching recipients.","key":"recipientIdNumbers.","value":""},{"description":"The recipient's government ID. The value corresponds to the selection for the `governmentIdType` parameter. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.governmentId","value":""},{"description":"The recipient's passport ID. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.passportId","value":""},{"description":"The recipient's employer ID. This is generally used for tax purposes. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.employerId","value":""},{"description":"The recipient's driver's license number. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.driversLicenseId","value":""},{"description":"The user type associated with the recipient. This value is used to perform an 'exact match' search.","key":"userType","value":"BUSINESS"},{"description":"The recipient's date of birth, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date. This value is used to perform a 'contains' search.","key":"birthDate","value":""},{"description":"The recipient's gender. This value is used to perform a 'contains' search.","key":"gender","value":"MALE"},{"description":"The type of address associated with this recipient for the specified address information. This value is used to perform a 'contains' search.","key":"addressType","value":"BUSINESS"},{"description":"The country associated with the recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumberCountry","value":""},{"description":"The country associated with the recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumberCountry","value":""},{"description":"Type of the government ID provided for the recipient. This value is used to perform a 'contains' search.

    The ID indicated by this value corresponds to the ID provided in the `recipientIdNumbers.governmentId` parameter.","key":"governmentIdType","value":""},{"description":"The date and time the recipient record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time the recipient record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]},"description":"Returns all recipients that meet the specified parameters (if any) and that are associated with the Nexio account used to [authenticate](doc:authentication).\n\nYou may also request to return additional parameters and/or filter results using one or more [query parameters](doc:filtering-using-query-parameters).\n\n\n> πŸ“˜ Notes\n>\n> For example, to return (filter) all recipients where the address' country is NL and also (request to include) the `recipientIdNumbers` object in the response, the request would look like this:\n> /payout/v3/recipient?recipientIdNumbers.&country=NL

    To return (filter) only the recipient with the specified `recipientRef` parameter, the request would look like this:\n> /payout/v3/recipient?recipientRef=10524260

    For a more detailed tutorial, see the [query parameters](doc:filtering-using-query-parameters) section of Guides.\n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- limit\n- offset\n- startDate\n- endDate\n- recipientId\n- recipientRef\n- providerRecipientRef\n- providerType\n- email\n- firstName\n- lastName\n- phoneNumber\n- mobileNumber\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- country\n- countryOfBirth\n- countryOfNationality\n- providerId\n- payoutAccountId\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- userType\n- birthDate\n- gender\n- addressType\n- phoneNumberCountry\n- mobileNumberCountry\n- governmentIdType\n- createdAt\n- updatedAt\n\n## Response parameters\n- offset\n- limit\n- rows\n- rows.recipientRef\n- rows.recipientId\n- rows.payoutAccountId\n- rows.providerId\n- rows.providerType\n- rows.providerRecipientRef\n- rows.userType\n- rows.firstName\n- rows.lastName\n- rows.gender\n- rows.birthDate\n- rows.countryOfBirth\n- rows.countryOfNationality\n- rows.addressLine1\n- rows.addressLine2\n- rows.city\n- rows.region\n- rows.postalCode\n- rows.country\n- rows.email\n- rows.phoneNumber\n- rows.mobileNumber\n- rows.governmentIdType\n- rows.recipientIdNumbers\n- rows.recipientIdNumbers.governmentId\n- rows.recipientIdNumbers.passportId\n- rows.recipientIdNumbers.employerId\n- rows.recipientIdNumbers.driversLicenseId\n- rows.createdAt\n- rows.updatedAt\n- hasMore\n\n
    "},"response":[{"id":"62a803c9-4539-48fc-a6ae-9c784f8f29a2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient?limit=10&offset=0&startDate=&endDate=&recipientId=&recipientRef=&providerRecipientRef=&providerType=10&email=&firstName=&lastName=&phoneNumber=&mobileNumber=&addressLine1=&addressLine2=&city=®ion=&postalCode=&country=&countryOfBirth=&countryOfNationality=&providerId=&payoutAccountId=&recipientIdNumbers.=&recipientIdNumbers.governmentId=&recipientIdNumbers.passportId=&recipientIdNumbers.employerId=&recipientIdNumbers.driversLicenseId=&userType=BUSINESS&birthDate=&gender=MALE&addressType=BUSINESS&phoneNumberCountry=&mobileNumberCountry=&governmentIdType=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3","recipient"],"query":[{"description":"The maximum number of recipients to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many recipient records before beginning to return recipients in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset recipients are skipped before starting to count the recipients to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a recipient record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all recipients created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date. ","key":"startDate","value":""},{"description":"The end date to use for a search of when a recipient record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all recipients created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"Payer's unique reference value for the recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"Reference value for the recipient from the payout provider. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerRecipientRef","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"The recipient's email address. This value is used to perform a 'contains' search.","key":"email","value":""},{"description":"The recipient's first name. This value is used to perform a 'contains' search.","key":"firstName","value":""},{"description":"The recipient's last name. This value is used to perform a 'contains' search.","key":"lastName","value":""},{"description":"The recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumber","value":""},{"description":"The recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumber","value":""},{"description":"The recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine1","value":""},{"description":"Additional information about the recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine2","value":""},{"description":"The recipient's city. This value is used to perform a 'contains' search.","key":"city","value":""},{"description":"The recipient's state, province, or region. This value is used to perform a 'contains' search.","key":"region","value":""},{"description":"The recipient's postal code. This value is used to perform a 'contains' search.","key":"postalCode","value":""},{"description":"The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the recipient's address. This value is used to perform a 'contains' search.","key":"country","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the country where the recipient was born. This value is used to perform a 'contains' search.","key":"countryOfBirth","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the recipient's country of citizenship or nationality. This value is used to perform a 'contains' search.","key":"countryOfNationality","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"Send this as an empty query parameter in order to have all recipient ID number data for the recipient returned in the response. For example, `https://{api_url}/payout/v3/recipient?recipientIdNumbers.`, returns all recipients for the API user (as a paged list) and gives all information from the `recipientIdNumbers` object in the response. Alternatively, you can instead send a specific `recipientIdNumbers` parameter (such as `governmentId`) to match against and you will get the entire `recipientIdNumbers` object for each of the matching recipients.","key":"recipientIdNumbers.","value":""},{"description":"The recipient's government ID. The value corresponds to the selection for the `governmentIdType` parameter. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.governmentId","value":""},{"description":"The recipient's passport ID. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.passportId","value":""},{"description":"The recipient's employer ID. This is generally used for tax purposes. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.employerId","value":""},{"description":"The recipient's driver's license number. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.driversLicenseId","value":""},{"description":"The user type associated with the recipient. This value is used to perform an 'exact match' search.","key":"userType","value":"BUSINESS"},{"description":"The recipient's date of birth, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date. This value is used to perform a 'contains' search.","key":"birthDate","value":""},{"description":"The recipient's gender. This value is used to perform a 'contains' search.","key":"gender","value":"MALE"},{"description":"The type of address associated with this recipient for the specified address information. This value is used to perform a 'contains' search.","key":"addressType","value":"BUSINESS"},{"description":"The country associated with the recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumberCountry","value":""},{"description":"The country associated with the recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumberCountry","value":""},{"description":"Type of the government ID provided for the recipient. This value is used to perform a 'contains' search.

    The ID indicated by this value corresponds to the ID provided in the `recipientIdNumbers.governmentId` parameter.","key":"governmentIdType","value":""},{"description":"The date and time the recipient record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time the recipient record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": 0,\n \"limit\": 10,\n \"rows\": [\n {\n \"recipientRef\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 20,\n \"providerRecipientRef\": \"\",\n \"userType\": \"BUSINESS\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"gender\": \"MALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"governmentIdType\": \"\",\n \"recipientIdNumbers\": {\n \"driversLicenseId\": \"\",\n \"employerId\": \"\",\n \"governmentId\": \"\",\n \"passportId\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"recipientRef\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 30,\n \"providerRecipientRef\": \"\",\n \"userType\": \"BUSINESS\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"governmentIdType\": \"\",\n \"recipientIdNumbers\": {\n \"driversLicenseId\": \"\",\n \"employerId\": \"\",\n \"governmentId\": \"\",\n \"passportId\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"hasMore\": \"\"\n}"},{"id":"0b466a60-598d-4792-b307-df0d961021c9","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient?limit=10&offset=0&startDate=&endDate=&recipientId=&recipientRef=&providerRecipientRef=&providerType=10&email=&firstName=&lastName=&phoneNumber=&mobileNumber=&addressLine1=&addressLine2=&city=®ion=&postalCode=&country=&countryOfBirth=&countryOfNationality=&providerId=&payoutAccountId=&recipientIdNumbers.=&recipientIdNumbers.governmentId=&recipientIdNumbers.passportId=&recipientIdNumbers.employerId=&recipientIdNumbers.driversLicenseId=&userType=BUSINESS&birthDate=&gender=MALE&addressType=BUSINESS&phoneNumberCountry=&mobileNumberCountry=&governmentIdType=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3","recipient"],"query":[{"description":"The maximum number of recipients to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many recipient records before beginning to return recipients in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset recipients are skipped before starting to count the recipients to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a recipient record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all recipients created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date. ","key":"startDate","value":""},{"description":"The end date to use for a search of when a recipient record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all recipients created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"Payer's unique reference value for the recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"Reference value for the recipient from the payout provider. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerRecipientRef","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"The recipient's email address. This value is used to perform a 'contains' search.","key":"email","value":""},{"description":"The recipient's first name. This value is used to perform a 'contains' search.","key":"firstName","value":""},{"description":"The recipient's last name. This value is used to perform a 'contains' search.","key":"lastName","value":""},{"description":"The recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumber","value":""},{"description":"The recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumber","value":""},{"description":"The recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine1","value":""},{"description":"Additional information about the recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine2","value":""},{"description":"The recipient's city. This value is used to perform a 'contains' search.","key":"city","value":""},{"description":"The recipient's state, province, or region. This value is used to perform a 'contains' search.","key":"region","value":""},{"description":"The recipient's postal code. This value is used to perform a 'contains' search.","key":"postalCode","value":""},{"description":"The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the recipient's address. This value is used to perform a 'contains' search.","key":"country","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the country where the recipient was born. This value is used to perform a 'contains' search.","key":"countryOfBirth","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the recipient's country of citizenship or nationality. This value is used to perform a 'contains' search.","key":"countryOfNationality","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"Send this as an empty query parameter in order to have all recipient ID number data for the recipient returned in the response. For example, `https://{api_url}/payout/v3/recipient?recipientIdNumbers.`, returns all recipients for the API user (as a paged list) and gives all information from the `recipientIdNumbers` object in the response. Alternatively, you can instead send a specific `recipientIdNumbers` parameter (such as `governmentId`) to match against and you will get the entire `recipientIdNumbers` object for each of the matching recipients.","key":"recipientIdNumbers.","value":""},{"description":"The recipient's government ID. The value corresponds to the selection for the `governmentIdType` parameter. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.governmentId","value":""},{"description":"The recipient's passport ID. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.passportId","value":""},{"description":"The recipient's employer ID. This is generally used for tax purposes. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.employerId","value":""},{"description":"The recipient's driver's license number. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.driversLicenseId","value":""},{"description":"The user type associated with the recipient. This value is used to perform an 'exact match' search.","key":"userType","value":"BUSINESS"},{"description":"The recipient's date of birth, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date. This value is used to perform a 'contains' search.","key":"birthDate","value":""},{"description":"The recipient's gender. This value is used to perform a 'contains' search.","key":"gender","value":"MALE"},{"description":"The type of address associated with this recipient for the specified address information. This value is used to perform a 'contains' search.","key":"addressType","value":"BUSINESS"},{"description":"The country associated with the recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumberCountry","value":""},{"description":"The country associated with the recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumberCountry","value":""},{"description":"Type of the government ID provided for the recipient. This value is used to perform a 'contains' search.

    The ID indicated by this value corresponds to the ID provided in the `recipientIdNumbers.governmentId` parameter.","key":"governmentIdType","value":""},{"description":"The date and time the recipient record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time the recipient record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"aacf67de-269b-48ef-8f49-bf57b5f8fa06"},{"name":"Update recipient","id":"d786818d-f021-4e7c-8ce3-7f69c8c1d2f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"recipientId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"recipientIdNumbers\": {\n \"governmentId\": \"\",\n \"passportId\": \"\",\n \"driversLicenseId\": \"\",\n \"employerId\": \"\"\n },\n \"providerId\": \"\",\n \"recipientRef\": \"\",\n \"email\": \"\",\n \"userType\": \"BUSINESS\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"country\": \"\",\n \"currency\": \"\",\n \"addressType\": \"BUSINESS\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberCountry\": \"\",\n \"mobileNumber\": \"\",\n \"mobileNumberCountry\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/recipient","description":"This endpoint is used to update information for an existing payout recipient.\n\n\n> πŸ›‘ Important\n> \n> You can only update a recipient record if the request is accepted by the payout provider associated with the `recipientId`.\n\n\n> πŸ“˜ Note \n> \n> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with this endpoint.

    In the case that a value has been passed for the `recipientIdNumbers` and you are wanting to change information for an existing Interchecks recipient, contact Interchecks to update the recipient's information.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include at least a `recipienId` and recipient `firstName` and `lastName`.\n\n\n
    \n\n## Request parameters\n- recipientId\n- firstName\n- lastName\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- providerId\n- recipientRef\n- email\n- userType\n- gender\n- birthDate\n- countryOfBirth\n- countryOfNationality\n- country\n- currency\n- addressType\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- phoneNumber\n- phoneNumberCountry\n- mobileNumber\n- mobileNumberCountry\n\n## Response parameters\n- payoutAccountId\n- providerId\n- recipientId\n- recipientRef\n- email\n- firstName\n- lastName\n- providerType\n- providerRecipientRef\n- userType\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- country\n- phoneNumber\n- mobileNumber\n- countryOfBirth\n- countryOfNationality\n- gender\n- birthDate\n- recipientRulesMetadata\n- recipientRulesMetadata.id\n- recipientRulesMetadata.recipientId\n- recipientRulesMetadata.metadata\n- recipientRulesMetadata.createdAt\n- recipientRulesMetadata.updatedAt\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"90bb011d-86cd-49be-9196-a21f38e45aac","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"recipientId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"recipientIdNumbers\": {\n \"governmentId\": \"\",\n \"passportId\": \"\",\n \"driversLicenseId\": \"\",\n \"employerId\": \"\"\n },\n \"providerId\": \"\",\n \"recipientRef\": \"\",\n \"email\": \"\",\n \"userType\": \"BUSINESS\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"country\": \"\",\n \"currency\": \"\",\n \"addressType\": \"BUSINESS\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberCountry\": \"\",\n \"mobileNumber\": \"\",\n \"mobileNumberCountry\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/recipient"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"recipientId\": \"\",\n \"recipientRef\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"providerType\": 50,\n \"providerRecipientRef\": \"\",\n \"userType\": \"INDIVIDUAL\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"\",\n \"recipientRulesMetadata\": {\n \"id\": \"\",\n \"recipientId\": \"\",\n \"metadata\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n \"recipientIdNumbers\": {\n \"driversLicenseId\": \"\",\n \"employerId\": \"\",\n \"governmentId\": \"\",\n \"passportId\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"64372218-f0bf-4d64-a467-1811e141a808","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"recipientId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"recipientIdNumbers\": {\n \"governmentId\": \"\",\n \"passportId\": \"\",\n \"driversLicenseId\": \"\",\n \"employerId\": \"\"\n },\n \"providerId\": \"\",\n \"recipientRef\": \"\",\n \"email\": \"\",\n \"userType\": \"BUSINESS\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"country\": \"\",\n \"currency\": \"\",\n \"addressType\": \"BUSINESS\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberCountry\": \"\",\n \"mobileNumber\": \"\",\n \"mobileNumberCountry\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/recipient"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d786818d-f021-4e7c-8ce3-7f69c8c1d2f2"},{"name":"View a recipient by recipientId","id":"b1d80e21-7aab-464d-928a-ae91e66d71f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient/:recipientId","host":["{{baseUrl}}"],"path":["payout","v3","recipient",":recipientId"],"variable":[{"id":"dde68e88-63ec-4ca9-9f63-e5160bff79aa","key":"recipientId","value":"","description":"(Required) The Nexio ID for the recipient. This value is used to perform an 'exact match' search."}]},"description":"Searches for recipients with the specified `recipientId`.\n\n\n> πŸ“˜ Notes\n> \n> - You can only use `recipientId` as the path parameter for this endpoint. \n> - When searching for a recipient by `recipientRef` use the [View a recipient by recipientRef](ref:viewrecipientbyrecipientref) endpoint.\n> - To view a recipient using other IDs or parameters, use the [View recipients](ref:viewrecipients) endpoint.\n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the `recipientId` in the path parameter of the request.\n\n\n
    \n\n## Request parameters\n- recipientId\n\n## Response parameters\n- recipientRef\n- recipientId\n- payoutAccountId\n- providerId\n- providerType\n- providerRecipientRef\n- userType\n- firstName\n- lastName\n- gender\n- birthDate\n- countryOfBirth\n- countryOfNationality\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- country\n- email\n- phoneNumber\n- mobileNumber\n- governmentIdType\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"46ac3797-cc26-4759-bb67-16883100ec73","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient/:recipientId","host":["{{baseUrl}}"],"path":["payout","v3","recipient",":recipientId"],"variable":[{"key":"recipientId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"recipientRef\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 30,\n \"providerRecipientRef\": \"\",\n \"userType\": \"BUSINESS\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"governmentIdType\": \"\",\n \"recipientIdNumbers\": {\n \"driversLicenseId\": \"\",\n \"employerId\": \"\",\n \"governmentId\": \"\",\n \"passportId\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"46c68bdb-2c64-4351-84f5-dee9746eacd7","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient/:recipientId","host":["{{baseUrl}}"],"path":["payout","v3","recipient",":recipientId"],"variable":[{"key":"recipientId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"b1d80e21-7aab-464d-928a-ae91e66d71f4"},{"name":"View a recipient by recipientRef","id":"34d29a68-9768-4844-99dc-6943ab3eee54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient/recipientRef/:recipientRef","host":["{{baseUrl}}"],"path":["payout","v3","recipient","recipientRef",":recipientRef"],"variable":[{"id":"fa7587a6-4f25-4fa2-9d64-b99e74592609","key":"recipientRef","value":"","description":"(Required) Payer's unique reference value for the recipient."}]},"description":"Searches for recipients with the specified `recipientRef`.\n\n\n> πŸ“˜ Notes\n> \n> - You can only use `recipientRef` as the path parameter for this endpoint. \n> - When searching for a recipient by `recipientId` use the [View a recipient by recipientId](ref:viewrecipientbyrecipientid) endpoint.\n> - To view a recipient using other IDs or parameters, use the [View recipients](ref:viewrecipients) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the `recipientRef` in the path parameter of the request.\n\n
    \n\n## Request parameters\n- recipientRef\n\n## Response parameters\n- recipientRef\n- recipientId\n- payoutAccountId\n- providerId\n- providerType\n- providerRecipientRef\n- userType\n- firstName\n- lastName\n- gender\n- birthDate\n- countryOfBirth\n- countryOfNationality\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- country\n- email\n- phoneNumber\n- mobileNumber\n- governmentIdType\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"e5bc1dee-c812-4f95-8ddf-1bb726be44d6","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient/recipientRef/:recipientRef","host":["{{baseUrl}}"],"path":["payout","v3","recipient","recipientRef",":recipientRef"],"variable":[{"key":"recipientRef"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"recipientRef\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 30,\n \"providerRecipientRef\": \"\",\n \"userType\": \"BUSINESS\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"\",\n \"countryOfBirth\": \"\",\n \"countryOfNationality\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"governmentIdType\": \"\",\n \"recipientIdNumbers\": {\n \"driversLicenseId\": \"\",\n \"employerId\": \"\",\n \"governmentId\": \"\",\n \"passportId\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"3d86ae24-122c-440d-a8ab-8a6fec5e8168","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/recipient/recipientRef/:recipientRef","host":["{{baseUrl}}"],"path":["payout","v3","recipient","recipientRef",":recipientRef"],"variable":[{"key":"recipientRef"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"34d29a68-9768-4844-99dc-6943ab3eee54"}],"id":"f35d951c-70be-4bac-893e-92d2e45f15f2","description":"APIs for payout recipients","_postman_id":"f35d951c-70be-4bac-893e-92d2e45f15f2"},{"name":"Payouts","item":[{"name":"Submit payouts","id":"8d62648b-0986-4dc2-94f2-a53a3dc49347","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payouts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\",\n \"recipient\": {\n \"recipientRef\": \"\"\n },\n \"description\": \"\",\n \"payoutRef\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\",\n \"recipient\": {\n \"recipientRef\": \"\"\n },\n \"description\": \"\",\n \"payoutRef\": \"\"\n }\n ],\n \"batchRef\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/pay","description":"Allows you to submit one or more payouts in the body of an API request.\n\nPayouts can be made to existing recipients or you can create a recipient at the same time as submitting a payout by including the amount and currency for the payout as well as the required parameters for a recipient.\n\n### Required payout parameters\nThe required parameters for a payout are the following:
        - `amount`
        - `currency`
        - The **required recipient parameters**\n\n### Required recipient parameters\nFor sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
        - `recipientRef`
        - `recipientId`
        - `email`
    **Note:** The system ignores any other recipient parameters that you include.
    \n\nFor sending a payout to a **new recipient**, you must include at least the following recipient parameters:
        - `recipientRef`
        - `email`
        - `firstName`
        - `lastName`
        - `country`
    You may also optionally include any of the other parameters for [creating a recipient](ref:createrecipient).\n\n\n> πŸ“˜ Note \n> \n> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with [Update recipient](ref:updaterecipient) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include all the required parameters for a payout and a recipient, depending on whether this is for a new or existing recipient (see above).\n\n
    \n\n## Request parameters\n- payouts\n- payouts.amount\n- payouts.currency\n- payouts.recipient\n- payouts.recipient.recipientRef\n- payouts.recipient.recipientId\n- payouts.recipient.email\n- payouts.recipient.firstName\n- payouts.recipient.lastName\n- payouts.recipient.country\n- payouts.recipient.providerId\n- payouts.recipient.userType\n- payouts.recipient.gender\n- payouts.recipient.birthDate\n- payouts.recipient.countryOfBirth\n- payouts.recipient.countryOfNationality\n- payouts.recipient.currency\n- payouts.recipient.addressType\n- payouts.recipient.addressLine1\n- payouts.recipient.addressLine2\n- payouts.recipient.city\n- payouts.recipient.region\n- payouts.recipient.postalCode\n- payouts.recipient.phoneNumber\n- payouts.recipient.phoneNumberCountry\n- payouts.recipient.mobileNumber\n- payouts.recipient.mobileNumberCountry\n- payouts.recipient.governmentIdType\n- payouts.recipient.recipientIdNumbers\n- payouts.recipient.recipientIdNumbers.governmentId\n- payouts.recipient.recipientIdNumbers.passportId\n- payouts.recipient.recipientIdNumbers.employerId\n- payouts.recipient.recipientIdNumbers.driversLicenseId\n- payouts.description\n- payouts.payoutRef\n- batchRef\n\n## Response parameters\n- message\n\n
    "},"response":[{"id":"6bd5e905-ea5d-44ed-a0d8-aacf4cbaa9c8","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"payouts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\",\n \"recipient\": {\n \"recipientRef\": \"\"\n },\n \"description\": \"\",\n \"payoutRef\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\",\n \"recipient\": {\n \"recipientRef\": \"\"\n },\n \"description\": \"\",\n \"payoutRef\": \"\"\n }\n ],\n \"batchRef\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/pay"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"609f41cf-d4f6-41aa-9766-662dca0e1aad","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"payouts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\",\n \"recipient\": {\n \"recipientRef\": \"\"\n },\n \"description\": \"\",\n \"payoutRef\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\",\n \"recipient\": {\n \"recipientRef\": \"\"\n },\n \"description\": \"\",\n \"payoutRef\": \"\"\n }\n ],\n \"batchRef\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/pay"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"8d62648b-0986-4dc2-94f2-a53a3dc49347"},{"name":"Submit payouts using batch file","id":"6addcf57-dfc5-4586-8abc-14378908c106","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Directory location and name for the batch file. Must be accessible from the server that runs this API endpoint.","key":"file","type":"file","value":null}]},"url":"{{baseUrl}}/payout/v3/batch","description":"Allows you to submit one or more payouts using a batch file as input for the API request.\n\nUse this endpoint to make payouts to existing or new recipients.\n\n\n> πŸ›‘ Important\n>\n> Ensure the following for this endpoint:
    • The header content-type must be `multipart/form-data`.
    • The batch file must be in a location that is accessible by the server making this API request.
    \n\n\n> πŸ“˜ Note \n> \n> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with [Update recipient](ref:updaterecipient) endpoint.\n\n\n> ⚠️ Try It\n> \n> Due to technical limitations, it is not possible to use the Try It feature with this endpoint. Instead, use Postman or your own server (along with the credentials for your [Sandbox API user](doc:sandbox-environments)) to make the request.\n\n \n## Batch file parameters\nThe following table shows the required and optional parameters for making payouts using a batch file.\nFor more information about each parameter, see the [Submit payouts](ref:submitpayouts) endpoint.\n\nTo use your own field headers from your batch file, contact [Integrations Support](page:contact-us) for assistance.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterName in batch fileNotes
    batchRefbatchRefIf you include this parameter, the system only uses the first instance of it in the batch file. Other instances are ignored. If you want multiple batches to display as a single group in a report, specify the same value for each batch. Using this option allows you to easily view money sent to different payout providers so that you can properly fund those accounts.
    currencycurrencyRequired for each payout.
    amountamountRequired for each payout.
    descriptiondescriptionOptional.
    payoutRefpayoutRefOptional.
    recipient.recipientIdrecipientIdConditionally required for payout to an existing recipient when neither `recipientRef` nor `email` is included. This parameter is prioritized if more than one of those is included.

    Not allowed for payout to a new recipient.
    recipient.recipientRefrecipientRefConditionally required for payout to an existing recipient when neither `recipientId` nor `email` is included. This parameter is prioritized over email if that value is included. Otherwise, it is ignored if `recipientId` is included.

    Required for payout to a new recipient.

    Important: We strongly recommend that you include this value in your request instead of recipientId in order to facilitate payment reconciliation.
    recipient.emailemailConditionally required for payout to an existing recipient when neither `recipientId` nor `recipientRef` is included. This parameter is only prioritized if neither of the other two are included. Otherwise, it is ignored.

    Required for payout to a new recipient.
    recipient.firstNamefirstNameRequired for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.lastNamelastNameRequired for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.countrycountryRequired for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.providerIdproviderIdOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.userTypeuserTypeOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.gendergenderOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.birthDatebirthDateOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.countryOfBirthcountryOfBirthOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.countryOfNationalitycountryOfNationalityOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.addressTypeaddressTypeOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.addressLine1addressLine1Optional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.addressLine2addressLine2Optional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.citycityOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.regionregionOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.postalCodepostalCodeOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.phoneNumberphoneNumberOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.phoneNumberCountryphoneNumberCountryOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.mobileNumbermobileNumberOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.mobileNumberCountrymobileNumberCountryOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    recipient.governmentIdTypegovernmentIdTypeOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    governmentId
    (in recipient.recipientIdNumbers)    		governmentIdOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    passportId
    (in recipient.recipientIdNumbers)    		passportIdOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    driversLicenseId
    (in recipient.recipientIdNumbers)    		driversLicenseIdOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    employerId
    (in recipient.recipientIdNumbers)    		employerIdOptional for payout to a new recipient.

    Ignored for payout to an existing recipient.
    \n\n## Batch file format and examples\nThe batch file needs to be in CSV format. The first line contains a comma-separated list of the parameters to use. Each subsequent line must have the same number of commas as the first line but does not have to have content for each parameter (except where the parameter is required for the payout request). \nFor the possible required, conditionally required, and optional parameters to include, see the previous section.\n\nTo use your own field headers from your batch file, contact [Integrations Support](page:contact-us) for assistance.\n\n### Simple batch file example\n```\nfirstName,lastName,recipientRef,email,country,amount,currency\nYiseme,Gordman,9348rwf2,ygordman@testdata123.com,US,15,USD\nJohn,Johnson,123456r3,jj@123.com,CA,140,CAD\n,,,,,,\n```\n[Download sample file (in ZIP)](https://drive.google.com/file/d/1rR_knD7aBeCUnTvbHATOrPsW5lsuz-BI/view?usp=sharing)
    (To download, click the link and then select the option to \"download\".)\n### Batch file with all parameters example\n```\nbatchRef,currency,amount,description,payoutRef,recipientId,recipientRef,email,firstName,lastName,country,providerId,userType,gender,birthDate,countryOfBirth,countryOfNationality,addressType,addressLine1,addressLine2,city,region,postalCode,phoneNumber,phoneNumberCountry,mobileNumber,mobileNumberCountry,governmentIdType,governmentId,passportId,driversLicenseId,employerId\nbatch006,USD,1314.27,June commission payment,113e9ee19a-9c5f-49ca-9a92-3e39e64219c01,98198452,DS1125345,recipientemail112@payoutnow.com,Judith,Callie,US,12695,INDIVIDUAL,FEMALE,12/5/90,US,US,RESIDENTIAL,123 Somewhere St,,Somewhere,AK,99885,801111111,US,8012222222,US,NATIONALIDCARD,999999999,,DL12343234,\nbatch006,USD,125,June commission payment,Z12345 June 15th compensation pay1,98468985,Z11223456,recipientemai1l21@payoutnow.com,Merchnat,LLC,ES,12686,BUSINESS,MALE,11/19/91,ES,ES,BUSINESS,\"C. del Pozo, 8\",,Madrid,,28012,34915223894,ES,34915223895,ES,NATIONALIDCARD,,,,111111111\nbatch006,CAD,161.13,June commission payment,11a5ff4a13d4381,,RR12234346,recipientemail132@payoutnow.com,Wilimina,Manning,CA,12696,INDIVIDUAL,FEMALE,1/15/93,CA,CA,RESIDENTIAL,800 Benevenuto Ave,,Brentwood Bay,BC,V8M 1J8,2506524422,CA,2506524421,CA,PASSPORT,,789546512,,\n```\n[Download sample batch file (in ZIP)](https://drive.google.com/file/d/1JYmaQCyfQRy6ioMn5mZPVvFTGk2xgySC/view?usp=sharing)
    (To download, click the link and then select the option to \"download\".)"},"response":[{"id":"e71b321b-7637-45e8-9e47-69814d4f5031","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Directory location and name for the batch file. Must be accessible from the server that runs this API endpoint.","key":"file","type":"file"}]},"url":"{{baseUrl}}/payout/v3/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"5e593697-8062-4343-b4b5-d9309c8090e7","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Directory location and name for the batch file. Must be accessible from the server that runs this API endpoint.","key":"file","type":"file"}]},"url":"{{baseUrl}}/payout/v3/batch"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"6addcf57-dfc5-4586-8abc-14378908c106"},{"name":"View a payout","id":"b69718b4-73d4-4c3c-ba65-7d11831caf5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3/:payoutId","host":["{{baseUrl}}"],"path":["payout","v3",":payoutId"],"variable":[{"id":"73fb5c5a-64db-4495-8bb4-de90b4e74bed","key":"payoutId","value":"","description":"(Required) The `id` value auto-generated by Nexio when the payout request was submitted."}]},"description":"Searches for payouts with the given `payoutId`.\n\n\n> πŸ“˜ Note\n> \n> The `payoutId` parameter is not the same as the `payoutRef`, `payoutProviderRef`, or `payoutProviderAdditionalRef`. To view a payout using one of these other reference values, use the [View payouts](ref:viewpayouts) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the payout ID in the path parameter of the request.\n\n\n
    \n\n## Request parameters\n- payoutId\n\n## Response parameters\n- batchRef\n- id\n- recipientRef\n- recipientId\n- payoutAccountId\n- payoutRef\n- providerId\n- providerType\n- payoutProviderRef\n- payoutProviderAdditionalRef\n- providerRecipientRef\n- amount\n- currency\n- description\n- payoutDate\n- transferStatus\n- payoutStatus\n- providerResponse\n- firstName\n- lastName\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- country\n- email\n- phoneNumber\n- mobileNumber\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"0ea665a7-80a3-428b-b37d-ad46cc7e394e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/:payoutId","host":["{{baseUrl}}"],"path":["payout","v3",":payoutId"],"variable":[{"key":"payoutId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"batchRef\": \"\",\n \"id\": \"\",\n \"recipientRef\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"payoutRef\": \"\",\n \"providerId\": \"\",\n \"providerType\": 40,\n \"payoutProviderRef\": \"\",\n \"payoutProviderAdditionalRef\": \"\",\n \"providerRecipientRef\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"payoutDate\": \"\",\n \"transferStatus\": 90,\n \"payoutStatus\": 12,\n \"providerResponse\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"b52606c6-8347-4042-9548-ba304266d704","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/:payoutId","host":["{{baseUrl}}"],"path":["payout","v3",":payoutId"],"variable":[{"key":"payoutId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"b69718b4-73d4-4c3c-ba65-7d11831caf5e"},{"name":"View payouts","id":"ffb124b0-f657-4148-bcdb-fa59dc36a73c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3?limit=10&offset=0&startDate=&endDate=&id=&payoutStatus=10&transferStatus=20&recipientRef=&providerRecipientRef=&batchRef=&amount=¤cy=&description=&payoutDate=&payoutRef=&payoutProviderRef=&payoutProviderAdditionalRef=&email=&firstName=&lastName=&phoneNumber=&mobileNumber=&addressLine1=&addressLine2=&city=®ion=&postalCode=&country=&countryOfBirth=&countryOfNationality=&providerResponse=&recipientId=&providerId=&payoutAccountId=&providerType=10&userType=BUSINESS&birthDate=&gender=MALE&addressType=BUSINESS&phoneNumberCountry=&mobileNumberCountry=&governmentIdType=&recipientIdNumbers.=&recipientIdNumbers.governmentId=&recipientIdNumbers.passportId=&recipientIdNumbers.driversLicenseId=&recipientIdNumbers.employerId=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3"],"query":[{"description":"The maximum number of payout records to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many payout records before beginning to return payouts in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset payouts are skipped before starting to count the payouts to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a payout record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all payouts created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date to use for a search of when a payout record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all payouts created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The ID value auto-generated by Nexio when the payout request was submitted. This value is used to perform a 'contains' search.","key":"id","value":""},{"description":"The status of the payout. This value is used to perform an 'exact match' search. For more information about possible values, see the [payoutStatus](doc:constant-payouts-values#payout-status-payoutstatus) table.","key":"payoutStatus","value":"10"},{"description":"The status of the transfer. This value is used to perform an 'exact match' search. For information about possible values, see the [transferStatus](doc:constant-payouts-values#transfer-status-transferstatus) table.","key":"transferStatus","value":"20"},{"description":"Payer's unique reference value for the recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"Reference value for the recipient from the payout provider. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerRecipientRef","value":""},{"description":"Reference value for the payout batch. The value includes the date and time of when the payout was processed as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date, expressed in UTC. This value is used to perform a 'contains' search.","key":"batchRef","value":""},{"description":"The payout amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point. This value is used to perform an 'exact match' search.","key":"amount","value":""},{"description":"The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the payout to the specified recipient. This value is used to perform a 'contains' search. > #### Note> We pass this value through to the payout provider, but we do not save or return it in the response.","key":"currency","value":""},{"description":"Payer's description information for the payout to the specified recipient. This value is used to perform a 'contains' search.","key":"description","value":""},{"description":"The date of the payout, in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format and expressed in UTC.","key":"payoutDate","value":""},{"description":"Payer's unique reference value for a payout to the specified recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"payoutRef","value":""},{"description":"Reference value for the payout from the payout provider. This value is used to perform a 'contains' search.","key":"payoutProviderRef","value":""},{"description":"Additional reference value for the payout that may be provided by the payout provider. This value is used to perform a 'contains' search.","key":"payoutProviderAdditionalRef","value":""},{"description":"The recipient's email address. This value is used to perform a 'contains' search.","key":"email","value":""},{"description":"The recipient's first name. This value is used to perform a 'contains' search.","key":"firstName","value":""},{"description":"The recipient's last name. This value is used to perform a 'contains' search.","key":"lastName","value":""},{"description":"The recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumber","value":""},{"description":"The recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumber","value":""},{"description":"The recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine1","value":""},{"description":"Additional information about the recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine2","value":""},{"description":"The recipient's city. This value is used to perform a 'contains' search.","key":"city","value":""},{"description":"The recipient's state, province, or region. This value is used to perform a 'contains' search.","key":"region","value":""},{"description":"The recipient's postal code. This value is used to perform a 'contains' search.","key":"postalCode","value":""},{"description":"The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the recipient's address. This value is used to perform a 'contains' search.","key":"country","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the country where the recipient was born. This value is used to perform a 'contains' search.","key":"countryOfBirth","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the recipient's country of citizenship or nationality. This value is used to perform a 'contains' search.","key":"countryOfNationality","value":""},{"description":"Error message from the provider in case of a failed payout. This value is used to perform an 'exact match' search.","key":"providerResponse","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"The user type associated with the recipient. This value is used to perform an 'exact match' search.","key":"userType","value":"BUSINESS"},{"description":"The recipient's date of birth, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date. This value is used to perform a 'contains' search.","key":"birthDate","value":""},{"description":"The recipient's gender. This value is used to perform a 'contains' search.","key":"gender","value":"MALE"},{"description":"The type of address associated with this recipient for the specified address information. This value is used to perform a 'contains' search.","key":"addressType","value":"BUSINESS"},{"description":"The country associated with the recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumberCountry","value":""},{"description":"The country associated with the recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumberCountry","value":""},{"description":"Type of the government ID provided for the recipient. This value is used to perform a 'contains' search.

    The ID indicated by this value corresponds to the ID provided in the `recipientIdNumbers.governmentId` parameter.","key":"governmentIdType","value":""},{"description":"Send this as an empty query parameter in order to have all recipient ID number data for the recipient returned in the response. For example, `https://{api_url}/payout/v3/recipient?recipientIdNumbers.`, returns all recipients for the API user (as a paged list) and gives all information from the `recipientIdNumbers` object in the response. Alternatively, you can instead send a specific `recipientIdNumbers` parameter (such as `governmentId`) to match against and you will get the entire `recipientIdNumbers` object for each of the matching recipients.","key":"recipientIdNumbers.","value":""},{"description":"The recipient's government ID. The value corresponds to the selection for the `governmentIdType` parameter. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.governmentId","value":""},{"description":"The recipient's passport ID. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.passportId","value":""},{"description":"The recipient's driver's license number. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.driversLicenseId","value":""},{"description":"The recipient's employer ID. This is generally used for tax purposes. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.employerId","value":""},{"description":"The date and time the payout record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time at which the payout record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]},"description":"Returns all payouts that meet the specified parameters (if any) and that are associated with the Nexio account used to [authenticate](doc:authentication).\n\nThis is the only endpoint where you can use `payoutRef` in the request to view a specific payout based on that value.\n\nYou may also request to return additional parameters and/or filter results using one or more [query parameters](doc:filtering-using-query-parameters).\n\n\n> πŸ“˜ Notes\n> \n> By way of example, to return (filter) all payouts where the currency is EUR and also (request to include) the `recipientIdNumbers` object in the response, the request would look like this:\n> /payout/v3?recipientIdNumbers.¤cy=EUR

    To return (filter) only the payout with the specified `payoutRef` parameter, the request would look like this:\n> /payout/v3?payoutRef=dfbb8efc-6e85-4973-8f2e-69baf8624ae6

    For a more detailed tutorial, see the [query parameters](doc:filtering-using-query-parameters) section of Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- addressLine1\n- addressLine2\n- addressType\n- amount\n- batchRef\n- birthDate\n- city\n- country\n- countryOfBirth\n- countryOfNationality\n- currency\n- description\n- email\n- endDate\n- firstName\n- gender\n- governmentIdType\n- id\n- limit\n- mobileNumberCountry\n- offset\n- payoutAccountId\n- payoutProviderAdditionalRef\n- payoutProviderRef\n- payoutRef\n- payoutStatus\n- phoneNumber\n- phoneNumberCountry\n- postalCode\n- providerId\n- providerRecipientRef\n- providerResponse\n- providerType\n- recipientId\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- recipientRef\n- region\n- startDate\n- transferStatus\n- updatedAt\n- userType\n- createdAt\n- lastName\n- mobileNumber\n- payoutDate\n\n## Response parameters\n- offset\n- limit\n- rows\n- rows.batchRef\n- rows.id\n- rows.recipientRef\n- rows.recipientId\n- rows.payoutAccountId\n- rows.payoutRef\n- rows.providerId\n- rows.providerType\n- rows.payoutProviderRef\n- rows.payoutProviderAdditionalRef\n- rows.providerRecipientRef\n- rows.amount\n- rows.currency\n- rows.description\n- rows.payoutDate\n- rows.transferStatus\n- rows.payoutStatus\n- rows.providerResponse\n- rows.firstName\n- rows.lastName\n- rows.addressLine1\n- rows.addressLine2\n- rows.city\n- rows.region\n- rows.postalCode\n- rows.country\n- rows.email\n- rows.phoneNumber\n- rows.mobileNumber\n- rows.createdAt\n- rows.updatedAt\n- hasMore\n\n
    "},"response":[{"id":"7d5b6663-f641-4f07-9265-71eb6e6bebd5","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3?limit=10&offset=0&startDate=&endDate=&id=&payoutStatus=10&transferStatus=20&recipientRef=&providerRecipientRef=&batchRef=&amount=¤cy=&description=&payoutDate=&payoutRef=&payoutProviderRef=&payoutProviderAdditionalRef=&email=&firstName=&lastName=&phoneNumber=&mobileNumber=&addressLine1=&addressLine2=&city=®ion=&postalCode=&country=&countryOfBirth=&countryOfNationality=&providerResponse=&recipientId=&providerId=&payoutAccountId=&providerType=10&userType=BUSINESS&birthDate=&gender=MALE&addressType=BUSINESS&phoneNumberCountry=&mobileNumberCountry=&governmentIdType=&recipientIdNumbers.=&recipientIdNumbers.governmentId=&recipientIdNumbers.passportId=&recipientIdNumbers.driversLicenseId=&recipientIdNumbers.employerId=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3"],"query":[{"description":"The maximum number of payout records to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many payout records before beginning to return payouts in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset payouts are skipped before starting to count the payouts to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a payout record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all payouts created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date to use for a search of when a payout record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all payouts created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The ID value auto-generated by Nexio when the payout request was submitted. This value is used to perform a 'contains' search.","key":"id","value":""},{"description":"The status of the payout. This value is used to perform an 'exact match' search. For more information about possible values, see the [payoutStatus](doc:constant-payouts-values#payout-status-payoutstatus) table.","key":"payoutStatus","value":"10"},{"description":"The status of the transfer. This value is used to perform an 'exact match' search. For information about possible values, see the [transferStatus](doc:constant-payouts-values#transfer-status-transferstatus) table.","key":"transferStatus","value":"20"},{"description":"Payer's unique reference value for the recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"Reference value for the recipient from the payout provider. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerRecipientRef","value":""},{"description":"Reference value for the payout batch. The value includes the date and time of when the payout was processed as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date, expressed in UTC. This value is used to perform a 'contains' search.","key":"batchRef","value":""},{"description":"The payout amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point. This value is used to perform an 'exact match' search.","key":"amount","value":""},{"description":"The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the payout to the specified recipient. This value is used to perform a 'contains' search. > #### Note> We pass this value through to the payout provider, but we do not save or return it in the response.","key":"currency","value":""},{"description":"Payer's description information for the payout to the specified recipient. This value is used to perform a 'contains' search.","key":"description","value":""},{"description":"The date of the payout, in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format and expressed in UTC.","key":"payoutDate","value":""},{"description":"Payer's unique reference value for a payout to the specified recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"payoutRef","value":""},{"description":"Reference value for the payout from the payout provider. This value is used to perform a 'contains' search.","key":"payoutProviderRef","value":""},{"description":"Additional reference value for the payout that may be provided by the payout provider. This value is used to perform a 'contains' search.","key":"payoutProviderAdditionalRef","value":""},{"description":"The recipient's email address. This value is used to perform a 'contains' search.","key":"email","value":""},{"description":"The recipient's first name. This value is used to perform a 'contains' search.","key":"firstName","value":""},{"description":"The recipient's last name. This value is used to perform a 'contains' search.","key":"lastName","value":""},{"description":"The recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumber","value":""},{"description":"The recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumber","value":""},{"description":"The recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine1","value":""},{"description":"Additional information about the recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine2","value":""},{"description":"The recipient's city. This value is used to perform a 'contains' search.","key":"city","value":""},{"description":"The recipient's state, province, or region. This value is used to perform a 'contains' search.","key":"region","value":""},{"description":"The recipient's postal code. This value is used to perform a 'contains' search.","key":"postalCode","value":""},{"description":"The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the recipient's address. This value is used to perform a 'contains' search.","key":"country","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the country where the recipient was born. This value is used to perform a 'contains' search.","key":"countryOfBirth","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the recipient's country of citizenship or nationality. This value is used to perform a 'contains' search.","key":"countryOfNationality","value":""},{"description":"Error message from the provider in case of a failed payout. This value is used to perform an 'exact match' search.","key":"providerResponse","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"The user type associated with the recipient. This value is used to perform an 'exact match' search.","key":"userType","value":"BUSINESS"},{"description":"The recipient's date of birth, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date. This value is used to perform a 'contains' search.","key":"birthDate","value":""},{"description":"The recipient's gender. This value is used to perform a 'contains' search.","key":"gender","value":"MALE"},{"description":"The type of address associated with this recipient for the specified address information. This value is used to perform a 'contains' search.","key":"addressType","value":"BUSINESS"},{"description":"The country associated with the recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumberCountry","value":""},{"description":"The country associated with the recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumberCountry","value":""},{"description":"Type of the government ID provided for the recipient. This value is used to perform a 'contains' search.

    The ID indicated by this value corresponds to the ID provided in the `recipientIdNumbers.governmentId` parameter.","key":"governmentIdType","value":""},{"description":"Send this as an empty query parameter in order to have all recipient ID number data for the recipient returned in the response. For example, `https://{api_url}/payout/v3/recipient?recipientIdNumbers.`, returns all recipients for the API user (as a paged list) and gives all information from the `recipientIdNumbers` object in the response. Alternatively, you can instead send a specific `recipientIdNumbers` parameter (such as `governmentId`) to match against and you will get the entire `recipientIdNumbers` object for each of the matching recipients.","key":"recipientIdNumbers.","value":""},{"description":"The recipient's government ID. The value corresponds to the selection for the `governmentIdType` parameter. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.governmentId","value":""},{"description":"The recipient's passport ID. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.passportId","value":""},{"description":"The recipient's driver's license number. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.driversLicenseId","value":""},{"description":"The recipient's employer ID. This is generally used for tax purposes. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.employerId","value":""},{"description":"The date and time the payout record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time at which the payout record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": 0,\n \"limit\": 10,\n \"rows\": [\n {\n \"batchRef\": \"\",\n \"id\": \"\",\n \"recipientRef\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"payoutRef\": \"\",\n \"providerId\": \"\",\n \"providerType\": 10,\n \"payoutProviderRef\": \"\",\n \"payoutProviderAdditionalRef\": \"\",\n \"providerRecipientRef\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"payoutDate\": \"\",\n \"transferStatus\": 90,\n \"payoutStatus\": 20,\n \"providerResponse\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"batchRef\": \"\",\n \"id\": \"\",\n \"recipientRef\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"payoutRef\": \"\",\n \"providerId\": \"\",\n \"providerType\": 10,\n \"payoutProviderRef\": \"\",\n \"payoutProviderAdditionalRef\": \"\",\n \"providerRecipientRef\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"payoutDate\": \"\",\n \"transferStatus\": 20,\n \"payoutStatus\": 12,\n \"providerResponse\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"mobileNumber\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"hasMore\": \"\"\n}"},{"id":"d75b69cc-2832-44a9-9172-39dd2ecde55d","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3?limit=10&offset=0&startDate=&endDate=&id=&payoutStatus=10&transferStatus=20&recipientRef=&providerRecipientRef=&batchRef=&amount=¤cy=&description=&payoutDate=&payoutRef=&payoutProviderRef=&payoutProviderAdditionalRef=&email=&firstName=&lastName=&phoneNumber=&mobileNumber=&addressLine1=&addressLine2=&city=®ion=&postalCode=&country=&countryOfBirth=&countryOfNationality=&providerResponse=&recipientId=&providerId=&payoutAccountId=&providerType=10&userType=BUSINESS&birthDate=&gender=MALE&addressType=BUSINESS&phoneNumberCountry=&mobileNumberCountry=&governmentIdType=&recipientIdNumbers.=&recipientIdNumbers.governmentId=&recipientIdNumbers.passportId=&recipientIdNumbers.driversLicenseId=&recipientIdNumbers.employerId=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3"],"query":[{"description":"The maximum number of payout records to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many payout records before beginning to return payouts in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset payouts are skipped before starting to count the payouts to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a payout record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all payouts created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date to use for a search of when a payout record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all payouts created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The ID value auto-generated by Nexio when the payout request was submitted. This value is used to perform a 'contains' search.","key":"id","value":""},{"description":"The status of the payout. This value is used to perform an 'exact match' search. For more information about possible values, see the [payoutStatus](doc:constant-payouts-values#payout-status-payoutstatus) table.","key":"payoutStatus","value":"10"},{"description":"The status of the transfer. This value is used to perform an 'exact match' search. For information about possible values, see the [transferStatus](doc:constant-payouts-values#transfer-status-transferstatus) table.","key":"transferStatus","value":"20"},{"description":"Payer's unique reference value for the recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"Reference value for the recipient from the payout provider. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerRecipientRef","value":""},{"description":"Reference value for the payout batch. The value includes the date and time of when the payout was processed as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date, expressed in UTC. This value is used to perform a 'contains' search.","key":"batchRef","value":""},{"description":"The payout amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point. This value is used to perform an 'exact match' search.","key":"amount","value":""},{"description":"The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the payout to the specified recipient. This value is used to perform a 'contains' search. > #### Note> We pass this value through to the payout provider, but we do not save or return it in the response.","key":"currency","value":""},{"description":"Payer's description information for the payout to the specified recipient. This value is used to perform a 'contains' search.","key":"description","value":""},{"description":"The date of the payout, in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format and expressed in UTC.","key":"payoutDate","value":""},{"description":"Payer's unique reference value for a payout to the specified recipient. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"payoutRef","value":""},{"description":"Reference value for the payout from the payout provider. This value is used to perform a 'contains' search.","key":"payoutProviderRef","value":""},{"description":"Additional reference value for the payout that may be provided by the payout provider. This value is used to perform a 'contains' search.","key":"payoutProviderAdditionalRef","value":""},{"description":"The recipient's email address. This value is used to perform a 'contains' search.","key":"email","value":""},{"description":"The recipient's first name. This value is used to perform a 'contains' search.","key":"firstName","value":""},{"description":"The recipient's last name. This value is used to perform a 'contains' search.","key":"lastName","value":""},{"description":"The recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumber","value":""},{"description":"The recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumber","value":""},{"description":"The recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine1","value":""},{"description":"Additional information about the recipient's street address. This value is used to perform a 'contains' search.","key":"addressLine2","value":""},{"description":"The recipient's city. This value is used to perform a 'contains' search.","key":"city","value":""},{"description":"The recipient's state, province, or region. This value is used to perform a 'contains' search.","key":"region","value":""},{"description":"The recipient's postal code. This value is used to perform a 'contains' search.","key":"postalCode","value":""},{"description":"The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the recipient's address. This value is used to perform a 'contains' search.","key":"country","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the country where the recipient was born. This value is used to perform a 'contains' search.","key":"countryOfBirth","value":""},{"description":"The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the recipient's country of citizenship or nationality. This value is used to perform a 'contains' search.","key":"countryOfNationality","value":""},{"description":"Error message from the provider in case of a failed payout. This value is used to perform an 'exact match' search.","key":"providerResponse","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"The user type associated with the recipient. This value is used to perform an 'exact match' search.","key":"userType","value":"BUSINESS"},{"description":"The recipient's date of birth, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date. This value is used to perform a 'contains' search.","key":"birthDate","value":""},{"description":"The recipient's gender. This value is used to perform a 'contains' search.","key":"gender","value":"MALE"},{"description":"The type of address associated with this recipient for the specified address information. This value is used to perform a 'contains' search.","key":"addressType","value":"BUSINESS"},{"description":"The country associated with the recipient's phone number. This value is used to perform a 'contains' search.","key":"phoneNumberCountry","value":""},{"description":"The country associated with the recipient's mobile phone number. This value is used to perform a 'contains' search.","key":"mobileNumberCountry","value":""},{"description":"Type of the government ID provided for the recipient. This value is used to perform a 'contains' search.

    The ID indicated by this value corresponds to the ID provided in the `recipientIdNumbers.governmentId` parameter.","key":"governmentIdType","value":""},{"description":"Send this as an empty query parameter in order to have all recipient ID number data for the recipient returned in the response. For example, `https://{api_url}/payout/v3/recipient?recipientIdNumbers.`, returns all recipients for the API user (as a paged list) and gives all information from the `recipientIdNumbers` object in the response. Alternatively, you can instead send a specific `recipientIdNumbers` parameter (such as `governmentId`) to match against and you will get the entire `recipientIdNumbers` object for each of the matching recipients.","key":"recipientIdNumbers.","value":""},{"description":"The recipient's government ID. The value corresponds to the selection for the `governmentIdType` parameter. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.governmentId","value":""},{"description":"The recipient's passport ID. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.passportId","value":""},{"description":"The recipient's driver's license number. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.driversLicenseId","value":""},{"description":"The recipient's employer ID. This is generally used for tax purposes. This value is used to perform a 'contains' search.","key":"recipientIdNumbers.employerId","value":""},{"description":"The date and time the payout record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time at which the payout record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"ffb124b0-f657-4148-bcdb-fa59dc36a73c"},{"name":"View payouts pending","id":"f9cb1bd9-04f9-40c8-ae07-e18fbb57dc55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/payout/v3/pending","description":"Allows merchants to view all payouts to recipients that are in a pending status.\n\nReturns all payouts that meet the specified parameters (if any) and that are associated with the Nexio account used to [authenticate](doc:authentication).\n\nThis is the only endpoint where you can use `payoutRef` in the request to view a specific payout based on that value.\n\nYou may also request to return additional parameters and/or filter results using one or more [query parameters](doc:filtering-using-query-parameters).\n\n\n> πŸ“˜ Notes\n> \n> For example, to return (filter) all payouts where the currency is EUR and also (request to include) the `recipientIdNumbers` object in the response, the request would look like this:\n> /payout/v3?recipientIdNumbers.¤cy=EUR

    To return (filter) only the payout with the specified `payoutRef` parameter, the request would look like this:\n> /payout/v3?payoutRef=dfbb8efc-6e85-4973-8f2e-69baf8624ae6

    For a more detailed tutorial, see the [query parameters](doc:filtering-using-query-parameters) section of Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Response parameters\n- offset\n- limit\n- rows\n- rows.id\n- rows.providerId\n- rows.batchRef\n- rows.recipientRef\n- rows.firstName\n- rows.lastName\n- rows.email\n- rows.currency\n- rows.amount\n- rows.country\n\n
    \n"},"response":[{"id":"15ed4267-c686-42e3-a8ad-2bba4d2c1a08","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/payout/v3/pending"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": 0,\n \"limit\": 10,\n \"rows\": {\n \"id\": \"\",\n \"providerId\": \"\",\n \"batchRef\": \"\",\n \"recipientRef\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"currency\": \"\",\n \"amount\": \"\",\n \"country\": \"\"\n }\n}"},{"id":"146daf0a-c688-463c-b1f8-919229bc924d","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/payout/v3/pending"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"f9cb1bd9-04f9-40c8-ae07-e18fbb57dc55"},{"name":"Cancel pending payouts","id":"759666f0-2159-4b4d-be62-dfe70c1af9c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/pending","description":"Allows merchants to cancel pending payout transactions. \n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- ids\n\n## Response parameters\n- message\n\n
    "},"response":[{"id":"3bbcf539-0827-465d-add8-d0445d78ed43","name":"Pending payouts with ids nnnn do not exist","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/pending"},"status":"Switching Protocols","code":101,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ae8b56b9-22e4-4627-ba6e-a51dc2e63183","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/pending"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2488c51a-8b20-480d-9088-ed59f278b7f2","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/pending"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"759666f0-2159-4b4d-be62-dfe70c1af9c1"},{"name":"View payouts pending by ID","id":"4c252c45-041f-4fee-8cb6-0360d5519d6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3/pending/:payoutId","host":["{{baseUrl}}"],"path":["payout","v3","pending",":payoutId"],"variable":[{"id":"c9b90abe-15ac-416f-a1e2-3174c80a7953","key":"payoutId","value":"","description":"(Required) The `id` value auto-generated by Nexio when the payout request was submitted."}]},"description":"Allows the merchant to view specific payout transactions that have a pending status by using the `payoutId` to filter results.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the payout ID in the path parameter of the request.\n\n
    \n\n## Request parameters\n- payoutId\n\n## Response parameters\n- id\n- recipientId\n- payoutAccountId\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- providerId\n- batchRef\n- payoutRef\n- recipientRef\n- firstName\n- lastName\n- email\n- amount\n- currency\n- country\n- providerType\n- createdAt\n- updatedAt\n- events\n- events.type\n- events.params\n- events.params.providerId\n\n
    "},"response":[{"id":"c31b5e1e-31f1-4fd5-8df2-ece9760e08f8","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/pending/:payoutId","host":["{{baseUrl}}"],"path":["payout","v3","pending",":payoutId"],"variable":[{"key":"payoutId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"recipientId\": \"\",\n \"payoutAccountId\": \"\",\n \"recipientIdNumbers\": {\n \"driversLicenseId\": \"\",\n \"employerId\": \"\",\n \"governmentId\": \"\",\n \"passportId\": \"\"\n },\n \"providerId\": \"\",\n \"batchRef\": \"\",\n \"payoutRef\": \"\",\n \"recipientRef\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"providerType\": 10,\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"events\": {\n \"type\": \"\",\n \"params\": {\n \"providerId\": \"\"\n }\n }\n}"},{"id":"b7776ab4-a14d-4618-943e-cb9d288f6425","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/pending/:payoutId","host":["{{baseUrl}}"],"path":["payout","v3","pending",":payoutId"],"variable":[{"key":"payoutId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"4c252c45-041f-4fee-8cb6-0360d5519d6c"}],"id":"91b16a72-f9bb-419b-99d4-ea529bb4d2f7","description":"APIs for payouts","_postman_id":"91b16a72-f9bb-419b-99d4-ea529bb4d2f7"},{"name":"Spendbacks","item":[{"name":"Submit spendback","id":"9d42ea96-4d7a-4cbd-b332-7b81aaed1ae9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"recipientId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"spendbackRef\": \"\",\n \"providerId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/spendback","description":"Allows you to submit a spendback in the body of an API request.\n\nA spendback request can only be made for an existing recipient and you can only process one spendback at a time.\n\n\n### Required parameters\nEach spendback request must include the `amount` and `currency` parameters as well as one of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
        - `recipientId`
        - `recipientRef`
        - `email`\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include at least the `amount` and `currency` parameters, along with one of the recipient parameters (see above).\n\n
    \n\n## Request parameters\n- recipientId\n- recipientRef\n- email\n- amount\n- currency\n- description\n- spendbackRef\n- providerId\n\n## Response parameters\n- id\n- spendbackRef\n- recipientId\n- recipientRef\n- payoutAccountId\n- providerId\n- providerType\n- providerSpendbackRef\n- amount\n- currency\n- description\n- spendbackDate\n- spendbackStatus\n- providerResponse\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"089f866b-99ec-44de-b516-8863eb1252b6","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"recipientId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"spendbackRef\": \"\",\n \"providerId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/spendback"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"spendbackRef\": \"\",\n \"recipientId\": \"\",\n \"recipientRef\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 10,\n \"providerSpendbackRef\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"spendbackDate\": \"\",\n \"spendbackStatus\": 40,\n \"providerResponse\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"5a1cba68-c0e7-4f2d-b013-3d89f070e9cd","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"recipientId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"spendbackRef\": \"\",\n \"providerId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/spendback"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"9d42ea96-4d7a-4cbd-b332-7b81aaed1ae9"},{"name":"View spendbacks","id":"b7e96b66-6c5a-4949-9120-830a19618253","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3/spendback?limit=10&offset=0&startDate=&endDate=&id=&spendbackRef=&recipientId=&recipientRef=&payoutAccountId=&providerId=&providerType=10&providerSpendbackRef=&amount=¤cy=&description=&spendbackDate=&spendbackStatus=10&providerResponse=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3","spendback"],"query":[{"description":"The maximum number of spendback records to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many spendback records before beginning to return spendbacks in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset spendbacks are skipped before starting to count the spendbacks to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a spendback record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all spendbacks created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date to use for a search of when a spendback record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all spendbacks created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The ID value auto-generated by Nexio when the spendback request was submitted. This value is used to perform a 'contains' search.","key":"id","value":""},{"description":"Reference value for the spendback request. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"spendbackRef","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"Your unique identifier for a recipient. This is the payer account used for the spendback. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"Reference value for the spendback from the payout provider. This allows for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerSpendbackRef","value":""},{"description":"The spendback amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point. This value is used to perform an 'exact match' search.","key":"amount","value":""},{"description":"The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the spendback. This value is used to perform a 'contains' search.","key":"currency","value":""},{"description":"Description information for the spendback. This value is used to perform a 'contains' search.","key":"description","value":""},{"description":"The date of the spendback, in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format and expressed in UTC.","key":"spendbackDate","value":""},{"description":"The status of the spendback. This value is used to perform an 'exact match' search. For more information about possible values, see the [spendbackStatus](doc:constant-payouts-values#spendback-status-spendbackstatus) table.","key":"spendbackStatus","value":"10"},{"description":"Error message from the provider in case of a failed spendback. This value is used to perform an 'exact match' search.","key":"providerResponse","value":""},{"description":"The date and time the spendback record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time at which the spendback record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]},"description":"Returns all spendbacks that meet the specified parameters (if any) and that are associated with the Nexio account used to [authenticate](doc:authentication).\n\nThis is the only endpoint where you can use `spendbackRef` in the request to view a specific spendback based on that value.\n\nYou may also request to filter results using one or more [query parameters](doc:filtering-using-query-parameters).\n\n\n> πŸ“˜ Notes\n> \n> For example, to return (filter) only the spendback with the specified `spendbackRef` parameter, the request would look like this:\n> /payout/v3/spendback?spendbackRef=43b57dce-4dca-474a-84f4-4684f3a8aa52

    To return (filter) all spendbacks where the currency is EUR and there was an error response from the provider, the request would look like this:\n> /payout/v3/spendback?currency=EUR&spendbackStatus=90

    For a more detailed tutorial, see the [query parameters](doc:filtering-using-query-parameters) section of Guides.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- amount\n- currency\n- description\n- endDate\n- id\n- limit\n- offset\n- payoutAccountId\n- providerId\n- providerResponse\n- providerSpendbackRef\n- providerType\n- recipientId\n- recipientRef\n- spendbackRef\n- spendbackStatus\n- startDate\n- updatedAt\n- createdAt\n- spendbackDate\n\n## Response parameters\n- offset\n- limit\n- rows\n- rows.id\n- rows.spendbackRef\n- rows.recipientId\n- rows.recipientRef\n- rows.payoutAccountId\n- rows.providerId\n- rows.providerType\n- rows.providerSpendbackRef\n- rows.amount\n- rows.currency\n- rows.description\n- rows.spendbackDate\n- rows.spendbackStatus\n- rows.providerResponse\n- rows.createdAt\n- rows.updatedAt\n- hasMore\n\n
    "},"response":[{"id":"07c3d477-ffd6-49d5-91b6-6f286d1a256d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/spendback?limit=10&offset=0&startDate=&endDate=&id=&spendbackRef=&recipientId=&recipientRef=&payoutAccountId=&providerId=&providerType=10&providerSpendbackRef=&amount=¤cy=&description=&spendbackDate=&spendbackStatus=10&providerResponse=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3","spendback"],"query":[{"description":"The maximum number of spendback records to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many spendback records before beginning to return spendbacks in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset spendbacks are skipped before starting to count the spendbacks to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a spendback record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all spendbacks created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date to use for a search of when a spendback record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all spendbacks created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The ID value auto-generated by Nexio when the spendback request was submitted. This value is used to perform a 'contains' search.","key":"id","value":""},{"description":"Reference value for the spendback request. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"spendbackRef","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"Your unique identifier for a recipient. This is the payer account used for the spendback. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"Reference value for the spendback from the payout provider. This allows for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerSpendbackRef","value":""},{"description":"The spendback amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point. This value is used to perform an 'exact match' search.","key":"amount","value":""},{"description":"The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the spendback. This value is used to perform a 'contains' search.","key":"currency","value":""},{"description":"Description information for the spendback. This value is used to perform a 'contains' search.","key":"description","value":""},{"description":"The date of the spendback, in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format and expressed in UTC.","key":"spendbackDate","value":""},{"description":"The status of the spendback. This value is used to perform an 'exact match' search. For more information about possible values, see the [spendbackStatus](doc:constant-payouts-values#spendback-status-spendbackstatus) table.","key":"spendbackStatus","value":"10"},{"description":"Error message from the provider in case of a failed spendback. This value is used to perform an 'exact match' search.","key":"providerResponse","value":""},{"description":"The date and time the spendback record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time at which the spendback record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": 0,\n \"limit\": 10,\n \"rows\": [\n {\n \"id\": \"\",\n \"spendbackRef\": \"\",\n \"recipientId\": \"\",\n \"recipientRef\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 50,\n \"providerSpendbackRef\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"spendbackDate\": \"\",\n \"spendbackStatus\": 20,\n \"providerResponse\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"spendbackRef\": \"\",\n \"recipientId\": \"\",\n \"recipientRef\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 30,\n \"providerSpendbackRef\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"spendbackDate\": \"\",\n \"spendbackStatus\": 30,\n \"providerResponse\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"hasMore\": \"\"\n}"},{"id":"1c767879-c379-44d5-bdcc-85bb1eee6551","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/spendback?limit=10&offset=0&startDate=&endDate=&id=&spendbackRef=&recipientId=&recipientRef=&payoutAccountId=&providerId=&providerType=10&providerSpendbackRef=&amount=¤cy=&description=&spendbackDate=&spendbackStatus=10&providerResponse=&createdAt=&updatedAt=","host":["{{baseUrl}}"],"path":["payout","v3","spendback"],"query":[{"description":"The maximum number of spendback records to return in a response (starting from the default or specified `offset` query parameter).","key":"limit","value":"10"},{"description":"The offset indicates to the system to skip that many spendback records before beginning to return spendbacks in a response. Setting `offset=0` is the same as omitting the offset parameter. If you use both `offset` and `limit`, the offset spendbacks are skipped before starting to count the spendbacks to limit.","key":"offset","value":"0"},{"description":"The start date to use for a search of when a spendback record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all spendbacks created starting in the fourth quarter of 2021. Can be used with `endDate` to specify a range. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date to use for a search of when a spendback record was created. Format: YYYY-MM-DD. However, you can specify parts of the date as well, such as 2021-10 to get all spendbacks created in the month of October of 2021. Can be used with `startDate` to specify a range. The default is the current date.","key":"endDate","value":""},{"description":"The ID value auto-generated by Nexio when the spendback request was submitted. This value is used to perform a 'contains' search.","key":"id","value":""},{"description":"Reference value for the spendback request. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"spendbackRef","value":""},{"description":"The Nexio ID for the recipient. This value is used to perform an 'exact match' search.","key":"recipientId","value":""},{"description":"Your unique identifier for a recipient. This is the payer account used for the spendback. Use this to allow for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"recipientRef","value":""},{"description":"The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient. This value is used to perform a 'contains' search.","key":"payoutAccountId","value":""},{"description":"The Nexio ID for the provider. Indicates which payout provider was associated with this recipient profile. This value is used to perform an 'exact match' search.","key":"providerId","value":""},{"description":"The Nexio ID for the provider configuration used to create the recipient. This value is used to perform an 'exact match' search.

    Possible values include the following:
    10 - Interchecks
    20 - Hyperwallet
    30 - Payquicker
    40 - Nexio's mock payout provider for quicker sandbox integration.","key":"providerType","value":"10"},{"description":"Reference value for the spendback from the payout provider. This allows for easier synchronization and searching across different systems. This value is used to perform a 'contains' search.","key":"providerSpendbackRef","value":""},{"description":"The spendback amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point. This value is used to perform an 'exact match' search.","key":"amount","value":""},{"description":"The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the spendback. This value is used to perform a 'contains' search.","key":"currency","value":""},{"description":"Description information for the spendback. This value is used to perform a 'contains' search.","key":"description","value":""},{"description":"The date of the spendback, in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format and expressed in UTC.","key":"spendbackDate","value":""},{"description":"The status of the spendback. This value is used to perform an 'exact match' search. For more information about possible values, see the [spendbackStatus](doc:constant-payouts-values#spendback-status-spendbackstatus) table.","key":"spendbackStatus","value":"10"},{"description":"Error message from the provider in case of a failed spendback. This value is used to perform an 'exact match' search.","key":"providerResponse","value":""},{"description":"The date and time the spendback record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"createdAt","value":""},{"description":"The date and time at which the spendback record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC. This value is used to perform a 'contains' search.","key":"updatedAt","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"b7e96b66-6c5a-4949-9120-830a19618253"},{"name":"View a spendback","id":"9d7d1935-1598-48be-b803-597b73b6ba8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3/spendback/:spendbackId","host":["{{baseUrl}}"],"path":["payout","v3","spendback",":spendbackId"],"variable":[{"id":"447b6aa6-fbc3-47e4-8b29-2ccbbc8e15a3","key":"spendbackId","value":"","description":"(Required) The ID value auto-generated by Nexio when the spendback request was submitted."}]},"description":"Searches for a spendback with the specified `spendbackId`.\n\n\n> πŸ“˜ Notes\n> \n> - The `spendbackId` parameter is not the same as the `spendbackRef` or `providerSpendbackRef`.\n> - To view a spendback using one of these other IDs, use the [View spendbacks](ref:viewspendbacks) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the spendback ID in the path parameter of the request.\n\n
    \n\n## Request parameters\n- spendbackId\n\n## Response parameters\n- id\n- spendbackRef\n- recipientId\n- recipientRef\n- payoutAccountId\n- providerId\n- providerType\n- providerSpendbackRef\n- amount\n- currency\n- description\n- spendbackDate\n- spendbackStatus\n- providerResponse\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"028ae7ac-9482-4028-ae59-30c1b44d267b","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/spendback/:spendbackId","host":["{{baseUrl}}"],"path":["payout","v3","spendback",":spendbackId"],"variable":[{"key":"spendbackId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"spendbackRef\": \"\",\n \"recipientId\": \"\",\n \"recipientRef\": \"\",\n \"payoutAccountId\": \"\",\n \"providerId\": \"\",\n \"providerType\": 10,\n \"providerSpendbackRef\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"spendbackDate\": \"\",\n \"spendbackStatus\": 40,\n \"providerResponse\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"598f709d-9788-4425-af19-bb36be696751","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/spendback/:spendbackId","host":["{{baseUrl}}"],"path":["payout","v3","spendback",":spendbackId"],"variable":[{"key":"spendbackId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"9d7d1935-1598-48be-b803-597b73b6ba8b"},{"name":"Spendback refund","id":"d237ae80-2709-46bd-a1d4-56060988fc7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"spendbackId\": \"\",\n \"amount\": \"\",\n \"payoutAccountId\": \"\",\n \"recipientId\": \"\",\n \"providerId\": \"\",\n \"spendbackRef\": \"\",\n \"recipientRef\": \"\",\n \"providerSpendbackRef\": \"\",\n \"currency\": \"\",\n \"providerType\": 40,\n \"spendbackType\": 20,\n \"spendbackStatus\": 10,\n \"spendbackDate\": \"\",\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/spendbackRefund","description":"Allows the merchant to refund recipients who have previously made a spendback transaction.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include at least the spendback ID and amount to refund in the request.\n\n
    \n\n## Request parameters\n- spendbackId\n- amount\n- payoutAccountId\n- recipientId\n- providerId\n- spendbackRef\n- recipientRef\n- providerSpendbackRef\n- currency\n- providerType\n- spendbackType\n- spendbackStatus\n- spendbackDate\n- createdAt\n- updatedAt\n\n## Response parameters\n- spendbackId\n- payoutAccountId\n- recipientId\n- providerId\n- spendbackRef\n- recipientRef\n- providerSpendbackRef\n- amount\n- currency\n- providerType\n- spendbackType\n- spendbackStatus\n- spendbackDate\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"4fe78afd-ba3e-4518-8e04-fb9f3873f84c","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"spendbackId\": \"\",\n \"amount\": \"\",\n \"payoutAccountId\": \"\",\n \"recipientId\": \"\",\n \"providerId\": \"\",\n \"spendbackRef\": \"\",\n \"recipientRef\": \"\",\n \"providerSpendbackRef\": \"\",\n \"currency\": \"\",\n \"providerType\": 40,\n \"spendbackType\": 20,\n \"spendbackStatus\": 10,\n \"spendbackDate\": \"\",\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/spendbackRefund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"spendbackId\": \"\",\n \"payoutAccountId\": \"\",\n \"recipientId\": \"\",\n \"providerId\": \"\",\n \"spendbackRef\": \"\",\n \"recipientRef\": \"\",\n \"providerSpendbackRef\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"providerType\": 60,\n \"spendbackType\": 10,\n \"spendbackStatus\": 50,\n \"spendbackDate\": \"\",\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n}"},{"id":"71bc4666-20b3-40fd-bb39-48ab951d31dd","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"spendbackId\": \"\",\n \"amount\": \"\",\n \"payoutAccountId\": \"\",\n \"recipientId\": \"\",\n \"providerId\": \"\",\n \"spendbackRef\": \"\",\n \"recipientRef\": \"\",\n \"providerSpendbackRef\": \"\",\n \"currency\": \"\",\n \"providerType\": 40,\n \"spendbackType\": 20,\n \"spendbackStatus\": 10,\n \"spendbackDate\": \"\",\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/spendbackRefund"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b8125197-2b61-4190-a7cc-4d6a47caa136","name":"Spendback to refund not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"spendbackId\": \"\",\n \"amount\": \"\",\n \"payoutAccountId\": \"\",\n \"recipientId\": \"\",\n \"providerId\": \"\",\n \"spendbackRef\": \"\",\n \"recipientRef\": \"\",\n \"providerSpendbackRef\": \"\",\n \"currency\": \"\",\n \"providerType\": 40,\n \"spendbackType\": 20,\n \"spendbackStatus\": 10,\n \"spendbackDate\": \"\",\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/payout/v3/spendbackRefund"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d237ae80-2709-46bd-a1d4-56060988fc7d"},{"name":"View recipient balance","id":"15f858ae-a858-46f3-b665-231fd3dc1805","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/payout/v3/recipientBalance?recipientRef=","host":["{{baseUrl}}"],"path":["payout","v3","recipientBalance"],"query":[{"description":"(Required) Payer's unique reference value for the recipient.","key":"recipientRef","value":""}]},"description":"Allows merchants to view a recipient's spendback balance to ensure sufficient funds are available for spendbacks. Shows the balance for each spendback provider account associated with the `recipientRef` parameter. \n\nRequires `recipientRef` query parameter to access recipient balance information. This is the same `recipientRef` that is used in the [Submit spendback](ref:submitspendback) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the `recipientRef` parameter in the request.\n\n
    \n\n## Request parameters\n- recipientRef\n\n## Response parameters\n- recipientRef\n- recipientBalances\n- recipientBalances.recipientId\n- recipientBalances.amount\n- recipientBalances.currency\n- recipientBalances.providerId\n- recipientBalances.providerType\n\n
    "},"response":[{"id":"013f51bd-8508-4c59-951c-004a9803ec8d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/recipientBalance?recipientRef=","host":["{{baseUrl}}"],"path":["payout","v3","recipientBalance"],"query":[{"description":"(Required) Payer's unique reference value for the recipient.","key":"recipientRef","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"recipientRef\": \"\",\n \"recipientBalances\": {\n \"recipientId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"providerId\": \"\",\n \"providerType\": 30\n }\n}"},{"id":"0a74bde1-5707-4376-974e-b1313dbead89","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/payout/v3/recipientBalance?recipientRef=","host":["{{baseUrl}}"],"path":["payout","v3","recipientBalance"],"query":[{"description":"(Required) Payer's unique reference value for the recipient.","key":"recipientRef","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"15f858ae-a858-46f3-b665-231fd3dc1805"}],"id":"7a2d7cd6-f83e-44be-acc9-34037825a33f","description":"APIs for spendbacks","_postman_id":"7a2d7cd6-f83e-44be-acc9-34037825a33f"},{"name":"Transactions","item":[{"name":"View transaction by payment ID","id":"c0d9f5ca-c5bf-450b-9456-feff75af2acd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/transaction/v3/paymentId/:paymentId","host":["{{baseUrl}}"],"path":["transaction","v3","paymentId",":paymentId"],"variable":[{"id":"12aba3ee-87d3-4316-89ce-00ac3b26df4b","key":"paymentId","value":"","description":"(Required) The Nexio Payment ID"}]},"description":"Searches for transactions with the given payment ID. You get the payment ID in the [Run card transaction](ref:runcardtransaction) or [Process transaction from terminal](ref:processtransactionfromterminal) response as the `id`. Or, in the page event for the ecommerce or retail iframe.\n\nBecause you get the `paymentId` in the response for a transaction, this endpoint is useful for quickly getting transaction information and updates.\n\nAlso, you can use this endpoint instead of [View transactions](ref:viewtransactions) when you only need to get information about a single transaction and in order to get all response parameters related to the transaction without needing to request them specifically.\n\n\n> πŸ“˜ Notes\n> \n> - **It may take up to a minute after a transaction is run before you can see it in the response for this endpoint.**\n> - Payment ID is not the same as the Nexio Transaction ID, which is returned as `id` in this endpoint or in the [View transaction by transaction ID](ref:viewtransactiontransactionid) or [View transactions](ref:viewtransactions) endpoints.\n> - Certain transaction data will be returned as numerical values. The definitions are provided in the [Constant transaction values tables](doc:constant-transaction-values).\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include the payment ID in the path parameter of the request.\n\n
    \n\n## Request parameters\n- paymentId\n\n## Response parameters\n- id\n- merchantId\n- amount\n- transactionDate\n- transactionStatus\n- authCode\n- transactionType\n- cardType\n- cardNumber\n- cardHolder\n- processMethod\n- achDetailId\n- currencyId\n- reportDate\n- settledDate\n- capturedDate\n- originalTransactionId\n- createdAt\n- updatedAt\n- customer\n- customer.id\n- customer.firstName\n- customer.lastName\n- customer.postalCode\n- customer.phone\n- customer.email\n- customer.company\n- customer.customerRef\n- customer.transactionId\n- kount\n- kount.id\n- kount.status\n- kount.rules\n- kount.refNumber\n- kount.merc\n- kount.score\n- kount.ruleCount\n- kount.warningCount\n- kount.counterCount\n- kount.wasDeviceFingerprinted\n- kount.mode\n- kount.velo\n- kount.vmax\n- kount.transactionId\n- bankTransfer\n- bankTransfer.account\n- bankTransfer.checkNumber\n- bankTransfer.id\n- bankTransfer.routing\n- bankTransfer.transactionId\n- foreignProcessingCurrency\n- foreignProcessingCurrency.amount\n- foreignProcessingCurrency.currencyId\n- foreignProcessingCurrency.id\n- foreignProcessingCurrency.transactionId\n- threeDS\n- threeDS.id\n- threeDS.ECI\n- threeDS.type\n- threeDS.transactionId\n- gateway\n- gateway.gatewayName\n- gateway.refNumber\n- gateway.nsu\n- processor\n- processor.id\n- customerAddresses\n- customerAddresses.billingAddressOne\n- customerAddresses.billingAddressTwo\n- customerAddresses.billingCity\n- customerAddresses.billingCountry\n- customerAddresses.billingPhone\n- customerAddresses.billingPostal\n- customerAddresses.billingState\n- customerAddresses.shippingAddressOne\n- customerAddresses.shippingAddressTwo\n- customerAddresses.shippingCity\n- customerAddresses.shippingCountry\n- customerAddresses.shippingPhone\n- customerAddresses.shippingPostal\n- customerAddresses.shippingState\n- customerAddresses.id\n- customerAddresses.transactionId\n- subscription\n- subscription.id\n- subscription.accountId\n- subscription.initialBalance\n- subscription.interval\n- subscription.intervalCount\n- subscription.remainingBalance\n- subscription.scheduleType\n- subscription.subscriptionRef\n- subscription.transactionId\n- cardMetaData\n- cardMetaData.id\n- cardMetaData.bin\n- cardMetaData.cardBrand\n- cardMetaData.class\n- cardMetaData.countryCode\n- cardMetaData.currencyCode\n- cardMetaData.issuingBank\n- cardMetaData.transactionId\n- plugin\n- plugin.id\n- plugin.originalId\n- plugin.invoice\n- plugin.orderNumber\n- plugin.description\n- plugin.pluginType\n- plugin.paymentOptionTag\n- plugin.transactionId\n- transactionDetails\n- transactionDetails.id\n- transactionDetails.clientIp\n- transactionDetails.customFields\n- transactionDetails.description\n- transactionDetails.installments\n- transactionDetails.installmentUnit\n- transactionDetails.paymentType\n- transactionDetails.retryCount\n- transactionDetails.shoppingCart\n- transactionDetails.userName\n- transactionDetails.transactionId\n- linkedChargebackId\n\n
    "},"response":[{"id":"d4a9513f-4001-4d92-8c9b-798b59e0dd11","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/paymentId/:paymentId","host":["{{baseUrl}}"],"path":["transaction","v3","paymentId",":paymentId"],"variable":[{"key":"paymentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"amount\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"authCode\": \"\",\n \"transactionType\": \"\",\n \"cardType\": 10,\n \"cardNumber\": \"\",\n \"cardHolder\": \"\",\n \"processMethod\": \"\",\n \"achDetailId\": \"\",\n \"currencyId\": \"\",\n \"reportDate\": \"\",\n \"settledDate\": \"\",\n \"capturedDate\": \"\",\n \"originalTransactionId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"postalCode\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"company\": \"\",\n \"customerRef\": \"\",\n \"transactionId\": \"\"\n },\n \"kount\": {\n \"id\": \"\",\n \"status\": \"\",\n \"rules\": \"\",\n \"refNumber\": \"\",\n \"merc\": \"\",\n \"score\": \"\",\n \"ruleCount\": \"\",\n \"warningCount\": \"\",\n \"counterCount\": \"\",\n \"wasDeviceFingerprinted\": \"\",\n \"mode\": \"\",\n \"velo\": \"\",\n \"vmax\": \"\",\n \"transactionId\": \"\"\n },\n \"bankTransfer\": {\n \"account\": \"\",\n \"checkNumber\": \"\",\n \"id\": \"\",\n \"routing\": \"\",\n \"transactionId\": \"\"\n },\n \"foreignProcessingCurrency\": {\n \"amount\": \"\",\n \"currencyId\": 840,\n \"id\": \"\",\n \"transactionId\": \"\"\n },\n \"threeDS\": {\n \"id\": \"\",\n \"ECI\": \"\",\n \"type\": \"\",\n \"transactionId\": \"\"\n },\n \"gateway\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\",\n \"nsu\": \"\"\n },\n \"processor\": {\n \"id\": \"\"\n },\n \"customerAddresses\": {\n \"billingAddressOne\": \"\",\n \"billingAddressTwo\": \"\",\n \"billingCity\": \"\",\n \"billingCountry\": \"\",\n \"billingPhone\": \"\",\n \"billingPostal\": \"\",\n \"billingState\": \"\",\n \"shippingAddressOne\": \"\",\n \"shippingAddressTwo\": \"\",\n \"shippingCity\": \"\",\n \"shippingCountry\": \"\",\n \"shippingPhone\": \"\",\n \"shippingPostal\": \"\",\n \"shippingState\": \"\",\n \"id\": \"\",\n \"transactionId\": \"\"\n },\n \"subscription\": {\n \"id\": \"\",\n \"accountId\": \"\",\n \"initialBalance\": \"\",\n \"interval\": \"\",\n \"intervalCount\": 0,\n \"remainingBalance\": \"\",\n \"scheduleType\": \"\",\n \"subscriptionRef\": \"\",\n \"transactionId\": \"\"\n },\n \"cardMetaData\": {\n \"id\": \"\",\n \"bin\": \"\",\n \"cardBrand\": \"\",\n \"class\": \"\",\n \"countryCode\": \"\",\n \"currencyCode\": \"\",\n \"issuingBank\": \"\",\n \"transactionId\": \"\"\n },\n \"plugin\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"invoice\": \"\",\n \"orderNumber\": \"\",\n \"description\": \"\",\n \"userId\": \"\",\n \"pluginType\": \"\",\n \"paymentOptionTag\": \"\",\n \"transactionId\": \"\"\n },\n \"transactionDetails\": {\n \"id\": \"\",\n \"clientIp\": \"\",\n \"customFields\": \"\",\n \"description\": \"\",\n \"installments\": \"\",\n \"installmentUnit\": \"\",\n \"paymentType\": \"initialMoto\",\n \"retryCount\": \"\",\n \"shoppingCart\": \"\",\n \"userName\": \"\",\n \"transactionId\": \"\"\n },\n \"linkedChargebackId\": \"\"\n}"},{"id":"f084f618-c288-4cc7-ac25-a96ab1088932","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/paymentId/:paymentId","host":["{{baseUrl}}"],"path":["transaction","v3","paymentId",":paymentId"],"variable":[{"key":"paymentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"c0d9f5ca-c5bf-450b-9456-feff75af2acd"},{"name":"View transaction by transaction ID","id":"10d43c22-ff62-4cb9-b58b-11a2aa25111c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/transaction/v3/:transactionId","host":["{{baseUrl}}"],"path":["transaction","v3",":transactionId"],"variable":[{"id":"7f189333-f524-4e70-ab32-957a87001fae","key":"transactionId","value":"","description":"(Required) The Nexio Transaction ID."}]},"description":"Searches for transactions with the given transaction ID. You get the transaction ID in the [webhook](doc:webhook-body-examples#transaction-eventtype) with the `transactionId` (note that this parameter is not returned for legacy webhooks) or in the `id` returned in this endpoint or in the [View transaction by payment ID](ref:viewtransactionpaymentid) or [View transactions](ref:viewtransactions) endpoints.\n\nYou can use this endpoint instead of [View transactions](ref:viewtransactions) when you only need to get information about a single transaction and in order to get all response parameters related to the transaction without needing to request them specifically.\n\n\n> πŸ“˜ Notes\n> \n> - **It may take up to a minute after a transaction is run before you can see it in the response for this endpoint.**\n> - Transaction ID is not the same as the Nexio Payment ID, which is returned as `id` in the [Run card transaction](ref:runcardtransaction) response.\n> - Certain transaction data will be returned as numerical values. The definitions are provided in the [Constant transaction values tables](doc:constant-transaction-values).\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    Include the transaction ID in the path parameter of the request.\n\n
    \n\n## Request parameters\n- transactionId\n\n## Response parameters\n- id\n- merchantId\n- amount\n- transactionDate\n- transactionStatus\n- authCode\n- transactionType\n- cardType\n- cardNumber\n- cardHolder\n- processMethod\n- achDetailId\n- currencyId\n- reportDate\n- settledDate\n- capturedDate\n- originalTransactionId\n- createdAt\n- updatedAt\n- customer\n- customer.id\n- customer.firstName\n- customer.lastName\n- customer.postalCode\n- customer.phone\n- customer.email\n- customer.company\n- customer.customerRef\n- customer.transactionId\n- kount\n- kount.id\n- kount.status\n- kount.rules\n- kount.refNumber\n- kount.merc\n- kount.score\n- kount.ruleCount\n- kount.warningCount\n- kount.counterCount\n- kount.wasDeviceFingerprinted\n- kount.mode\n- kount.velo\n- kount.vmax\n- kount.transactionId\n- bankTransfer\n- bankTransfer.account\n- bankTransfer.checkNumber\n- bankTransfer.id\n- bankTransfer.routing\n- bankTransfer.transactionId\n- foreignProcessingCurrency\n- foreignProcessingCurrency.amount\n- foreignProcessingCurrency.currencyId\n- foreignProcessingCurrency.id\n- foreignProcessingCurrency.transactionId\n- threeDS\n- threeDS.id\n- threeDS.ECI\n- threeDS.type\n- threeDS.transactionId\n- gateway\n- gateway.gatewayName\n- gateway.refNumber\n- gateway.nsu\n- processor\n- processor.id\n- customerAddresses\n- customerAddresses.billingAddressOne\n- customerAddresses.billingAddressTwo\n- customerAddresses.billingCity\n- customerAddresses.billingCountry\n- customerAddresses.billingPhone\n- customerAddresses.billingPostal\n- customerAddresses.billingState\n- customerAddresses.shippingAddressOne\n- customerAddresses.shippingAddressTwo\n- customerAddresses.shippingCity\n- customerAddresses.shippingCountry\n- customerAddresses.shippingPhone\n- customerAddresses.shippingPostal\n- customerAddresses.shippingState\n- customerAddresses.id\n- customerAddresses.transactionId\n- subscription\n- subscription.id\n- subscription.accountId\n- subscription.initialBalance\n- subscription.interval\n- subscription.intervalCount\n- subscription.remainingBalance\n- subscription.scheduleType\n- subscription.subscriptionRef\n- subscription.transactionId\n- cardMetaData\n- cardMetaData.id\n- cardMetaData.bin\n- cardMetaData.cardBrand\n- cardMetaData.class\n- cardMetaData.countryCode\n- cardMetaData.currencyCode\n- cardMetaData.issuingBank\n- cardMetaData.transactionId\n- plugin\n- plugin.id\n- plugin.originalId\n- plugin.invoice\n- plugin.orderNumber\n- plugin.description\n- plugin.userId\n- plugin.pluginType\n- plugin.paymentOptionTag\n- plugin.transactionId\n- transactionDetails\n- transactionDetails.id\n- transactionDetails.clientIp\n- transactionDetails.customFields\n- transactionDetails.description\n- transactionDetails.installments\n- transactionDetails.installmentUnit\n- transactionDetails.paymentType\n- transactionDetails.retryCount\n- transactionDetails.shoppingCart\n- transactionDetails.userName\n- transactionDetails.transactionId\n- linkedChargebackId\n\n
    "},"response":[{"id":"30efeaf6-4ecd-4dd8-b2da-e9abd0b79cc6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/:transactionId","host":["{{baseUrl}}"],"path":["transaction","v3",":transactionId"],"variable":[{"key":"transactionId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"amount\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"authCode\": \"\",\n \"transactionType\": \"\",\n \"cardType\": 10,\n \"cardNumber\": \"\",\n \"cardHolder\": \"\",\n \"processMethod\": \"\",\n \"achDetailId\": \"\",\n \"currencyId\": \"\",\n \"reportDate\": \"\",\n \"settledDate\": \"\",\n \"capturedDate\": \"\",\n \"originalTransactionId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"postalCode\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"company\": \"\",\n \"customerRef\": \"\",\n \"transactionId\": \"\"\n },\n \"kount\": {\n \"id\": \"\",\n \"status\": \"\",\n \"rules\": \"\",\n \"refNumber\": \"\",\n \"merc\": \"\",\n \"score\": \"\",\n \"ruleCount\": \"\",\n \"warningCount\": \"\",\n \"counterCount\": \"\",\n \"wasDeviceFingerprinted\": \"\",\n \"mode\": \"\",\n \"velo\": \"\",\n \"vmax\": \"\",\n \"transactionId\": \"\"\n },\n \"bankTransfer\": {\n \"account\": \"\",\n \"checkNumber\": \"\",\n \"id\": \"\",\n \"routing\": \"\",\n \"transactionId\": \"\"\n },\n \"foreignProcessingCurrency\": {\n \"amount\": \"\",\n \"currencyId\": 840,\n \"id\": \"\",\n \"transactionId\": \"\"\n },\n \"threeDS\": {\n \"id\": \"\",\n \"ECI\": \"\",\n \"type\": \"\",\n \"transactionId\": \"\"\n },\n \"gateway\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\",\n \"nsu\": \"\"\n },\n \"processor\": {\n \"id\": \"\"\n },\n \"customerAddresses\": {\n \"billingAddressOne\": \"\",\n \"billingAddressTwo\": \"\",\n \"billingCity\": \"\",\n \"billingCountry\": \"\",\n \"billingPhone\": \"\",\n \"billingPostal\": \"\",\n \"billingState\": \"\",\n \"shippingAddressOne\": \"\",\n \"shippingAddressTwo\": \"\",\n \"shippingCity\": \"\",\n \"shippingCountry\": \"\",\n \"shippingPhone\": \"\",\n \"shippingPostal\": \"\",\n \"shippingState\": \"\",\n \"id\": \"\",\n \"transactionId\": \"\"\n },\n \"subscription\": {\n \"id\": \"\",\n \"accountId\": \"\",\n \"initialBalance\": \"\",\n \"interval\": \"\",\n \"intervalCount\": 0,\n \"remainingBalance\": \"\",\n \"scheduleType\": \"\",\n \"subscriptionRef\": \"\",\n \"transactionId\": \"\"\n },\n \"cardMetaData\": {\n \"id\": \"\",\n \"bin\": \"\",\n \"cardBrand\": \"\",\n \"class\": \"\",\n \"countryCode\": \"\",\n \"currencyCode\": \"\",\n \"issuingBank\": \"\",\n \"transactionId\": \"\"\n },\n \"plugin\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"invoice\": \"\",\n \"orderNumber\": \"\",\n \"description\": \"\",\n \"userId\": \"\",\n \"pluginType\": \"\",\n \"paymentOptionTag\": \"\",\n \"transactionId\": \"\"\n },\n \"transactionDetails\": {\n \"id\": \"\",\n \"clientIp\": \"\",\n \"customFields\": \"\",\n \"description\": \"\",\n \"installments\": \"\",\n \"installmentUnit\": \"\",\n \"paymentType\": \"initialMoto\",\n \"retryCount\": \"\",\n \"shoppingCart\": \"\",\n \"userName\": \"\",\n \"transactionId\": \"\"\n },\n \"linkedChargebackId\": \"\"\n}"},{"id":"7f0092d9-4ec4-4d59-a5c4-5c0085d473e2","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/:transactionId","host":["{{baseUrl}}"],"path":["transaction","v3",":transactionId"],"variable":[{"key":"transactionId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"10d43c22-ff62-4cb9-b58b-11a2aa25111c"},{"name":"View transactions","id":"b8fba40e-c9bc-4666-9353-f9598cd4359b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/transaction/v3?limit=10&offset=0&startDate=&endDate=&id=&merchantIds=&amount=&authCode=&transactionStatus=&transactionType=&cardType=30&cardNumber=&cardHolder=&processMethod=&achDetailId=¤cyId=840&originalTransactionId=&customer.=&customer.id=&customer.firstName=&customer.lastName=&customer.postalCode=&customer.phone=&customer.email=&customer.company=&customer.customerRef=&kount.=&kount.id=&kount.status=&kount.rules=&kount.refNumber=&kount.merc=&kount.score=&kount.ruleCount=&kount.warningCount=&kount.counterCount=&kount.wasDeviceFingerprinted=&kount.mode=&kount.velo=&kount.vmax=&bankTransfer.=&bankTransfer.id=&bankTransfer.account=&bankTransfer.routing=&bankTransfer.checkNumber=&plugin.=&plugin.id=&plugin.originalId=&plugin.invoice=&plugin.orderNumber=&plugin.description=&plugin.userId=&plugin.pluginType=&plugin.paymentOptionTag=&foreignProcessingCurrency.=&foreignProcessingCurrency.id=&foreignProcessingCurrency.amount=&foreignProcessingCurrency.currencyId=&gateway.=&gateway.id=&transaction_gateway.nsu=&gateway.merchantId=&gateway.batchRef=&gateway.refNumber=&gateway.additionalRefNumber=&gateway.trackingCode=&gateway.gatewayType=&gateway.message=&processor.=&processor.id=&processor.transactionRef=&processor.batchRef=&processor.originalId=&processor.processorType=&customerAddresses.=&customerAddresses.id=&customerAddresses.billingAddressOne=&customerAddresses.billingAddressTwo=&customerAddresses.billingCity=&customerAddresses.billingState=&customerAddresses.billingPostalCode=&customerAddresses.billingCountry=&customerAddresses.billingPhone=&customerAddresses.shippingAddressOne=&customerAddresses.shippingAddressTwo=&customerAddresses.shippingCity=&customerAddresses.shippingState=&customerAddresses.shippingPostalCode=&customerAddresses.shippingCountry=&customerAddresses.shippingPhone=&transactionDetails.=&transactionDetails.id=&transactionDetails.description=&transactionDetails.clientIp=&transactionDetails.userName=&transactionDetails.shoppingCart=&transactionDetails.customFields=&transactionDetails.retryCount=&transactionDetails.paymentType=&subscription.=&subscription.id=&subscription.remainingBalance=&subscription.initialBalance=&subscription.interval=day&subscription.intervalCount=&subscription.subscriptionRef=&subscription.accountId=&subscription.scheduleType=20","host":["{{baseUrl}}"],"path":["transaction","v3"],"query":[{"description":"Specifies the maximum number of transactions to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 transactions starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of transactions. Use it in conjunction with the `limit` parameter to control which subset of transactions the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).","key":"offset","value":"0"},{"description":"The start date. Format: YYYY-MM-DD. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date. Format: YYYY-MM-DD. The default is the current date.","key":"endDate","value":""},{"description":"The Nexio ID of the transaction. This is also known as the Transaction ID.\n\nYou can also use this value in the [View transaction by transaction ID](ref:viewtransactiontransactionid) endpoint or for this endpoint within any object as the `transactionId`.","key":"id","value":""},{"description":"A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a transaction.","key":"merchantIds","value":""},{"description":"The transaction amount. This value is used as the input for a fuzzy search. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"amount","value":""},{"description":"Represents a successfully authorized payment request. This value is used as the input for a fuzzy search.","key":"authCode","value":""},{"description":"One or more transaction statuses. For information about valid values, see the relevant [transactionStatus](doc:constant-transaction-values#transaction-status-transactionstatus) table in Guides.","key":"transactionStatus","value":""},{"description":"The transaction type. For information about valid values, see the [transactionType](doc:constant-transaction-values#transaction-type-transactiontype) table in Guides.","key":"transactionType","value":""},{"description":"The code for the Nexio card type. For information about valid values, see the [cardType](doc:constant-transaction-values#card-type-cardtype) table in Guides.","key":"cardType","value":"30"},{"description":"The masked card number. This value is used as the input for a fuzzy search.","key":"cardNumber","value":""},{"description":"The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.","key":"cardHolder","value":""},{"description":"The process method code. For information about valid values, see the [processMethod](doc:constant-transaction-values#process-method-processmethod) table in Guides.","key":"processMethod","value":""},{"description":"The Deposit Detail ID that corresponds to this transaction. This value is used as the input for a fuzzy search. ","key":"achDetailId","value":""},{"description":"The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). The default value is the code for the US dollar (840). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.","key":"currencyId","value":"840"},{"description":"The original transaction ID of a refunded transaction.","key":"originalTransactionId","value":""},{"description":"Send this as an empty query parameter in order to have all customer data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?customer.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the customer object in the response. Alternately, you can instead send a specific customer parameter to match against and you will get the customer object in the matching transactions.","key":"customer.","value":""},{"description":"The transaction's unique ID for the customer. Note that the same customer will have different IDs for each transaction. Therefore, you cannot expect to use this value to track a specific customer. Instead, provide a `customer.customerRef` value in transaction requests for a specific customer and then use that value in querying for a customer's transactions.","key":"customer.id","value":""},{"description":"The customer's first name. This value is used as the input for a fuzzy search.","key":"customer.firstName","value":""},{"description":"The customer's last name. This value is used as the input for a fuzzy search.","key":"customer.lastName","value":""},{"description":"The customer's postal code. This value is used as the input for a fuzzy search.","key":"customer.postalCode","value":""},{"description":"The customer's phone number. This value is used as the input for a fuzzy search.","key":"customer.phone","value":""},{"description":"The customer's email address. This value is used as the input for a fuzzy search.","key":"customer.email","value":""},{"description":"The customer's company. This value is used as the input for a fuzzy search.","key":"customer.company","value":""},{"description":"Customer identifier. If included in the request, the system only searches for exact matches to the value.","key":"customer.customerRef","value":""},{"description":"Send this as an empty query parameter in order to have all kount data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?kount.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the kount object in the response. Alternately, you can instead send a specific kount parameter to match against and you will get the kount object in the matching transactions.","key":"kount.","value":""},{"description":"Nexio's unique identifier.","key":"kount.id","value":""},{"description":"The fraud status. This value is used as the input for a fuzzy search.","key":"kount.status","value":""},{"description":"Kount-specific information, including rules triggered. See our [Fraud tutorial](doc:kount-verification) for more information. This value is used as the input for a fuzzy search.","key":"kount.rules","value":""},{"description":"The transaction reference number. This value is used as the input for a fuzzy search.","key":"kount.refNumber","value":""},{"description":"The Kount merchant ID (Different from Nexio's Merchant ID). This value is used as the input for a fuzzy search.","key":"kount.merc","value":""},{"description":"The Kount fraud score. This value is used as the input for a fuzzy search.","key":"kount.score","value":""},{"description":"The number of rules triggered.","key":"kount.ruleCount","value":""},{"description":"The number of warnings triggered.","key":"kount.warningCount","value":""},{"description":"Custom Kount counter. For more information, see the [Kount documentation](https://support.kount.com/hc/en-us/articles/360045195372-Rule-and-Delta-Counters).","key":"kount.counterCount","value":""},{"description":"Will be true if the device was fingerprinted.","key":"kount.wasDeviceFingerprinted","value":""},{"description":"The Kount inquiry mode. This value is used as the input for a fuzzy search.","key":"kount.mode","value":""},{"description":"The 14 day velocity. For more information, see [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-).","key":"kount.velo","value":""},{"description":"The 6 hour rolling velocity. For more information, see [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-).","key":"kount.vmax","value":""},{"description":"Send this as an empty query parameter in order to have all bankTransfer data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?bankTransfer.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the bankTransfer object in the response. Alternately, you can instead send a specific bankTransfer parameter to match against and you will get the bankTransfer object in the matching transactions. NOTE: This object only applies to transactions involving an eCheck.","key":"bankTransfer.","value":""},{"description":"The Nexio-generated unique identifier for the bank record associated with an eCheck payment.","key":"bankTransfer.id","value":""},{"description":"The masked account number for the bank record associated with an eCheck payment used for the transaction. Only the last four numbers of the account display.","key":"bankTransfer.account","value":""},{"description":"The masked routing number for the bank record associated with an eCheck payment used for the transaction.","key":"bankTransfer.routing","value":""},{"description":"The check number associated with an eCheck payment used for the transaction.","key":"bankTransfer.checkNumber","value":""},{"description":"Send this as an empty query parameter in order to have all plugin data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?plugin.&startDate=2021-06-25`, returns all transactions matching the specified start date and gives all information from the plugin object in the response. Alternately, you can instead send a specific plugin parameter to match against and you will get the plugin object in the matching transactions.","key":"plugin.","value":""},{"description":"Nexio's plugin ID.","key":"plugin.id","value":""},{"description":"The Payment ID (`paymentId`) for the transaction. This value is used as the input for an exact search.","key":"plugin.originalId","value":""},{"description":"The invoice number. This value is used as the input for a fuzzy search.","key":"plugin.invoice","value":""},{"description":"The order number. This value is used as the input for a fuzzy search.","key":"plugin.orderNumber","value":""},{"description":"The order description. This value is used as the input for a fuzzy search.","key":"plugin.description","value":""},{"description":"The user ID.","key":"plugin.userId","value":""},{"description":"Nexio's plugin type.","key":"plugin.pluginType","value":""},{"description":"A custom value used to route transactions to a specific gateway or merchant account. Contact [Integrations Support](page:contact-us) to designate a `paymentOptionTag` for a given merchant account. This value is used as the input for a fuzzy search.","key":"plugin.paymentOptionTag","value":""},{"description":"Send this as an empty query parameter in order to have all foreignProcessingCurrency data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?foreignProcessingCurrency.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the foreignProcessingCurrency object in the response. Alternately, you can instead send a specific foreignProcessingCurrency parameter to match against and you will get the foreignProcessingCurrency object in the matching transactions.","key":"foreignProcessingCurrency.","value":""},{"description":"Nexio's unique identifier.","key":"foreignProcessingCurrency.id","value":""},{"description":"The amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"foreignProcessingCurrency.amount","value":""},{"description":"The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.","key":"foreignProcessingCurrency.currencyId","value":""},{"description":"Send this as an empty query parameter in order to have all gateway data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?gateway.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the gateway object in the response. Alternately, you can instead send a specific gateway parameter to match against and you will get the gateway object in the matching transactions.","key":"gateway.","value":""},{"description":"Unique gateway identifier.","key":"gateway.id","value":""},{"description":"A code returned by specific gateways when a transaction used the BRL currency. This value is used as the input for a fuzzy search.","key":"transaction_gateway.nsu","value":""},{"description":"The merchant ID associated with the transaction. This value is used as the input for a fuzzy search.","key":"gateway.merchantId","value":""},{"description":"Reference to a batch number from the gateway about a transaction. This value is used as the input for a fuzzy search.","key":"gateway.batchRef","value":""},{"description":"Reference number from the gateway for the transaction. This value is used as the input for a fuzzy search.","key":"gateway.refNumber","value":""},{"description":"Extra field for referencing a transaction that the gateway uses. This value is used as the input for a fuzzy search.","key":"gateway.additionalRefNumber","value":""},{"description":"Tracking code used by the gateway. This value is used as the input for a fuzzy search.","key":"gateway.trackingCode","value":""},{"description":"The gateway type, expressed as an integer. ","key":"gateway.gatewayType","value":""},{"description":"Message from the gateway about the transaction. This value is used as the input for a fuzzy search.","key":"gateway.message","value":""},{"description":"Send this as an empty query parameter in order to have all processor data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?processor.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the processor object in the response. Alternately, you can instead send a specific processor parameter to match against and you will get the processor object in the matching transactions. Details will vary by processor. Do NOT code to any information included in this object.","key":"processor.","value":""},{"description":"A Nexio ID for the processor information associated with this transaction.","key":"processor.id","value":""},{"description":"Reference number for the transaction associated with this processor. This value is used as the input for a fuzzy search.","key":"processor.transactionRef","value":""},{"description":"Reference to a batch number from the processor about a transaction. This value is used as the input for a fuzzy search.","key":"processor.batchRef","value":""},{"description":"The original ID, if available. ","key":"processor.originalId","value":""},{"description":"The processor type, expressed as an integer.","key":"processor.processorType","value":""},{"description":"Send this as an empty query parameter in order to have all customerAddresses data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?customerAddresses.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the customerAddresses object in the response. Alternately, you can instead send a specific customerAddresses parameter to match against and you will get the customerAddresses object in the matching transactions.","key":"customerAddresses.","value":""},{"description":"Nexio's unique identifier for the customer address record.","key":"customerAddresses.id","value":""},{"description":"The street address for the customer. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingAddressOne","value":""},{"description":"Additional street address information, if required. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingAddressTwo","value":""},{"description":"The city for the address record. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingCity","value":""},{"description":"The state or province on file. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.","key":"customerAddresses.billingState","value":""},{"description":"The postal code on file. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingPostalCode","value":""},{"description":"The country for the billing address. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingCountry","value":""},{"description":"The billing phone number. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingPhone","value":""},{"description":"The shipping address, if different from the billing address. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingAddressOne","value":""},{"description":"Additional shipping address information, if required. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingAddressTwo","value":""},{"description":"The shipping city. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingCity","value":""},{"description":"The shipping state or province. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingState","value":""},{"description":"The shipping postal code. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingPostalCode","value":""},{"description":"The country for the shipping address. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingCountry","value":""},{"description":"The shipping phone number. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingPhone","value":""},{"description":"Send this as an empty query parameter in order to have all transactionDetails data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?transactionDetails.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the transactionDetails object in the response. Alternately, you can instead send a specific transactionDetails parameter to match against and you will get the transactionDetails object in the matching transactions.","key":"transactionDetails.","value":""},{"description":"Unique identifier for the transaction details.","key":"transactionDetails.id","value":""},{"description":"Description of the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.description","value":""},{"description":"The IP address of where the transaction occurred. This value is used as the input for a fuzzy search.","key":"transactionDetails.clientIp","value":""},{"description":"User name of the API user for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.userName","value":""},{"description":"Stringified version of the shoppingCart object for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.shoppingCart","value":""},{"description":"Stringified version of the customFields object for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.customFields","value":""},{"description":"The number of retries for the transaction.","key":"transactionDetails.retryCount","value":""},{"description":"Indicates the type of transaction being processed (one-time or recurring) using stored payment credentials. For information about the possible options, see [Payment type](doc:constant-transaction-values#payment-type-paymenttype) in Guides. This value is used as the input for a fuzzy search.","key":"transactionDetails.paymentType","value":""},{"description":"Send this as an empty query parameter in order to have all subscription data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?subscription.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the subscription object in the response. Alternately, you can instead send a specific subscription parameter to match against and you will get the subscription object in the matching transactions.","key":"subscription.","value":""},{"description":"Nexio's unique identifier for the subscription.","key":"subscription.id","value":""},{"description":"The current balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"subscription.remainingBalance","value":""},{"description":"The starting balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"subscription.initialBalance","value":""},{"description":"The schedule's time period. This value is used as the input for a fuzzy search.","key":"subscription.interval","value":"day"},{"description":"The number of intervals that will pass between transactions. For examples of how the interval and interval count create the subscription schedule, see the [subscription schedule examples table](doc:getting-started-with-subscriptions#subscription-schedule-examples-table).","key":"subscription.intervalCount","value":""},{"description":"Reference number from the merchant for the subscription. This value is used as the input for a fuzzy search.","key":"subscription.subscriptionRef","value":""},{"description":"Identifier for the Nexio account running the subscription. This value is used as the input for a fuzzy search.","key":"subscription.accountId","value":""},{"description":"Type of schedule, given as an integer for whether the subscription is a payment plan (the value for this is 20) or a subscription (the value for this is 10). This value is used as the input for a fuzzy search.","key":"subscription.scheduleType","value":"20"}]},"description":"The endpoint returns all transactions that meet the specified parameters and that are associated with the Nexio account used to [authenticate](doc:authentication). \n\nYou request (or filter) on fields of the query parameters as in the following example:\n\n /transaction/v3?kount.&plugin.&customer.&processor.&gateway.\n\nSee the [Finding a transaction](doc:finding-a-transaction) topic in Guides for a full tutorial.\n\nThe default response only includes a small number of parameters. If you want additional objects and parameters, you must specify them in the request. For more information about how to do this, see the [Requesting additional response parameters](doc:requesting-additional-response-parameters) topic in Guides.\n\n\n> πŸ›‘ Warning\n> \n> You must specify at least one parameter. Failing to submit one results in an Internal Server Error. Also, it is **not** possible to send a request with all parameters. Doing so results in a 400 error and the system does not return a response.\n\n\n> πŸ“˜ Notes\n> \n> - **It may take up to a minute after a transaction is run before you can see it in the response for this endpoint.**\n> - If you want to search for a transaction by `paymentId`, you should use the [View transaction by payment ID](ref:viewtransactionpaymentid) endpoint so that you get all the details for the transaction. Alternately, include the value of the `paymentId` in the `plugin.originalId` query parameter in this endpoint along with any [additional response parameters](doc:requesting-additional-response-parameters).\n> - If you want to search for a transaction by `transactionId`, you should use the [View transaction by transaction ID](ref:viewtransactiontransactionid) endpoint so that you get all the details for the transaction. Alternately, include the transaction ID value in the `id` or `transactionId` (within any object) query parameter in this endpoint along with any [additional response parameters](doc:requesting-additional-response-parameters).\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

    You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.\n> username: `docs@nexiopay.com`\n> password: `JZdzoXpdDeH6VA`

    When you use the test account, in order to avoid potential security issues, the system returns a set of test transactions. No other transactions that you may have run previously display in the results.\n\n\n
    \n\n## Request parameters\n- achDetailId\n- amount\n- authCode\n- bankTransfer\n- bankTransfer.account\n- bankTransfer.checkNumber\n- bankTransfer.id\n- bankTransfer.routing\n- bankTransfer.transactionId\n- capturedDate\n- cardNumber\n- cardHolder\n- cardType\n- createdAt\n- currencyId\n- customer\n- customer.company\n- customer.customerRef\n- customer.email\n- customer.firstName\n- customer.id\n- customer.lastName\n- customer.postalCode\n- customer.phone\n- customer.transactionId\n- customerAddresses\n- customerAddresses.billingAddressOne\n- customerAddresses.billingAddressTwo\n- customerAddresses.billingCity\n- customerAddresses.billingCountry\n- customerAddresses.billingPhone\n- customerAddresses.billingPostalCode\n- customerAddresses.billingState\n- customerAddresses.shippingAddressOne\n- customerAddresses.shippingAddressTwo\n- customerAddresses.shippingCity\n- customerAddresses.shippingCountry\n- customerAddresses.shippingPhone\n- customerAddresses.shippingPostalCode\n- customerAddresses.shippingState\n- customerAddresses.id\n- customerAddresses.transactionId\n- endDate\n- foreignProcessingCurrency\n- foreignProcessingCurrency.amount\n- foreignProcessingCurrency.currencyId\n- foreignProcessingCurrency.id\n- foreignProcessingCurrency.transactionId\n- gateway\n- gateway.additionalRefNumber\n- gateway.batchRef\n- gateway.gatewayType\n- gateway.id\n- gateway.merchantId\n- gateway.message\n- gateway.trackingCode\n- gateway.refNumber\n- gateway.transactionId\n- gateway.nsu\n- id\n- kount\n- kount.counterCount\n- kount.id\n- kount.merc\n- kount.mode\n- kount.refNumber\n- kount.ruleCount\n- kount.rules\n- kount.score\n- kount.status\n- kount.transactionId\n- kount.velo\n- kount.vmax\n- kount.warningCount\n- kount.wasDeviceFingerprinted\n- linkedChargebackId\n- merchantIds\n- originalTransactionId\n- plugin\n- plugin.description\n- plugin.id\n- plugin.invoice\n- plugin.orderNumber\n- plugin.originalId\n- plugin.paymentOptionTag\n- plugin.pluginType\n- plugin.transactionId\n- plugin.userId\n- processMethod\n- processor\n- processor.batchRef\n- processor.id\n- processor.originalId\n- processor.processorType\n- processor.transactionId\n- processor.transactionRef\n- reportDate\n- settledDate\n- startDate\n- subscription\n- subscription.accountId\n- subscription.id\n- subscription.initialBalance\n- subscription.interval\n- subscription.intervalCount\n- subscription.remainingBalance\n- subscription.scheduleType\n- subscription.subscriptionRef\n- subscription.transactionId\n- transactionDate\n- transactionDetails\n- transactionDetails.clientIp\n- transactionDetails.customFields\n- transactionDetails.description\n- transactionDetails.id\n- transactionDetails.paymentType\n- transactionDetails.retryCount\n- transactionDetails.shoppingCart\n- transactionDetails.transactionId\n- transactionDetails.userName\n- transactionStatus\n- transactionType\n- updatedAt\n- limit\n- offset\n\n## Response parameters\n- offset\n- limit\n- rows\n- rows.id\n- rows.merchantId\n- rows.amount\n- rows.transactionDate\n- rows.transactionStatus\n- rows.authCode\n- rows.transactionType\n- rows.cardType\n- rows.cardNumber\n- rows.cardHolder\n- rows.processMethod\n- rows.achDetailId\n- rows.currencyId\n- rows.reportDate\n- rows.settledDate\n- rows.capturedDate\n- rows.originalTransactionId\n- rows.createdAt\n- rows.updatedAt\n- rows.customer\n- rows.customer.id\n- rows.customer.firstName\n- rows.customer.lastName\n- rows.customer.postalCode\n- rows.customer.phone\n- rows.customer.email\n- rows.customer.company\n- rows.customer.customerRef\n- rows.customer.transactionId\n- rows.kount\n- rows.kount.id\n- rows.kount.status\n- rows.kount.rules\n- rows.kount.refNumber\n- rows.kount.merc\n- rows.kount.score\n- rows.kount.ruleCount\n- rows.kount.warningCount\n- rows.kount.counterCount\n- rows.kount.wasDeviceFingerprinted\n- rows.kount.mode\n- rows.kount.velo\n- rows.kount.vmax\n- rows.kount.transactionId\n- rows.bankTransfer\n- rows.bankTransfer.account\n- rows.bankTransfer.checkNumber\n- rows.bankTransfer.id\n- rows.bankTransfer.routing\n- rows.bankTransfer.transactionId\n- rows.foreignProcessingCurrency\n- rows.foreignProcessingCurrency.amount\n- rows.foreignProcessingCurrency.currencyId\n- rows.foreignProcessingCurrency.id\n- rows.foreignProcessingCurrency.transactionId\n- rows.threeDS\n- rows.threeDS.id\n- rows.threeDS.ECI\n- rows.threeDS.type\n- rows.threeDS.transactionId\n- rows.gateway\n- rows.gateway.gatewayName\n- rows.gateway.refNumber\n- rows.gateway.nsu\n- rows.processor\n- rows.processor.id\n- rows.customerAddresses\n- rows.customerAddresses.billingAddressOne\n- rows.customerAddresses.billingAddressTwo\n- rows.customerAddresses.billingCity\n- rows.customerAddresses.billingCountry\n- rows.customerAddresses.billingPhone\n- rows.customerAddresses.billingPostal\n- rows.customerAddresses.billingState\n- rows.customerAddresses.shippingAddressOne\n- rows.customerAddresses.shippingAddressTwo\n- rows.customerAddresses.shippingCity\n- rows.customerAddresses.shippingCountry\n- rows.customerAddresses.shippingPhone\n- rows.customerAddresses.shippingPostal\n- rows.customerAddresses.shippingState\n- rows.customerAddresses.id\n- rows.customerAddresses.transactionId\n- rows.subscription\n- rows.subscription.id\n- rows.subscription.accountId\n- rows.subscription.initialBalance\n- rows.subscription.interval\n- rows.subscription.intervalCount\n- rows.subscription.remainingBalance\n- rows.subscription.scheduleType\n- rows.subscription.subscriptionRef\n- rows.subscription.transactionId\n- rows.cardMetaData\n- rows.cardMetaData.id\n- rows.cardMetaData.bin\n- rows.cardMetaData.cardBrand\n- rows.cardMetaData.class\n- rows.cardMetaData.countryCode\n- rows.cardMetaData.currencyCode\n- rows.cardMetaData.issuingBank\n- rows.cardMetaData.transactionId\n- rows.plugin\n- rows.plugin.id\n- rows.plugin.originalId\n- rows.plugin.invoice\n- rows.plugin.orderNumber\n- rows.plugin.description\n- rows.plugin.pluginType\n- rows.plugin.paymentOptionTag\n- rows.plugin.transactionId\n- rows.transactionDetails\n- rows.transactionDetails.id\n- rows.transactionDetails.clientIp\n- rows.transactionDetails.customFields\n- rows.transactionDetails.description\n- rows.transactionDetails.installments\n- rows.transactionDetails.installmentUnit\n- rows.transactionDetails.paymentType\n- rows.transactionDetails.retryCount\n- rows.transactionDetails.shoppingCart\n- rows.transactionDetails.userName\n- rows.transactionDetails.transactionId\n- hasMore\n\n
    "},"response":[{"id":"00f16241-98c8-4ccd-9aec-8b120c562e5d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3?limit=10&offset=0&startDate=&endDate=&id=&merchantIds=&amount=&authCode=&transactionStatus=&transactionType=&cardType=30&cardNumber=&cardHolder=&processMethod=&achDetailId=¤cyId=840&originalTransactionId=&customer.=&customer.id=&customer.firstName=&customer.lastName=&customer.postalCode=&customer.phone=&customer.email=&customer.company=&customer.customerRef=&kount.=&kount.id=&kount.status=&kount.rules=&kount.refNumber=&kount.merc=&kount.score=&kount.ruleCount=&kount.warningCount=&kount.counterCount=&kount.wasDeviceFingerprinted=&kount.mode=&kount.velo=&kount.vmax=&bankTransfer.=&bankTransfer.id=&bankTransfer.account=&bankTransfer.routing=&bankTransfer.checkNumber=&plugin.=&plugin.id=&plugin.originalId=&plugin.invoice=&plugin.orderNumber=&plugin.description=&plugin.userId=&plugin.pluginType=&plugin.paymentOptionTag=&foreignProcessingCurrency.=&foreignProcessingCurrency.id=&foreignProcessingCurrency.amount=&foreignProcessingCurrency.currencyId=&gateway.=&gateway.id=&transaction_gateway.nsu=&gateway.merchantId=&gateway.batchRef=&gateway.refNumber=&gateway.additionalRefNumber=&gateway.trackingCode=&gateway.gatewayType=&gateway.message=&processor.=&processor.id=&processor.transactionRef=&processor.batchRef=&processor.originalId=&processor.processorType=&customerAddresses.=&customerAddresses.id=&customerAddresses.billingAddressOne=&customerAddresses.billingAddressTwo=&customerAddresses.billingCity=&customerAddresses.billingState=&customerAddresses.billingPostalCode=&customerAddresses.billingCountry=&customerAddresses.billingPhone=&customerAddresses.shippingAddressOne=&customerAddresses.shippingAddressTwo=&customerAddresses.shippingCity=&customerAddresses.shippingState=&customerAddresses.shippingPostalCode=&customerAddresses.shippingCountry=&customerAddresses.shippingPhone=&transactionDetails.=&transactionDetails.id=&transactionDetails.description=&transactionDetails.clientIp=&transactionDetails.userName=&transactionDetails.shoppingCart=&transactionDetails.customFields=&transactionDetails.retryCount=&transactionDetails.paymentType=&subscription.=&subscription.id=&subscription.remainingBalance=&subscription.initialBalance=&subscription.interval=day&subscription.intervalCount=&subscription.subscriptionRef=&subscription.accountId=&subscription.scheduleType=20","host":["{{baseUrl}}"],"path":["transaction","v3"],"query":[{"description":"Specifies the maximum number of transactions to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 transactions starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of transactions. Use it in conjunction with the `limit` parameter to control which subset of transactions the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).","key":"offset","value":"0"},{"description":"The start date. Format: YYYY-MM-DD. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date. Format: YYYY-MM-DD. The default is the current date.","key":"endDate","value":""},{"description":"The Nexio ID of the transaction. This is also known as the Transaction ID.\n\nYou can also use this value in the [View transaction by transaction ID](ref:viewtransactiontransactionid) endpoint or for this endpoint within any object as the `transactionId`.","key":"id","value":""},{"description":"A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a transaction.","key":"merchantIds","value":""},{"description":"The transaction amount. This value is used as the input for a fuzzy search. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"amount","value":""},{"description":"Represents a successfully authorized payment request. This value is used as the input for a fuzzy search.","key":"authCode","value":""},{"description":"One or more transaction statuses. For information about valid values, see the relevant [transactionStatus](doc:constant-transaction-values#transaction-status-transactionstatus) table in Guides.","key":"transactionStatus","value":""},{"description":"The transaction type. For information about valid values, see the [transactionType](doc:constant-transaction-values#transaction-type-transactiontype) table in Guides.","key":"transactionType","value":""},{"description":"The code for the Nexio card type. For information about valid values, see the [cardType](doc:constant-transaction-values#card-type-cardtype) table in Guides.","key":"cardType","value":"30"},{"description":"The masked card number. This value is used as the input for a fuzzy search.","key":"cardNumber","value":""},{"description":"The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.","key":"cardHolder","value":""},{"description":"The process method code. For information about valid values, see the [processMethod](doc:constant-transaction-values#process-method-processmethod) table in Guides.","key":"processMethod","value":""},{"description":"The Deposit Detail ID that corresponds to this transaction. This value is used as the input for a fuzzy search. ","key":"achDetailId","value":""},{"description":"The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). The default value is the code for the US dollar (840). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.","key":"currencyId","value":"840"},{"description":"The original transaction ID of a refunded transaction.","key":"originalTransactionId","value":""},{"description":"Send this as an empty query parameter in order to have all customer data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?customer.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the customer object in the response. Alternately, you can instead send a specific customer parameter to match against and you will get the customer object in the matching transactions.","key":"customer.","value":""},{"description":"The transaction's unique ID for the customer. Note that the same customer will have different IDs for each transaction. Therefore, you cannot expect to use this value to track a specific customer. Instead, provide a `customer.customerRef` value in transaction requests for a specific customer and then use that value in querying for a customer's transactions.","key":"customer.id","value":""},{"description":"The customer's first name. This value is used as the input for a fuzzy search.","key":"customer.firstName","value":""},{"description":"The customer's last name. This value is used as the input for a fuzzy search.","key":"customer.lastName","value":""},{"description":"The customer's postal code. This value is used as the input for a fuzzy search.","key":"customer.postalCode","value":""},{"description":"The customer's phone number. This value is used as the input for a fuzzy search.","key":"customer.phone","value":""},{"description":"The customer's email address. This value is used as the input for a fuzzy search.","key":"customer.email","value":""},{"description":"The customer's company. This value is used as the input for a fuzzy search.","key":"customer.company","value":""},{"description":"Customer identifier. If included in the request, the system only searches for exact matches to the value.","key":"customer.customerRef","value":""},{"description":"Send this as an empty query parameter in order to have all kount data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?kount.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the kount object in the response. Alternately, you can instead send a specific kount parameter to match against and you will get the kount object in the matching transactions.","key":"kount.","value":""},{"description":"Nexio's unique identifier.","key":"kount.id","value":""},{"description":"The fraud status. This value is used as the input for a fuzzy search.","key":"kount.status","value":""},{"description":"Kount-specific information, including rules triggered. See our [Fraud tutorial](doc:kount-verification) for more information. This value is used as the input for a fuzzy search.","key":"kount.rules","value":""},{"description":"The transaction reference number. This value is used as the input for a fuzzy search.","key":"kount.refNumber","value":""},{"description":"The Kount merchant ID (Different from Nexio's Merchant ID). This value is used as the input for a fuzzy search.","key":"kount.merc","value":""},{"description":"The Kount fraud score. This value is used as the input for a fuzzy search.","key":"kount.score","value":""},{"description":"The number of rules triggered.","key":"kount.ruleCount","value":""},{"description":"The number of warnings triggered.","key":"kount.warningCount","value":""},{"description":"Custom Kount counter. For more information, see the [Kount documentation](https://support.kount.com/hc/en-us/articles/360045195372-Rule-and-Delta-Counters).","key":"kount.counterCount","value":""},{"description":"Will be true if the device was fingerprinted.","key":"kount.wasDeviceFingerprinted","value":""},{"description":"The Kount inquiry mode. This value is used as the input for a fuzzy search.","key":"kount.mode","value":""},{"description":"The 14 day velocity. For more information, see [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-).","key":"kount.velo","value":""},{"description":"The 6 hour rolling velocity. For more information, see [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-).","key":"kount.vmax","value":""},{"description":"Send this as an empty query parameter in order to have all bankTransfer data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?bankTransfer.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the bankTransfer object in the response. Alternately, you can instead send a specific bankTransfer parameter to match against and you will get the bankTransfer object in the matching transactions. NOTE: This object only applies to transactions involving an eCheck.","key":"bankTransfer.","value":""},{"description":"The Nexio-generated unique identifier for the bank record associated with an eCheck payment.","key":"bankTransfer.id","value":""},{"description":"The masked account number for the bank record associated with an eCheck payment used for the transaction. Only the last four numbers of the account display.","key":"bankTransfer.account","value":""},{"description":"The masked routing number for the bank record associated with an eCheck payment used for the transaction.","key":"bankTransfer.routing","value":""},{"description":"The check number associated with an eCheck payment used for the transaction.","key":"bankTransfer.checkNumber","value":""},{"description":"Send this as an empty query parameter in order to have all plugin data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?plugin.&startDate=2021-06-25`, returns all transactions matching the specified start date and gives all information from the plugin object in the response. Alternately, you can instead send a specific plugin parameter to match against and you will get the plugin object in the matching transactions.","key":"plugin.","value":""},{"description":"Nexio's plugin ID.","key":"plugin.id","value":""},{"description":"The Payment ID (`paymentId`) for the transaction. This value is used as the input for an exact search.","key":"plugin.originalId","value":""},{"description":"The invoice number. This value is used as the input for a fuzzy search.","key":"plugin.invoice","value":""},{"description":"The order number. This value is used as the input for a fuzzy search.","key":"plugin.orderNumber","value":""},{"description":"The order description. This value is used as the input for a fuzzy search.","key":"plugin.description","value":""},{"description":"The user ID.","key":"plugin.userId","value":""},{"description":"Nexio's plugin type.","key":"plugin.pluginType","value":""},{"description":"A custom value used to route transactions to a specific gateway or merchant account. Contact [Integrations Support](page:contact-us) to designate a `paymentOptionTag` for a given merchant account. This value is used as the input for a fuzzy search.","key":"plugin.paymentOptionTag","value":""},{"description":"Send this as an empty query parameter in order to have all foreignProcessingCurrency data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?foreignProcessingCurrency.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the foreignProcessingCurrency object in the response. Alternately, you can instead send a specific foreignProcessingCurrency parameter to match against and you will get the foreignProcessingCurrency object in the matching transactions.","key":"foreignProcessingCurrency.","value":""},{"description":"Nexio's unique identifier.","key":"foreignProcessingCurrency.id","value":""},{"description":"The amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"foreignProcessingCurrency.amount","value":""},{"description":"The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.","key":"foreignProcessingCurrency.currencyId","value":""},{"description":"Send this as an empty query parameter in order to have all gateway data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?gateway.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the gateway object in the response. Alternately, you can instead send a specific gateway parameter to match against and you will get the gateway object in the matching transactions.","key":"gateway.","value":""},{"description":"Unique gateway identifier.","key":"gateway.id","value":""},{"description":"A code returned by specific gateways when a transaction used the BRL currency. This value is used as the input for a fuzzy search.","key":"transaction_gateway.nsu","value":""},{"description":"The merchant ID associated with the transaction. This value is used as the input for a fuzzy search.","key":"gateway.merchantId","value":""},{"description":"Reference to a batch number from the gateway about a transaction. This value is used as the input for a fuzzy search.","key":"gateway.batchRef","value":""},{"description":"Reference number from the gateway for the transaction. This value is used as the input for a fuzzy search.","key":"gateway.refNumber","value":""},{"description":"Extra field for referencing a transaction that the gateway uses. This value is used as the input for a fuzzy search.","key":"gateway.additionalRefNumber","value":""},{"description":"Tracking code used by the gateway. This value is used as the input for a fuzzy search.","key":"gateway.trackingCode","value":""},{"description":"The gateway type, expressed as an integer. ","key":"gateway.gatewayType","value":""},{"description":"Message from the gateway about the transaction. This value is used as the input for a fuzzy search.","key":"gateway.message","value":""},{"description":"Send this as an empty query parameter in order to have all processor data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?processor.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the processor object in the response. Alternately, you can instead send a specific processor parameter to match against and you will get the processor object in the matching transactions. Details will vary by processor. Do NOT code to any information included in this object.","key":"processor.","value":""},{"description":"A Nexio ID for the processor information associated with this transaction.","key":"processor.id","value":""},{"description":"Reference number for the transaction associated with this processor. This value is used as the input for a fuzzy search.","key":"processor.transactionRef","value":""},{"description":"Reference to a batch number from the processor about a transaction. This value is used as the input for a fuzzy search.","key":"processor.batchRef","value":""},{"description":"The original ID, if available. ","key":"processor.originalId","value":""},{"description":"The processor type, expressed as an integer.","key":"processor.processorType","value":""},{"description":"Send this as an empty query parameter in order to have all customerAddresses data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?customerAddresses.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the customerAddresses object in the response. Alternately, you can instead send a specific customerAddresses parameter to match against and you will get the customerAddresses object in the matching transactions.","key":"customerAddresses.","value":""},{"description":"Nexio's unique identifier for the customer address record.","key":"customerAddresses.id","value":""},{"description":"The street address for the customer. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingAddressOne","value":""},{"description":"Additional street address information, if required. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingAddressTwo","value":""},{"description":"The city for the address record. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingCity","value":""},{"description":"The state or province on file. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.","key":"customerAddresses.billingState","value":""},{"description":"The postal code on file. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingPostalCode","value":""},{"description":"The country for the billing address. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingCountry","value":""},{"description":"The billing phone number. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingPhone","value":""},{"description":"The shipping address, if different from the billing address. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingAddressOne","value":""},{"description":"Additional shipping address information, if required. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingAddressTwo","value":""},{"description":"The shipping city. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingCity","value":""},{"description":"The shipping state or province. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingState","value":""},{"description":"The shipping postal code. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingPostalCode","value":""},{"description":"The country for the shipping address. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingCountry","value":""},{"description":"The shipping phone number. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingPhone","value":""},{"description":"Send this as an empty query parameter in order to have all transactionDetails data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?transactionDetails.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the transactionDetails object in the response. Alternately, you can instead send a specific transactionDetails parameter to match against and you will get the transactionDetails object in the matching transactions.","key":"transactionDetails.","value":""},{"description":"Unique identifier for the transaction details.","key":"transactionDetails.id","value":""},{"description":"Description of the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.description","value":""},{"description":"The IP address of where the transaction occurred. This value is used as the input for a fuzzy search.","key":"transactionDetails.clientIp","value":""},{"description":"User name of the API user for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.userName","value":""},{"description":"Stringified version of the shoppingCart object for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.shoppingCart","value":""},{"description":"Stringified version of the customFields object for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.customFields","value":""},{"description":"The number of retries for the transaction.","key":"transactionDetails.retryCount","value":""},{"description":"Indicates the type of transaction being processed (one-time or recurring) using stored payment credentials. For information about the possible options, see [Payment type](doc:constant-transaction-values#payment-type-paymenttype) in Guides. This value is used as the input for a fuzzy search.","key":"transactionDetails.paymentType","value":""},{"description":"Send this as an empty query parameter in order to have all subscription data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?subscription.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the subscription object in the response. Alternately, you can instead send a specific subscription parameter to match against and you will get the subscription object in the matching transactions.","key":"subscription.","value":""},{"description":"Nexio's unique identifier for the subscription.","key":"subscription.id","value":""},{"description":"The current balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"subscription.remainingBalance","value":""},{"description":"The starting balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"subscription.initialBalance","value":""},{"description":"The schedule's time period. This value is used as the input for a fuzzy search.","key":"subscription.interval","value":"day"},{"description":"The number of intervals that will pass between transactions. For examples of how the interval and interval count create the subscription schedule, see the [subscription schedule examples table](doc:getting-started-with-subscriptions#subscription-schedule-examples-table).","key":"subscription.intervalCount","value":""},{"description":"Reference number from the merchant for the subscription. This value is used as the input for a fuzzy search.","key":"subscription.subscriptionRef","value":""},{"description":"Identifier for the Nexio account running the subscription. This value is used as the input for a fuzzy search.","key":"subscription.accountId","value":""},{"description":"Type of schedule, given as an integer for whether the subscription is a payment plan (the value for this is 20) or a subscription (the value for this is 10). This value is used as the input for a fuzzy search.","key":"subscription.scheduleType","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": 0,\n \"limit\": 10,\n \"rows\": [\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"amount\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"authCode\": \"\",\n \"transactionType\": \"\",\n \"cardType\": 50,\n \"cardNumber\": \"\",\n \"cardHolder\": \"\",\n \"processMethod\": \"\",\n \"achDetailId\": \"\",\n \"currencyId\": \"\",\n \"reportDate\": \"\",\n \"settledDate\": \"\",\n \"capturedDate\": \"\",\n \"originalTransactionId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"postalCode\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"company\": \"\",\n \"customerRef\": \"\",\n \"transactionId\": \"\"\n },\n \"kount\": {\n \"id\": \"\",\n \"status\": \"\",\n \"rules\": \"\",\n \"refNumber\": \"\",\n \"merc\": \"\",\n \"score\": \"\",\n \"ruleCount\": \"\",\n \"warningCount\": \"\",\n \"counterCount\": \"\",\n \"wasDeviceFingerprinted\": \"\",\n \"mode\": \"\",\n \"velo\": \"\",\n \"vmax\": \"\",\n \"transactionId\": \"\"\n },\n \"bankTransfer\": {\n \"account\": \"\",\n \"checkNumber\": \"\",\n \"id\": \"\",\n \"routing\": \"\",\n \"transactionId\": \"\"\n },\n \"foreignProcessingCurrency\": {\n \"amount\": \"\",\n \"currencyId\": 840,\n \"id\": \"\",\n \"transactionId\": \"\"\n },\n \"threeDS\": {\n \"id\": \"\",\n \"ECI\": \"\",\n \"type\": \"\",\n \"transactionId\": \"\"\n },\n \"gateway\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\",\n \"nsu\": \"\"\n },\n \"processor\": {\n \"id\": \"\"\n },\n \"customerAddresses\": {\n \"billingAddressOne\": \"\",\n \"billingAddressTwo\": \"\",\n \"billingCity\": \"\",\n \"billingCountry\": \"\",\n \"billingPhone\": \"\",\n \"billingPostal\": \"\",\n \"billingState\": \"\",\n \"shippingAddressOne\": \"\",\n \"shippingAddressTwo\": \"\",\n \"shippingCity\": \"\",\n \"shippingCountry\": \"\",\n \"shippingPhone\": \"\",\n \"shippingPostal\": \"\",\n \"shippingState\": \"\",\n \"id\": \"\",\n \"transactionId\": \"\"\n },\n \"subscription\": {\n \"id\": \"\",\n \"accountId\": \"\",\n \"initialBalance\": \"\",\n \"interval\": \"\",\n \"intervalCount\": 0,\n \"remainingBalance\": \"\",\n \"scheduleType\": \"\",\n \"subscriptionRef\": \"\",\n \"transactionId\": \"\"\n },\n \"cardMetaData\": {\n \"id\": \"\",\n \"bin\": \"\",\n \"cardBrand\": \"\",\n \"class\": \"\",\n \"countryCode\": \"\",\n \"currencyCode\": \"\",\n \"issuingBank\": \"\",\n \"transactionId\": \"\"\n },\n \"plugin\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"invoice\": \"\",\n \"orderNumber\": \"\",\n \"description\": \"\",\n \"userId\": \"\",\n \"pluginType\": \"\",\n \"paymentOptionTag\": \"\",\n \"transactionId\": \"\"\n },\n \"transactionDetails\": {\n \"id\": \"\",\n \"clientIp\": \"\",\n \"customFields\": \"\",\n \"description\": \"\",\n \"installments\": \"\",\n \"installmentUnit\": \"\",\n \"paymentType\": \"initialScheduled\",\n \"retryCount\": \"\",\n \"shoppingCart\": \"\",\n \"userName\": \"\",\n \"transactionId\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"amount\": \"\",\n \"transactionDate\": \"\",\n \"transactionStatus\": \"\",\n \"authCode\": \"\",\n \"transactionType\": \"\",\n \"cardType\": 30,\n \"cardNumber\": \"\",\n \"cardHolder\": \"\",\n \"processMethod\": \"\",\n \"achDetailId\": \"\",\n \"currencyId\": \"\",\n \"reportDate\": \"\",\n \"settledDate\": \"\",\n \"capturedDate\": \"\",\n \"originalTransactionId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"postalCode\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"company\": \"\",\n \"customerRef\": \"\",\n \"transactionId\": \"\"\n },\n \"kount\": {\n \"id\": \"\",\n \"status\": \"\",\n \"rules\": \"\",\n \"refNumber\": \"\",\n \"merc\": \"\",\n \"score\": \"\",\n \"ruleCount\": \"\",\n \"warningCount\": \"\",\n \"counterCount\": \"\",\n \"wasDeviceFingerprinted\": \"\",\n \"mode\": \"\",\n \"velo\": \"\",\n \"vmax\": \"\",\n \"transactionId\": \"\"\n },\n \"bankTransfer\": {\n \"account\": \"\",\n \"checkNumber\": \"\",\n \"id\": \"\",\n \"routing\": \"\",\n \"transactionId\": \"\"\n },\n \"foreignProcessingCurrency\": {\n \"amount\": \"\",\n \"currencyId\": 840,\n \"id\": \"\",\n \"transactionId\": \"\"\n },\n \"threeDS\": {\n \"id\": \"\",\n \"ECI\": \"\",\n \"type\": \"\",\n \"transactionId\": \"\"\n },\n \"gateway\": {\n \"gatewayName\": \"\",\n \"refNumber\": \"\",\n \"nsu\": \"\"\n },\n \"processor\": {\n \"id\": \"\"\n },\n \"customerAddresses\": {\n \"billingAddressOne\": \"\",\n \"billingAddressTwo\": \"\",\n \"billingCity\": \"\",\n \"billingCountry\": \"\",\n \"billingPhone\": \"\",\n \"billingPostal\": \"\",\n \"billingState\": \"\",\n \"shippingAddressOne\": \"\",\n \"shippingAddressTwo\": \"\",\n \"shippingCity\": \"\",\n \"shippingCountry\": \"\",\n \"shippingPhone\": \"\",\n \"shippingPostal\": \"\",\n \"shippingState\": \"\",\n \"id\": \"\",\n \"transactionId\": \"\"\n },\n \"subscription\": {\n \"id\": \"\",\n \"accountId\": \"\",\n \"initialBalance\": \"\",\n \"interval\": \"\",\n \"intervalCount\": 0,\n \"remainingBalance\": \"\",\n \"scheduleType\": \"\",\n \"subscriptionRef\": \"\",\n \"transactionId\": \"\"\n },\n \"cardMetaData\": {\n \"id\": \"\",\n \"bin\": \"\",\n \"cardBrand\": \"\",\n \"class\": \"\",\n \"countryCode\": \"\",\n \"currencyCode\": \"\",\n \"issuingBank\": \"\",\n \"transactionId\": \"\"\n },\n \"plugin\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"invoice\": \"\",\n \"orderNumber\": \"\",\n \"description\": \"\",\n \"userId\": \"\",\n \"pluginType\": \"\",\n \"paymentOptionTag\": \"\",\n \"transactionId\": \"\"\n },\n \"transactionDetails\": {\n \"id\": \"\",\n \"clientIp\": \"\",\n \"customFields\": \"\",\n \"description\": \"\",\n \"installments\": \"\",\n \"installmentUnit\": \"\",\n \"paymentType\": \"unscheduledCit\",\n \"retryCount\": \"\",\n \"shoppingCart\": \"\",\n \"userName\": \"\",\n \"transactionId\": \"\"\n }\n }\n ],\n \"hasMore\": \"\"\n}"},{"id":"85ee5c9e-cb4f-4ca1-8928-c658e06f6b76","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3?limit=10&offset=0&startDate=&endDate=&id=&merchantIds=&amount=&authCode=&transactionStatus=&transactionType=&cardType=30&cardNumber=&cardHolder=&processMethod=&achDetailId=¤cyId=840&originalTransactionId=&customer.=&customer.id=&customer.firstName=&customer.lastName=&customer.postalCode=&customer.phone=&customer.email=&customer.company=&customer.customerRef=&kount.=&kount.id=&kount.status=&kount.rules=&kount.refNumber=&kount.merc=&kount.score=&kount.ruleCount=&kount.warningCount=&kount.counterCount=&kount.wasDeviceFingerprinted=&kount.mode=&kount.velo=&kount.vmax=&bankTransfer.=&bankTransfer.id=&bankTransfer.account=&bankTransfer.routing=&bankTransfer.checkNumber=&plugin.=&plugin.id=&plugin.originalId=&plugin.invoice=&plugin.orderNumber=&plugin.description=&plugin.userId=&plugin.pluginType=&plugin.paymentOptionTag=&foreignProcessingCurrency.=&foreignProcessingCurrency.id=&foreignProcessingCurrency.amount=&foreignProcessingCurrency.currencyId=&gateway.=&gateway.id=&transaction_gateway.nsu=&gateway.merchantId=&gateway.batchRef=&gateway.refNumber=&gateway.additionalRefNumber=&gateway.trackingCode=&gateway.gatewayType=&gateway.message=&processor.=&processor.id=&processor.transactionRef=&processor.batchRef=&processor.originalId=&processor.processorType=&customerAddresses.=&customerAddresses.id=&customerAddresses.billingAddressOne=&customerAddresses.billingAddressTwo=&customerAddresses.billingCity=&customerAddresses.billingState=&customerAddresses.billingPostalCode=&customerAddresses.billingCountry=&customerAddresses.billingPhone=&customerAddresses.shippingAddressOne=&customerAddresses.shippingAddressTwo=&customerAddresses.shippingCity=&customerAddresses.shippingState=&customerAddresses.shippingPostalCode=&customerAddresses.shippingCountry=&customerAddresses.shippingPhone=&transactionDetails.=&transactionDetails.id=&transactionDetails.description=&transactionDetails.clientIp=&transactionDetails.userName=&transactionDetails.shoppingCart=&transactionDetails.customFields=&transactionDetails.retryCount=&transactionDetails.paymentType=&subscription.=&subscription.id=&subscription.remainingBalance=&subscription.initialBalance=&subscription.interval=day&subscription.intervalCount=&subscription.subscriptionRef=&subscription.accountId=&subscription.scheduleType=20","host":["{{baseUrl}}"],"path":["transaction","v3"],"query":[{"description":"Specifies the maximum number of transactions to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 transactions starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of transactions. Use it in conjunction with the `limit` parameter to control which subset of transactions the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).","key":"offset","value":"0"},{"description":"The start date. Format: YYYY-MM-DD. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date. Format: YYYY-MM-DD. The default is the current date.","key":"endDate","value":""},{"description":"The Nexio ID of the transaction. This is also known as the Transaction ID.\n\nYou can also use this value in the [View transaction by transaction ID](ref:viewtransactiontransactionid) endpoint or for this endpoint within any object as the `transactionId`.","key":"id","value":""},{"description":"A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a transaction.","key":"merchantIds","value":""},{"description":"The transaction amount. This value is used as the input for a fuzzy search. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"amount","value":""},{"description":"Represents a successfully authorized payment request. This value is used as the input for a fuzzy search.","key":"authCode","value":""},{"description":"One or more transaction statuses. For information about valid values, see the relevant [transactionStatus](doc:constant-transaction-values#transaction-status-transactionstatus) table in Guides.","key":"transactionStatus","value":""},{"description":"The transaction type. For information about valid values, see the [transactionType](doc:constant-transaction-values#transaction-type-transactiontype) table in Guides.","key":"transactionType","value":""},{"description":"The code for the Nexio card type. For information about valid values, see the [cardType](doc:constant-transaction-values#card-type-cardtype) table in Guides.","key":"cardType","value":"30"},{"description":"The masked card number. This value is used as the input for a fuzzy search.","key":"cardNumber","value":""},{"description":"The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.","key":"cardHolder","value":""},{"description":"The process method code. For information about valid values, see the [processMethod](doc:constant-transaction-values#process-method-processmethod) table in Guides.","key":"processMethod","value":""},{"description":"The Deposit Detail ID that corresponds to this transaction. This value is used as the input for a fuzzy search. ","key":"achDetailId","value":""},{"description":"The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). The default value is the code for the US dollar (840). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.","key":"currencyId","value":"840"},{"description":"The original transaction ID of a refunded transaction.","key":"originalTransactionId","value":""},{"description":"Send this as an empty query parameter in order to have all customer data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?customer.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the customer object in the response. Alternately, you can instead send a specific customer parameter to match against and you will get the customer object in the matching transactions.","key":"customer.","value":""},{"description":"The transaction's unique ID for the customer. Note that the same customer will have different IDs for each transaction. Therefore, you cannot expect to use this value to track a specific customer. Instead, provide a `customer.customerRef` value in transaction requests for a specific customer and then use that value in querying for a customer's transactions.","key":"customer.id","value":""},{"description":"The customer's first name. This value is used as the input for a fuzzy search.","key":"customer.firstName","value":""},{"description":"The customer's last name. This value is used as the input for a fuzzy search.","key":"customer.lastName","value":""},{"description":"The customer's postal code. This value is used as the input for a fuzzy search.","key":"customer.postalCode","value":""},{"description":"The customer's phone number. This value is used as the input for a fuzzy search.","key":"customer.phone","value":""},{"description":"The customer's email address. This value is used as the input for a fuzzy search.","key":"customer.email","value":""},{"description":"The customer's company. This value is used as the input for a fuzzy search.","key":"customer.company","value":""},{"description":"Customer identifier. If included in the request, the system only searches for exact matches to the value.","key":"customer.customerRef","value":""},{"description":"Send this as an empty query parameter in order to have all kount data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?kount.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the kount object in the response. Alternately, you can instead send a specific kount parameter to match against and you will get the kount object in the matching transactions.","key":"kount.","value":""},{"description":"Nexio's unique identifier.","key":"kount.id","value":""},{"description":"The fraud status. This value is used as the input for a fuzzy search.","key":"kount.status","value":""},{"description":"Kount-specific information, including rules triggered. See our [Fraud tutorial](doc:kount-verification) for more information. This value is used as the input for a fuzzy search.","key":"kount.rules","value":""},{"description":"The transaction reference number. This value is used as the input for a fuzzy search.","key":"kount.refNumber","value":""},{"description":"The Kount merchant ID (Different from Nexio's Merchant ID). This value is used as the input for a fuzzy search.","key":"kount.merc","value":""},{"description":"The Kount fraud score. This value is used as the input for a fuzzy search.","key":"kount.score","value":""},{"description":"The number of rules triggered.","key":"kount.ruleCount","value":""},{"description":"The number of warnings triggered.","key":"kount.warningCount","value":""},{"description":"Custom Kount counter. For more information, see the [Kount documentation](https://support.kount.com/hc/en-us/articles/360045195372-Rule-and-Delta-Counters).","key":"kount.counterCount","value":""},{"description":"Will be true if the device was fingerprinted.","key":"kount.wasDeviceFingerprinted","value":""},{"description":"The Kount inquiry mode. This value is used as the input for a fuzzy search.","key":"kount.mode","value":""},{"description":"The 14 day velocity. For more information, see [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-).","key":"kount.velo","value":""},{"description":"The 6 hour rolling velocity. For more information, see [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-).","key":"kount.vmax","value":""},{"description":"Send this as an empty query parameter in order to have all bankTransfer data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?bankTransfer.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the bankTransfer object in the response. Alternately, you can instead send a specific bankTransfer parameter to match against and you will get the bankTransfer object in the matching transactions. NOTE: This object only applies to transactions involving an eCheck.","key":"bankTransfer.","value":""},{"description":"The Nexio-generated unique identifier for the bank record associated with an eCheck payment.","key":"bankTransfer.id","value":""},{"description":"The masked account number for the bank record associated with an eCheck payment used for the transaction. Only the last four numbers of the account display.","key":"bankTransfer.account","value":""},{"description":"The masked routing number for the bank record associated with an eCheck payment used for the transaction.","key":"bankTransfer.routing","value":""},{"description":"The check number associated with an eCheck payment used for the transaction.","key":"bankTransfer.checkNumber","value":""},{"description":"Send this as an empty query parameter in order to have all plugin data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?plugin.&startDate=2021-06-25`, returns all transactions matching the specified start date and gives all information from the plugin object in the response. Alternately, you can instead send a specific plugin parameter to match against and you will get the plugin object in the matching transactions.","key":"plugin.","value":""},{"description":"Nexio's plugin ID.","key":"plugin.id","value":""},{"description":"The Payment ID (`paymentId`) for the transaction. This value is used as the input for an exact search.","key":"plugin.originalId","value":""},{"description":"The invoice number. This value is used as the input for a fuzzy search.","key":"plugin.invoice","value":""},{"description":"The order number. This value is used as the input for a fuzzy search.","key":"plugin.orderNumber","value":""},{"description":"The order description. This value is used as the input for a fuzzy search.","key":"plugin.description","value":""},{"description":"The user ID.","key":"plugin.userId","value":""},{"description":"Nexio's plugin type.","key":"plugin.pluginType","value":""},{"description":"A custom value used to route transactions to a specific gateway or merchant account. Contact [Integrations Support](page:contact-us) to designate a `paymentOptionTag` for a given merchant account. This value is used as the input for a fuzzy search.","key":"plugin.paymentOptionTag","value":""},{"description":"Send this as an empty query parameter in order to have all foreignProcessingCurrency data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?foreignProcessingCurrency.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the foreignProcessingCurrency object in the response. Alternately, you can instead send a specific foreignProcessingCurrency parameter to match against and you will get the foreignProcessingCurrency object in the matching transactions.","key":"foreignProcessingCurrency.","value":""},{"description":"Nexio's unique identifier.","key":"foreignProcessingCurrency.id","value":""},{"description":"The amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"foreignProcessingCurrency.amount","value":""},{"description":"The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.","key":"foreignProcessingCurrency.currencyId","value":""},{"description":"Send this as an empty query parameter in order to have all gateway data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?gateway.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the gateway object in the response. Alternately, you can instead send a specific gateway parameter to match against and you will get the gateway object in the matching transactions.","key":"gateway.","value":""},{"description":"Unique gateway identifier.","key":"gateway.id","value":""},{"description":"A code returned by specific gateways when a transaction used the BRL currency. This value is used as the input for a fuzzy search.","key":"transaction_gateway.nsu","value":""},{"description":"The merchant ID associated with the transaction. This value is used as the input for a fuzzy search.","key":"gateway.merchantId","value":""},{"description":"Reference to a batch number from the gateway about a transaction. This value is used as the input for a fuzzy search.","key":"gateway.batchRef","value":""},{"description":"Reference number from the gateway for the transaction. This value is used as the input for a fuzzy search.","key":"gateway.refNumber","value":""},{"description":"Extra field for referencing a transaction that the gateway uses. This value is used as the input for a fuzzy search.","key":"gateway.additionalRefNumber","value":""},{"description":"Tracking code used by the gateway. This value is used as the input for a fuzzy search.","key":"gateway.trackingCode","value":""},{"description":"The gateway type, expressed as an integer. ","key":"gateway.gatewayType","value":""},{"description":"Message from the gateway about the transaction. This value is used as the input for a fuzzy search.","key":"gateway.message","value":""},{"description":"Send this as an empty query parameter in order to have all processor data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?processor.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the processor object in the response. Alternately, you can instead send a specific processor parameter to match against and you will get the processor object in the matching transactions. Details will vary by processor. Do NOT code to any information included in this object.","key":"processor.","value":""},{"description":"A Nexio ID for the processor information associated with this transaction.","key":"processor.id","value":""},{"description":"Reference number for the transaction associated with this processor. This value is used as the input for a fuzzy search.","key":"processor.transactionRef","value":""},{"description":"Reference to a batch number from the processor about a transaction. This value is used as the input for a fuzzy search.","key":"processor.batchRef","value":""},{"description":"The original ID, if available. ","key":"processor.originalId","value":""},{"description":"The processor type, expressed as an integer.","key":"processor.processorType","value":""},{"description":"Send this as an empty query parameter in order to have all customerAddresses data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?customerAddresses.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the customerAddresses object in the response. Alternately, you can instead send a specific customerAddresses parameter to match against and you will get the customerAddresses object in the matching transactions.","key":"customerAddresses.","value":""},{"description":"Nexio's unique identifier for the customer address record.","key":"customerAddresses.id","value":""},{"description":"The street address for the customer. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingAddressOne","value":""},{"description":"Additional street address information, if required. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingAddressTwo","value":""},{"description":"The city for the address record. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingCity","value":""},{"description":"The state or province on file. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.","key":"customerAddresses.billingState","value":""},{"description":"The postal code on file. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingPostalCode","value":""},{"description":"The country for the billing address. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingCountry","value":""},{"description":"The billing phone number. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingPhone","value":""},{"description":"The shipping address, if different from the billing address. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingAddressOne","value":""},{"description":"Additional shipping address information, if required. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingAddressTwo","value":""},{"description":"The shipping city. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingCity","value":""},{"description":"The shipping state or province. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingState","value":""},{"description":"The shipping postal code. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingPostalCode","value":""},{"description":"The country for the shipping address. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingCountry","value":""},{"description":"The shipping phone number. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingPhone","value":""},{"description":"Send this as an empty query parameter in order to have all transactionDetails data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?transactionDetails.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the transactionDetails object in the response. Alternately, you can instead send a specific transactionDetails parameter to match against and you will get the transactionDetails object in the matching transactions.","key":"transactionDetails.","value":""},{"description":"Unique identifier for the transaction details.","key":"transactionDetails.id","value":""},{"description":"Description of the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.description","value":""},{"description":"The IP address of where the transaction occurred. This value is used as the input for a fuzzy search.","key":"transactionDetails.clientIp","value":""},{"description":"User name of the API user for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.userName","value":""},{"description":"Stringified version of the shoppingCart object for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.shoppingCart","value":""},{"description":"Stringified version of the customFields object for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.customFields","value":""},{"description":"The number of retries for the transaction.","key":"transactionDetails.retryCount","value":""},{"description":"Indicates the type of transaction being processed (one-time or recurring) using stored payment credentials. For information about the possible options, see [Payment type](doc:constant-transaction-values#payment-type-paymenttype) in Guides. This value is used as the input for a fuzzy search.","key":"transactionDetails.paymentType","value":""},{"description":"Send this as an empty query parameter in order to have all subscription data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?subscription.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the subscription object in the response. Alternately, you can instead send a specific subscription parameter to match against and you will get the subscription object in the matching transactions.","key":"subscription.","value":""},{"description":"Nexio's unique identifier for the subscription.","key":"subscription.id","value":""},{"description":"The current balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"subscription.remainingBalance","value":""},{"description":"The starting balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"subscription.initialBalance","value":""},{"description":"The schedule's time period. This value is used as the input for a fuzzy search.","key":"subscription.interval","value":"day"},{"description":"The number of intervals that will pass between transactions. For examples of how the interval and interval count create the subscription schedule, see the [subscription schedule examples table](doc:getting-started-with-subscriptions#subscription-schedule-examples-table).","key":"subscription.intervalCount","value":""},{"description":"Reference number from the merchant for the subscription. This value is used as the input for a fuzzy search.","key":"subscription.subscriptionRef","value":""},{"description":"Identifier for the Nexio account running the subscription. This value is used as the input for a fuzzy search.","key":"subscription.accountId","value":""},{"description":"Type of schedule, given as an integer for whether the subscription is a payment plan (the value for this is 20) or a subscription (the value for this is 10). This value is used as the input for a fuzzy search.","key":"subscription.scheduleType","value":"20"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"53e9f3cd-2b96-490d-bb7d-90438c1eb717","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3?limit=10&offset=0&startDate=&endDate=&id=&merchantIds=&amount=&authCode=&transactionStatus=&transactionType=&cardType=30&cardNumber=&cardHolder=&processMethod=&achDetailId=¤cyId=840&originalTransactionId=&customer.=&customer.id=&customer.firstName=&customer.lastName=&customer.postalCode=&customer.phone=&customer.email=&customer.company=&customer.customerRef=&kount.=&kount.id=&kount.status=&kount.rules=&kount.refNumber=&kount.merc=&kount.score=&kount.ruleCount=&kount.warningCount=&kount.counterCount=&kount.wasDeviceFingerprinted=&kount.mode=&kount.velo=&kount.vmax=&bankTransfer.=&bankTransfer.id=&bankTransfer.account=&bankTransfer.routing=&bankTransfer.checkNumber=&plugin.=&plugin.id=&plugin.originalId=&plugin.invoice=&plugin.orderNumber=&plugin.description=&plugin.userId=&plugin.pluginType=&plugin.paymentOptionTag=&foreignProcessingCurrency.=&foreignProcessingCurrency.id=&foreignProcessingCurrency.amount=&foreignProcessingCurrency.currencyId=&gateway.=&gateway.id=&transaction_gateway.nsu=&gateway.merchantId=&gateway.batchRef=&gateway.refNumber=&gateway.additionalRefNumber=&gateway.trackingCode=&gateway.gatewayType=&gateway.message=&processor.=&processor.id=&processor.transactionRef=&processor.batchRef=&processor.originalId=&processor.processorType=&customerAddresses.=&customerAddresses.id=&customerAddresses.billingAddressOne=&customerAddresses.billingAddressTwo=&customerAddresses.billingCity=&customerAddresses.billingState=&customerAddresses.billingPostalCode=&customerAddresses.billingCountry=&customerAddresses.billingPhone=&customerAddresses.shippingAddressOne=&customerAddresses.shippingAddressTwo=&customerAddresses.shippingCity=&customerAddresses.shippingState=&customerAddresses.shippingPostalCode=&customerAddresses.shippingCountry=&customerAddresses.shippingPhone=&transactionDetails.=&transactionDetails.id=&transactionDetails.description=&transactionDetails.clientIp=&transactionDetails.userName=&transactionDetails.shoppingCart=&transactionDetails.customFields=&transactionDetails.retryCount=&transactionDetails.paymentType=&subscription.=&subscription.id=&subscription.remainingBalance=&subscription.initialBalance=&subscription.interval=day&subscription.intervalCount=&subscription.subscriptionRef=&subscription.accountId=&subscription.scheduleType=20","host":["{{baseUrl}}"],"path":["transaction","v3"],"query":[{"description":"Specifies the maximum number of transactions to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 transactions starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of transactions. Use it in conjunction with the `limit` parameter to control which subset of transactions the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).","key":"offset","value":"0"},{"description":"The start date. Format: YYYY-MM-DD. The default value is 30 days prior to the current date.","key":"startDate","value":""},{"description":"The end date. Format: YYYY-MM-DD. The default is the current date.","key":"endDate","value":""},{"description":"The Nexio ID of the transaction. This is also known as the Transaction ID.\n\nYou can also use this value in the [View transaction by transaction ID](ref:viewtransactiontransactionid) endpoint or for this endpoint within any object as the `transactionId`.","key":"id","value":""},{"description":"A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a transaction.","key":"merchantIds","value":""},{"description":"The transaction amount. This value is used as the input for a fuzzy search. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"amount","value":""},{"description":"Represents a successfully authorized payment request. This value is used as the input for a fuzzy search.","key":"authCode","value":""},{"description":"One or more transaction statuses. For information about valid values, see the relevant [transactionStatus](doc:constant-transaction-values#transaction-status-transactionstatus) table in Guides.","key":"transactionStatus","value":""},{"description":"The transaction type. For information about valid values, see the [transactionType](doc:constant-transaction-values#transaction-type-transactiontype) table in Guides.","key":"transactionType","value":""},{"description":"The code for the Nexio card type. For information about valid values, see the [cardType](doc:constant-transaction-values#card-type-cardtype) table in Guides.","key":"cardType","value":"30"},{"description":"The masked card number. This value is used as the input for a fuzzy search.","key":"cardNumber","value":""},{"description":"The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.","key":"cardHolder","value":""},{"description":"The process method code. For information about valid values, see the [processMethod](doc:constant-transaction-values#process-method-processmethod) table in Guides.","key":"processMethod","value":""},{"description":"The Deposit Detail ID that corresponds to this transaction. This value is used as the input for a fuzzy search. ","key":"achDetailId","value":""},{"description":"The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). The default value is the code for the US dollar (840). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.","key":"currencyId","value":"840"},{"description":"The original transaction ID of a refunded transaction.","key":"originalTransactionId","value":""},{"description":"Send this as an empty query parameter in order to have all customer data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?customer.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the customer object in the response. Alternately, you can instead send a specific customer parameter to match against and you will get the customer object in the matching transactions.","key":"customer.","value":""},{"description":"The transaction's unique ID for the customer. Note that the same customer will have different IDs for each transaction. Therefore, you cannot expect to use this value to track a specific customer. Instead, provide a `customer.customerRef` value in transaction requests for a specific customer and then use that value in querying for a customer's transactions.","key":"customer.id","value":""},{"description":"The customer's first name. This value is used as the input for a fuzzy search.","key":"customer.firstName","value":""},{"description":"The customer's last name. This value is used as the input for a fuzzy search.","key":"customer.lastName","value":""},{"description":"The customer's postal code. This value is used as the input for a fuzzy search.","key":"customer.postalCode","value":""},{"description":"The customer's phone number. This value is used as the input for a fuzzy search.","key":"customer.phone","value":""},{"description":"The customer's email address. This value is used as the input for a fuzzy search.","key":"customer.email","value":""},{"description":"The customer's company. This value is used as the input for a fuzzy search.","key":"customer.company","value":""},{"description":"Customer identifier. If included in the request, the system only searches for exact matches to the value.","key":"customer.customerRef","value":""},{"description":"Send this as an empty query parameter in order to have all kount data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?kount.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the kount object in the response. Alternately, you can instead send a specific kount parameter to match against and you will get the kount object in the matching transactions.","key":"kount.","value":""},{"description":"Nexio's unique identifier.","key":"kount.id","value":""},{"description":"The fraud status. This value is used as the input for a fuzzy search.","key":"kount.status","value":""},{"description":"Kount-specific information, including rules triggered. See our [Fraud tutorial](doc:kount-verification) for more information. This value is used as the input for a fuzzy search.","key":"kount.rules","value":""},{"description":"The transaction reference number. This value is used as the input for a fuzzy search.","key":"kount.refNumber","value":""},{"description":"The Kount merchant ID (Different from Nexio's Merchant ID). This value is used as the input for a fuzzy search.","key":"kount.merc","value":""},{"description":"The Kount fraud score. This value is used as the input for a fuzzy search.","key":"kount.score","value":""},{"description":"The number of rules triggered.","key":"kount.ruleCount","value":""},{"description":"The number of warnings triggered.","key":"kount.warningCount","value":""},{"description":"Custom Kount counter. For more information, see the [Kount documentation](https://support.kount.com/hc/en-us/articles/360045195372-Rule-and-Delta-Counters).","key":"kount.counterCount","value":""},{"description":"Will be true if the device was fingerprinted.","key":"kount.wasDeviceFingerprinted","value":""},{"description":"The Kount inquiry mode. This value is used as the input for a fuzzy search.","key":"kount.mode","value":""},{"description":"The 14 day velocity. For more information, see [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-).","key":"kount.velo","value":""},{"description":"The 6 hour rolling velocity. For more information, see [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-).","key":"kount.vmax","value":""},{"description":"Send this as an empty query parameter in order to have all bankTransfer data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?bankTransfer.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the bankTransfer object in the response. Alternately, you can instead send a specific bankTransfer parameter to match against and you will get the bankTransfer object in the matching transactions. NOTE: This object only applies to transactions involving an eCheck.","key":"bankTransfer.","value":""},{"description":"The Nexio-generated unique identifier for the bank record associated with an eCheck payment.","key":"bankTransfer.id","value":""},{"description":"The masked account number for the bank record associated with an eCheck payment used for the transaction. Only the last four numbers of the account display.","key":"bankTransfer.account","value":""},{"description":"The masked routing number for the bank record associated with an eCheck payment used for the transaction.","key":"bankTransfer.routing","value":""},{"description":"The check number associated with an eCheck payment used for the transaction.","key":"bankTransfer.checkNumber","value":""},{"description":"Send this as an empty query parameter in order to have all plugin data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?plugin.&startDate=2021-06-25`, returns all transactions matching the specified start date and gives all information from the plugin object in the response. Alternately, you can instead send a specific plugin parameter to match against and you will get the plugin object in the matching transactions.","key":"plugin.","value":""},{"description":"Nexio's plugin ID.","key":"plugin.id","value":""},{"description":"The Payment ID (`paymentId`) for the transaction. This value is used as the input for an exact search.","key":"plugin.originalId","value":""},{"description":"The invoice number. This value is used as the input for a fuzzy search.","key":"plugin.invoice","value":""},{"description":"The order number. This value is used as the input for a fuzzy search.","key":"plugin.orderNumber","value":""},{"description":"The order description. This value is used as the input for a fuzzy search.","key":"plugin.description","value":""},{"description":"The user ID.","key":"plugin.userId","value":""},{"description":"Nexio's plugin type.","key":"plugin.pluginType","value":""},{"description":"A custom value used to route transactions to a specific gateway or merchant account. Contact [Integrations Support](page:contact-us) to designate a `paymentOptionTag` for a given merchant account. This value is used as the input for a fuzzy search.","key":"plugin.paymentOptionTag","value":""},{"description":"Send this as an empty query parameter in order to have all foreignProcessingCurrency data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?foreignProcessingCurrency.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the foreignProcessingCurrency object in the response. Alternately, you can instead send a specific foreignProcessingCurrency parameter to match against and you will get the foreignProcessingCurrency object in the matching transactions.","key":"foreignProcessingCurrency.","value":""},{"description":"Nexio's unique identifier.","key":"foreignProcessingCurrency.id","value":""},{"description":"The amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"foreignProcessingCurrency.amount","value":""},{"description":"The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.","key":"foreignProcessingCurrency.currencyId","value":""},{"description":"Send this as an empty query parameter in order to have all gateway data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?gateway.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the gateway object in the response. Alternately, you can instead send a specific gateway parameter to match against and you will get the gateway object in the matching transactions.","key":"gateway.","value":""},{"description":"Unique gateway identifier.","key":"gateway.id","value":""},{"description":"A code returned by specific gateways when a transaction used the BRL currency. This value is used as the input for a fuzzy search.","key":"transaction_gateway.nsu","value":""},{"description":"The merchant ID associated with the transaction. This value is used as the input for a fuzzy search.","key":"gateway.merchantId","value":""},{"description":"Reference to a batch number from the gateway about a transaction. This value is used as the input for a fuzzy search.","key":"gateway.batchRef","value":""},{"description":"Reference number from the gateway for the transaction. This value is used as the input for a fuzzy search.","key":"gateway.refNumber","value":""},{"description":"Extra field for referencing a transaction that the gateway uses. This value is used as the input for a fuzzy search.","key":"gateway.additionalRefNumber","value":""},{"description":"Tracking code used by the gateway. This value is used as the input for a fuzzy search.","key":"gateway.trackingCode","value":""},{"description":"The gateway type, expressed as an integer. ","key":"gateway.gatewayType","value":""},{"description":"Message from the gateway about the transaction. This value is used as the input for a fuzzy search.","key":"gateway.message","value":""},{"description":"Send this as an empty query parameter in order to have all processor data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?processor.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the processor object in the response. Alternately, you can instead send a specific processor parameter to match against and you will get the processor object in the matching transactions. Details will vary by processor. Do NOT code to any information included in this object.","key":"processor.","value":""},{"description":"A Nexio ID for the processor information associated with this transaction.","key":"processor.id","value":""},{"description":"Reference number for the transaction associated with this processor. This value is used as the input for a fuzzy search.","key":"processor.transactionRef","value":""},{"description":"Reference to a batch number from the processor about a transaction. This value is used as the input for a fuzzy search.","key":"processor.batchRef","value":""},{"description":"The original ID, if available. ","key":"processor.originalId","value":""},{"description":"The processor type, expressed as an integer.","key":"processor.processorType","value":""},{"description":"Send this as an empty query parameter in order to have all customerAddresses data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?customerAddresses.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the customerAddresses object in the response. Alternately, you can instead send a specific customerAddresses parameter to match against and you will get the customerAddresses object in the matching transactions.","key":"customerAddresses.","value":""},{"description":"Nexio's unique identifier for the customer address record.","key":"customerAddresses.id","value":""},{"description":"The street address for the customer. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingAddressOne","value":""},{"description":"Additional street address information, if required. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingAddressTwo","value":""},{"description":"The city for the address record. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingCity","value":""},{"description":"The state or province on file. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.","key":"customerAddresses.billingState","value":""},{"description":"The postal code on file. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingPostalCode","value":""},{"description":"The country for the billing address. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingCountry","value":""},{"description":"The billing phone number. This value is used as the input for a fuzzy search.","key":"customerAddresses.billingPhone","value":""},{"description":"The shipping address, if different from the billing address. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingAddressOne","value":""},{"description":"Additional shipping address information, if required. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingAddressTwo","value":""},{"description":"The shipping city. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingCity","value":""},{"description":"The shipping state or province. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingState","value":""},{"description":"The shipping postal code. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingPostalCode","value":""},{"description":"The country for the shipping address. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingCountry","value":""},{"description":"The shipping phone number. This value is used as the input for a fuzzy search.","key":"customerAddresses.shippingPhone","value":""},{"description":"Send this as an empty query parameter in order to have all transactionDetails data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?transactionDetails.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the transactionDetails object in the response. Alternately, you can instead send a specific transactionDetails parameter to match against and you will get the transactionDetails object in the matching transactions.","key":"transactionDetails.","value":""},{"description":"Unique identifier for the transaction details.","key":"transactionDetails.id","value":""},{"description":"Description of the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.description","value":""},{"description":"The IP address of where the transaction occurred. This value is used as the input for a fuzzy search.","key":"transactionDetails.clientIp","value":""},{"description":"User name of the API user for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.userName","value":""},{"description":"Stringified version of the shoppingCart object for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.shoppingCart","value":""},{"description":"Stringified version of the customFields object for the transaction. This value is used as the input for a fuzzy search.","key":"transactionDetails.customFields","value":""},{"description":"The number of retries for the transaction.","key":"transactionDetails.retryCount","value":""},{"description":"Indicates the type of transaction being processed (one-time or recurring) using stored payment credentials. For information about the possible options, see [Payment type](doc:constant-transaction-values#payment-type-paymenttype) in Guides. This value is used as the input for a fuzzy search.","key":"transactionDetails.paymentType","value":""},{"description":"Send this as an empty query parameter in order to have all subscription data for the transaction returned in the response. For example, `https://{api_url}/transaction/v3?subscription.&plugin.originalId=PAYMENT_ID`, returns all transactions matching the specified PAYMENT_ID and gives all information from the subscription object in the response. Alternately, you can instead send a specific subscription parameter to match against and you will get the subscription object in the matching transactions.","key":"subscription.","value":""},{"description":"Nexio's unique identifier for the subscription.","key":"subscription.id","value":""},{"description":"The current balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"subscription.remainingBalance","value":""},{"description":"The starting balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.","key":"subscription.initialBalance","value":""},{"description":"The schedule's time period. This value is used as the input for a fuzzy search.","key":"subscription.interval","value":"day"},{"description":"The number of intervals that will pass between transactions. For examples of how the interval and interval count create the subscription schedule, see the [subscription schedule examples table](doc:getting-started-with-subscriptions#subscription-schedule-examples-table).","key":"subscription.intervalCount","value":""},{"description":"Reference number from the merchant for the subscription. This value is used as the input for a fuzzy search.","key":"subscription.subscriptionRef","value":""},{"description":"Identifier for the Nexio account running the subscription. This value is used as the input for a fuzzy search.","key":"subscription.accountId","value":""},{"description":"Type of schedule, given as an integer for whether the subscription is a payment plan (the value for this is 20) or a subscription (the value for this is 10). This value is used as the input for a fuzzy search.","key":"subscription.scheduleType","value":"20"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"b8fba40e-c9bc-4666-9353-f9598cd4359b"},{"name":"View transaction count","id":"46a9bce7-adee-4a72-b046-f969f7019238","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/transaction/v3/count?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","count"],"query":[{"description":"The date to begin with counting transactions. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The date to stop at for counting transactions. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]},"description":"Returns a count of all transactions between the default or specified date range.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n
    \n\n## Request parameters\n- endDate\n- startDate\n\n## Response parameters\n- integer\n\n
    "},"response":[{"id":"c2f74c2c-d2d3-493a-ae2c-4f19cd506028","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/count?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","count"],"query":[{"description":"The date to begin with counting transactions. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The date to stop at for counting transactions. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"e2a82b17-9c4e-42c1-a22d-0e9fcd8ee7fb","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/count?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","count"],"query":[{"description":"The date to begin with counting transactions. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The date to stop at for counting transactions. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"46a9bce7-adee-4a72-b046-f969f7019238"},{"name":"View transaction total","id":"1fb158ed-c9e4-46ca-82f3-7fc5172ad978","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/transaction/v3/total?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","total"],"query":[{"description":"(Required) The date to begin counting transaction totals. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"(Required) The last date for counting transaction totals. Format: YYYY-MM-DD","key":"endDate","value":""}]},"description":"Returns a sum of the transaction amounts between the given dates.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n
    \n\n## Request parameters\n- endDate\n- startDate\n\n## Response parameters\n- number\n\n
    "},"response":[{"id":"0b47d89a-687e-42b3-903d-2e6923190444","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/total?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","total"],"query":[{"description":"(Required) The date to begin counting transaction totals. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"(Required) The last date for counting transaction totals. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"ac3d678a-ea03-4d22-8b5e-cfb04b42844e","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/total?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","total"],"query":[{"description":"(Required) The date to begin counting transaction totals. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"(Required) The last date for counting transaction totals. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"1fb158ed-c9e4-46ca-82f3-7fc5172ad978"},{"name":"View daily transaction summary","id":"f2950c2e-0c8c-48cd-a48b-8dbc535a4d2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/transaction/v3/dailyTransactionsSummary?date=","host":["{{baseUrl}}"],"path":["transaction","v3","dailyTransactionsSummary"],"query":[{"description":"The date to get transaction summaries for. The default start date is today's date. Format: YYYY-MM-DD","key":"date","value":""}]},"description":"Returns transaction summaries per hour for the given date and the day before that.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- date\n\n## Response parameters\n- today\n- today.hour\n- today.amount\n- today.count\n- yesterday\n- yesterday.hour\n- yesterday.amount\n- yesterday.count\n\n
    "},"response":[{"id":"2f9413eb-3ffb-4a28-946c-565c93433349","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/dailyTransactionsSummary?date=","host":["{{baseUrl}}"],"path":["transaction","v3","dailyTransactionsSummary"],"query":[{"description":"The date to get transaction summaries for. The default start date is today's date. Format: YYYY-MM-DD","key":"date","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"today\": [\n {\n \"hour\": \"\",\n \"amount\": \"\",\n \"count\": \"\"\n },\n {\n \"hour\": \"\",\n \"amount\": \"\",\n \"count\": \"\"\n }\n ],\n \"yesterday\": [\n {\n \"hour\": \"\",\n \"amount\": \"\",\n \"count\": \"\"\n },\n {\n \"hour\": \"\",\n \"amount\": \"\",\n \"count\": \"\"\n }\n ]\n}"},{"id":"7acc7ae9-0298-4102-8856-541bb2b48dc9","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/dailyTransactionsSummary?date=","host":["{{baseUrl}}"],"path":["transaction","v3","dailyTransactionsSummary"],"query":[{"description":"The date to get transaction summaries for. The default start date is today's date. Format: YYYY-MM-DD","key":"date","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"f2950c2e-0c8c-48cd-a48b-8dbc535a4d2e"},{"name":"View transactions summary","id":"78f4fb48-d612-4721-aae3-5bf0429cca4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/transaction/v3/transactionsSummary?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","transactionsSummary"],"query":[{"description":"(Required) The first date to use for getting transaction summaries. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"(Required) The last date to use for getting transaction summaries. Format: YYYY-MM-DD","key":"endDate","value":""}]},"description":"Returns a summary (total transaction amount, month, and merchant ID) for the month's transactions between the specified start and end dates for each merchant account associated with the API user.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- endDate\n- startDate\n\n## Response parameters\n- amount\n- transactionDate\n- merchantId\n\n
    "},"response":[{"id":"6f47760a-5a90-4fb8-8abe-6d6f1195a10f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/transactionsSummary?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","transactionsSummary"],"query":[{"description":"(Required) The first date to use for getting transaction summaries. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"(Required) The last date to use for getting transaction summaries. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"amount\": \"\",\n \"transactionDate\": \"\",\n \"merchantId\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionDate\": \"\",\n \"merchantId\": \"\"\n }\n]"},{"id":"59789004-b7c8-40c6-8191-da837ef4cedd","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/transaction/v3/transactionsSummary?startDate=&endDate=","host":["{{baseUrl}}"],"path":["transaction","v3","transactionsSummary"],"query":[{"description":"(Required) The first date to use for getting transaction summaries. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"(Required) The last date to use for getting transaction summaries. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"78f4fb48-d612-4721-aae3-5bf0429cca4b"},{"name":"View card types","id":"0328f7a7-b7b6-4d99-932a-87af1c0d36d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/transaction/v3/paymentTypes","description":"Returns an array listing all possible card types for transactions in Nexio.\n\nSee also the [Card type (cardType)](doc:constant-transaction-values#card-type-cardtype) section of \"Constant transaction values\" in Guides.\n\n\n> πŸ“˜ Note\n> \n> It is not possible to use this endpoint to see the possible card types that your merchant account can accept. That is dependent on the [connections](doc:connections) that you have for your account. \n> \n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Response parameters\n- id\n- name\n\n
    "},"response":[{"id":"4bf9cdb8-e936-43f3-9b88-f7869664a011","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/transaction/v3/paymentTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]"},{"id":"a1d16e18-a691-4a66-b18e-d17106515868","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/transaction/v3/paymentTypes"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"0328f7a7-b7b6-4d99-932a-87af1c0d36d9"}],"id":"64b3c383-5604-448e-920e-81219f23035b","description":"APIs for transactions","_postman_id":"64b3c383-5604-448e-920e-81219f23035b"},{"name":"Decline Recovery","item":[{"name":"View recoveries","id":"cac7983c-a4ae-4fa6-bf3c-46e2e6e8fda7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/recovery/v3?limit=10&offset=0&startDate=&endDate=&recoveryStatus=","host":["{{baseUrl}}"],"path":["recovery","v3"],"query":[{"description":"Specifies the maximum number of transactions to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 transactions starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of transactions. Use it in conjunction with the `limit` parameter to control which subset of transactions the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).","key":"offset","value":"0"},{"description":"The start date. If you do not specify a value, the system uses the date 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. If you do not specify a value, the system uses today's date. Format: YYYY-MM-DD","key":"endDate","value":""},{"description":"The [recovery status](doc:constant-transaction-values#recovery-status-recoverystatus) of the transaction. Possible values: - 10: Disabled- 20: In progress- 30: Scheduled- 40: Unrecoverable- 50: Recovered","key":"recoveryStatus","value":""}]},"description":"Returns declined transactions within the given date range along with the [decline recovery](doc:constant-transaction-values#recovery-status-recoverystatus) status of each.\n\nFor additional information about this endpoint, see the [Retrieving transaction list from decline recovery](doc:retrieving-transaction-list-from-decline-recovery) tutorial.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- endDate\n- limit\n- offset\n- startDate\n- recoveryStatus\n\n## Response parameters\n- offset\n- limit\n- rows\n- rows.id\n- rows.retryDate\n- rows.transactionDate\n- rows.originalAmount\n- rows.originalDeclinePaymentId\n- rows.orderNumber\n- rows.recoveryStatus\n- rows.retryCount\n- rows.merchantId\n- rows.userName\n- rows.isEnabledForRecovery\n- rows.declineMessage\n- rows.updatedAt\n- hasMore\n\n
    "},"response":[{"id":"27d8350c-c219-488c-b19d-0593218346f3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/recovery/v3?limit=10&offset=0&startDate=&endDate=&recoveryStatus=","host":["{{baseUrl}}"],"path":["recovery","v3"],"query":[{"description":"Specifies the maximum number of transactions to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 transactions starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of transactions. Use it in conjunction with the `limit` parameter to control which subset of transactions the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).","key":"offset","value":"0"},{"description":"The start date. If you do not specify a value, the system uses the date 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. If you do not specify a value, the system uses today's date. Format: YYYY-MM-DD","key":"endDate","value":""},{"description":"The [recovery status](doc:constant-transaction-values#recovery-status-recoverystatus) of the transaction. Possible values: - 10: Disabled- 20: In progress- 30: Scheduled- 40: Unrecoverable- 50: Recovered","key":"recoveryStatus","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": \"\",\n \"limit\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"retryDate\": \"\",\n \"recoveryStatus\": \"\",\n \"retryCount\": \"\",\n \"orderNumber\": \"\",\n \"transactionDate\": \"\",\n \"userName\": \"\",\n \"isEnabledForRecovery\": \"\",\n \"originalAmount\": \"\",\n \"originalDeclinePaymentId\": \"\",\n \"declineMessage\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"retryDate\": \"\",\n \"recoveryStatus\": \"\",\n \"retryCount\": \"\",\n \"orderNumber\": \"\",\n \"transactionDate\": \"\",\n \"userName\": \"\",\n \"isEnabledForRecovery\": \"\",\n \"originalAmount\": \"\",\n \"originalDeclinePaymentId\": \"\",\n \"declineMessage\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"hasMore\": \"\"\n}"},{"id":"c9dee978-2221-4c69-87a6-1488a4ddcd28","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/recovery/v3?limit=10&offset=0&startDate=&endDate=&recoveryStatus=","host":["{{baseUrl}}"],"path":["recovery","v3"],"query":[{"description":"Specifies the maximum number of transactions to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 transactions starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of transactions. Use it in conjunction with the `limit` parameter to control which subset of transactions the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).","key":"offset","value":"0"},{"description":"The start date. If you do not specify a value, the system uses the date 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. If you do not specify a value, the system uses today's date. Format: YYYY-MM-DD","key":"endDate","value":""},{"description":"The [recovery status](doc:constant-transaction-values#recovery-status-recoverystatus) of the transaction. Possible values: - 10: Disabled- 20: In progress- 30: Scheduled- 40: Unrecoverable- 50: Recovered","key":"recoveryStatus","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"cac7983c-a4ae-4fa6-bf3c-46e2e6e8fda7"},{"name":"View a recovery","id":"04e45561-7056-4ae3-a497-615edcd2e727","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/recovery/v3/retry/:retryId","host":["{{baseUrl}}"],"path":["recovery","v3","retry",":retryId"],"variable":[{"id":"f277b3c8-7e28-429d-b5a7-247b790742af","key":"retryId","value":"","description":"(Required) The Nexio decline recovery identifier from the [webhook](doc:webhook-body-examples#decline-recovery-eventtype)."}]},"description":"Returns a single decline recovery transaction.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the retry ID in the path parameter of the request.\n\n
    \n\n## Request parameters\n- retryId\n\n## Response parameters\n- id\n- cardToken\n- retryDate\n- transactionDate\n- originalAmount\n- originalDeclinePaymentId\n- retryEngineType\n- retryProviderRefNumber\n- orderNumber\n- recoveryStatus\n- retryCount\n- merchantId\n- originalPaymentRequest\n- retryMetadata\n- userName\n- isEnabledForRecovery\n- retryProviderBody\n- declineMessage\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"9ad98456-50ba-4a90-8780-c2501c54f805","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/recovery/v3/retry/:retryId","host":["{{baseUrl}}"],"path":["recovery","v3","retry",":retryId"],"variable":[{"key":"retryId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"cardToken\": \"\",\n \"retryDate\": \"\",\n \"transactionDate\": \"\",\n \"originalAmount\": \"\",\n \"originalDeclinePaymentId\": \"\",\n \"retryEngineType\": \"\",\n \"retryProviderRefNumber\": \"\",\n \"orderNumber\": \"\",\n \"recoveryStatus\": \"\",\n \"retryCount\": \"\",\n \"merchantId\": \"\",\n \"originalPaymentRequest\": \"\",\n \"retryMetadata\": \"\",\n \"userName\": \"\",\n \"isEnabledForRecovery\": \"\",\n \"retryProviderBody\": \"\",\n \"declineMessage\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"47f09869-8ee9-4a45-a008-e566fe817248","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/recovery/v3/retry/:retryId","host":["{{baseUrl}}"],"path":["recovery","v3","retry",":retryId"],"variable":[{"key":"retryId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"04e45561-7056-4ae3-a497-615edcd2e727"},{"name":"Enable or disable retries for a single transaction","id":"49fd3a0a-b196-401f-9f9d-5332899b66e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/recovery/v3/enable","description":"Allows the merchant to enable or disable retries for a single transaction when that transaction is declined. For more information, see the [Decline recovery overview](doc:decline-recovery-overview).\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include at least the retry ID in the body of the request.\n\n
    \n\n## Request parameters\n- id\n- isEnabledForRecovery\n\n## Response parameters\n- id\n- isEnabledForRecovery\n- success\n\n
    "},"response":[{"id":"afe0942e-baf6-44f8-880b-d69e3d924d68","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/recovery/v3/enable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"isEnabledForRecovery\": \"\",\n \"success\": \"\"\n}"},{"id":"c2fe294b-9c15-4d03-b6c3-53c22e21820f","name":"Nexio could not change the status for retries, such as for a retry that is unrecoverable. Attempt the request again or check the retry status for the transaction using the [View a recovery](ref:viewrecovery) or [View recoveries](viewrecoverystatus) endpoi","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/recovery/v3/enable"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"},{"id":"23ba3856-6026-414a-8d3d-6dcfc4d659a6","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/recovery/v3/enable"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"49fd3a0a-b196-401f-9f9d-5332899b66e9"},{"name":"Enable or disable retries for multiple transactions","id":"7d52ee71-63d1-45c6-ad4e-52b8022a6f3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retries\": [\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n },\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/recovery/v3/bulkEnable","description":"Allows the merchant to enable or disable retries for multiple transactions when those transactions are declined. For more information, see the [Decline recovery overview](doc:decline-recovery-overview).\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include at minumum one or more retry IDs in an array in the body of the request.\n\n
    \n\n## Request parameters\n- retries\n- retries.id\n- retries.isEnabledForRecovery\n\n## Response parameters\n- retries\n- retries.id\n- retries.isEnabledForRecovery\n- retries.success\n\n
    "},"response":[{"id":"3af9c33e-90c6-4050-9935-74b44652c078","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"retries\": [\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n },\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/recovery/v3/bulkEnable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"retries\": [\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": \"\",\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": \"\",\n \"success\": \"\"\n }\n ]\n}"},{"id":"9cd8acd5-5af6-4ffd-812d-4a07fba9da3a","name":"Nexio could not change the status for retries, such as for a retry that is unrecoverable. Attempt the request again or check the retry status for the transaction using the [View a recovery](ref:viewrecovery) or [View recoveries](viewrecoverystatus) endpoi","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"retries\": [\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n },\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/recovery/v3/bulkEnable"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\",\n \"message\": \"\"\n}"},{"id":"11554822-b500-41c3-b83e-6cea6d21bc4b","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"retries\": [\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n },\n {\n \"id\": \"\",\n \"isEnabledForRecovery\": false\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/recovery/v3/bulkEnable"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"7d52ee71-63d1-45c6-ad4e-52b8022a6f3d"}],"id":"a3330280-3d1f-4277-9158-61cb3d1b1907","description":"APIs for decline recovery","_postman_id":"a3330280-3d1f-4277-9158-61cb3d1b1907"},{"name":"Chargebacks","item":[{"name":"View a chargeback","id":"70ce1869-7efe-4b3c-aca4-ef96ad9338c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/chargeback/v3/:id","host":["{{baseUrl}}"],"path":["chargeback","v3",":id"],"variable":[{"id":"b5223094-720a-4c9a-9f44-657aa4466d3b","key":"id","value":"","description":"(Required) The Nexio chargeback ID."}]},"description":"Returns a single chargeback record.\n\nIf you don't know the chargeback ID, use the [View chargebacks](ref:viewchargebacks) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the chargeback ID as a path parameter for the request.\n\n
    \n\n## Request parameters\n- id\n\n## Response parameters\n- id\n- relatedChargebackId\n- merchantId\n- reportDate\n- sequenceNumber\n- cardType\n- cardNumber\n- amount\n- transactionDate\n- reasonCode\n- description\n- referenceNumber\n- message\n- authCode\n- lockBoxBatch\n- cardIdentifier\n- transactionCode\n- transactionId\n- transactionRef\n- chargebackCycle\n- isDisputed\n- achId\n- achDetailsId\n- currencyId\n- createdAt\n- updatedAt\n- disputes\n- disputes.id\n- disputes.merchantId\n- disputes.chargebackId\n- disputes.createdAt\n- disputes.updatedAt\n- processor\n- processor.id\n- processor.originalId\n- processor.processorType\n- processor.originalTransactionId\n- processor.chargebackId\n- transaction\n- transaction.chargebackId\n- transaction.transactionId\n- transaction.orderNumber\n- transaction.cardHolder\n- transaction.transactionDate\n- transaction.amount\n- reason\n- reason.name\n- reason.description\n\n
    "},"response":[{"id":"079ed39f-fd3d-4bbb-bbe6-74b0858dff8a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3/:id","host":["{{baseUrl}}"],"path":["chargeback","v3",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"relatedChargebackId\": \"\",\n \"merchantId\": \"\",\n \"message\": \"\",\n \"isDisputed\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"reportDate\": \"\",\n \"amount\": \"\",\n \"lockBoxBatch\": \"\",\n \"chargebackCycle\": 2,\n \"reasonCode\": \"\",\n \"reason\": {\n \"name\": \"\",\n \"description\": \"\"\n },\n \"transactionId\": \"\",\n \"authCode\": \"\",\n \"referenceNumber\": \"\",\n \"sequenceNumber\": \"\",\n \"transactionDate\": \"\",\n \"transactionCode\": \"\",\n \"transactionRef\": \"\",\n \"currencyId\": \"\",\n \"cardNumber\": \"\",\n \"cardIdentifier\": \"\",\n \"cardType\": \"\",\n \"achId\": \"\",\n \"achDetailsId\": \"\",\n \"description\": \"\",\n \"disputes\": [\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"chargebackId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"chargebackId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"processor\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"processorType\": \"\",\n \"originalTransactionId\": \"\",\n \"chargebackId\": \"\"\n },\n \"transaction\": {\n \"chargebackId\": \"\",\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"orderNumber\": \"\",\n \"amount\": \"\",\n \"cardHolder\": \"\"\n }\n}"},{"id":"3b7c69b9-c394-4605-a0af-2c0537ad4c57","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3/:id","host":["{{baseUrl}}"],"path":["chargeback","v3",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"70ce1869-7efe-4b3c-aca4-ef96ad9338c5"},{"name":"View chargebacks","id":"f542fde1-237e-4fff-9d66-b77cee72044f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/chargeback/v3?limit=10&offset=0&startDate=&endDate=","host":["{{baseUrl}}"],"path":["chargeback","v3"],"query":[{"description":"Specifies the maximum number of chargebacks to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 chargebacks starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of chargebacks. Use it in conjunction with the `limit` parameter to control which subset of chargebacks the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 chargebacks and returns the next 20 chargebacks (in other words, chargebacks 11 to 30).","key":"offset","value":"0"},{"description":"The start date. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]},"description":"Returns all chargebacks within the given date range for all merchant IDs associated with the Nexio account used to [authenticate](doc:authentication). You may also request or filter on fields of the query parameters, as in the following example:\n\n /chargeback/v3?kount.&plugin.&customer.&processor.&gateway.\n \nSee the [query parameters](doc:filtering-using-query-parameters) section in Guides for a full tutorial.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- endDate\n- limit\n- offset\n- startDate\n\n## Response parameters\n- offset\n- limit\n- rows\n- rows.id\n- rows.relatedChargebackId\n- rows.merchantId\n- rows.reportDate\n- rows.sequenceNumber\n- rows.cardType\n- rows.cardNumber\n- rows.amount\n- rows.transactionDate\n- rows.reasonCode\n- rows.description\n- rows.referenceNumber\n- rows.message\n- rows.authCode\n- rows.lockBoxBatch\n- rows.cardIdentifier\n- rows.transactionCode\n- rows.transactionId\n- rows.transactionRef\n- rows.chargebackCycle\n- rows.isDisputed\n- rows.achId\n- rows.achDetailsId\n- rows.currencyId\n- rows.emailSentDate\n- rows.createdAt\n- rows.updatedAt\n- hasMore\n\n
    "},"response":[{"id":"5519e481-74ce-4150-a14f-5d34b4a771a4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3?limit=10&offset=0&startDate=&endDate=","host":["{{baseUrl}}"],"path":["chargeback","v3"],"query":[{"description":"Specifies the maximum number of chargebacks to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 chargebacks starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of chargebacks. Use it in conjunction with the `limit` parameter to control which subset of chargebacks the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 chargebacks and returns the next 20 chargebacks (in other words, chargebacks 11 to 30).","key":"offset","value":"0"},{"description":"The start date. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": \"\",\n \"limit\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"relatedChargebackId\": \"\",\n \"merchantId\": \"\",\n \"reportDate\": \"\",\n \"sequenceNumber\": \"\",\n \"cardType\": \"\",\n \"cardNumber\": \"\",\n \"amount\": \"\",\n \"transactionDate\": \"\",\n \"reasonCode\": \"\",\n \"description\": \"\",\n \"referenceNumber\": \"\",\n \"message\": \"\",\n \"authCode\": \"\",\n \"lockBoxBatch\": \"\",\n \"cardIdentifier\": \"\",\n \"transactionCode\": \"\",\n \"transactionId\": \"\",\n \"transactionRef\": \"\",\n \"chargebackCycle\": 3,\n \"isDisputed\": \"\",\n \"achId\": \"\",\n \"achDetailsId\": \"\",\n \"currencyId\": 840,\n \"emailSentDate\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedChargebackId\": \"\",\n \"merchantId\": \"\",\n \"reportDate\": \"\",\n \"sequenceNumber\": \"\",\n \"cardType\": \"\",\n \"cardNumber\": \"\",\n \"amount\": \"\",\n \"transactionDate\": \"\",\n \"reasonCode\": \"\",\n \"description\": \"\",\n \"referenceNumber\": \"\",\n \"message\": \"\",\n \"authCode\": \"\",\n \"lockBoxBatch\": \"\",\n \"cardIdentifier\": \"\",\n \"transactionCode\": \"\",\n \"transactionId\": \"\",\n \"transactionRef\": \"\",\n \"chargebackCycle\": 0,\n \"isDisputed\": \"\",\n \"achId\": \"\",\n \"achDetailsId\": \"\",\n \"currencyId\": 840,\n \"emailSentDate\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"hasMore\": \"\"\n}"},{"id":"27a40cdb-0d85-44da-952d-eb7e6000047c","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3?limit=10&offset=0&startDate=&endDate=","host":["{{baseUrl}}"],"path":["chargeback","v3"],"query":[{"description":"Specifies the maximum number of chargebacks to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 chargebacks starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of chargebacks. Use it in conjunction with the `limit` parameter to control which subset of chargebacks the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 chargebacks and returns the next 20 chargebacks (in other words, chargebacks 11 to 30).","key":"offset","value":"0"},{"description":"The start date. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"f542fde1-237e-4fff-9d66-b77cee72044f"},{"name":"View chargeback summary","id":"3d803c99-15f4-486c-b8ed-bd6d7f9b2d0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/chargeback/v3/summary?startDate=&endDate=","host":["{{baseUrl}}"],"path":["chargeback","v3","summary"],"query":[{"description":"The start date. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]},"description":"Returns a summary of all chargebacks within the default or specified date range.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n
    \n\n## Request parameters\n- endDate\n- startDate\n\n## Response parameters\n- newChargebacksCount\n- newChargebacksTotal\n- wonChargebacksCount\n- wonChargebacksTotal\n- representmentsCount\n- representmentsTotal\n\n
    "},"response":[{"id":"a11a4c0a-36c3-4a9d-963a-7987e20d64fc","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3/summary?startDate=&endDate=","host":["{{baseUrl}}"],"path":["chargeback","v3","summary"],"query":[{"description":"The start date. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"newChargebacksCount\": \"\",\n \"newChargebacksTotal\": \"\",\n \"wonChargebacksCount\": \"\",\n \"wonChargebacksTotal\": \"\",\n \"representmentsCount\": \"\",\n \"representmentsTotal\": \"\"\n}"},{"id":"3d15233f-50d0-45d8-b9b0-f7a6ce6f0fac","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3/summary?startDate=&endDate=","host":["{{baseUrl}}"],"path":["chargeback","v3","summary"],"query":[{"description":"The start date. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD","key":"startDate","value":""},{"description":"The end date. The default end date is today's date. Format: YYYY-MM-DD","key":"endDate","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"3d803c99-15f4-486c-b8ed-bd6d7f9b2d0a"},{"name":"View a dispute","id":"6bf4d7f5-2163-4e7e-b660-558eb061ad93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/chargeback/v3/dispute/:id","host":["{{baseUrl}}"],"path":["chargeback","v3","dispute",":id"],"variable":[{"id":"57e652a8-12fc-419b-a3a8-17088d41e48d","key":"id","value":"","description":"(Required) The dispute ID."}]},"description":"Returns information about a disputed chargeback.\n\nIf you don't know the dispute ID, use the [View disputes](ref:viewdisputes) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include the chargeback ID as a path parameter for the request.\n\n
    \n\n## Request parameters\n- id\n\n## Response parameters\n- id\n- merchantId\n- chargebackId\n- createdAt\n- updatedAt\n\n
    "},"response":[{"id":"ba4bef82-a7f2-4d56-aac6-679585edc346","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3/dispute/:id","host":["{{baseUrl}}"],"path":["chargeback","v3","dispute",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"chargebackId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}"},{"id":"878fc8ba-5298-4493-9982-c876a4681480","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3/dispute/:id","host":["{{baseUrl}}"],"path":["chargeback","v3","dispute",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"6bf4d7f5-2163-4e7e-b660-558eb061ad93"},{"name":"Dispute a chargeback","id":"70dc68be-972b-472f-928d-52872d684c99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"chargebackId\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"images\": [\n {\n \"name\": \"\",\n \"data\": \"\"\n },\n {\n \"name\": \"\",\n \"data\": \"\"\n }\n ],\n \"isPreview\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/chargeback/v3/dispute","description":"Flags a chargeback as disputed. You may include additional information if wanted. \n\n\n> πŸ“˜ Note\n> \n> By submitting a chargeback dispute via the Nexio API you agree to the following: \n> \"I agree that I am not including sensitive information. Sensitive information includes: full credit or debit card numbers, credit or debit card security codes (CVV/CVC), social security numbers, driver's license numbers, health records, and so forth.\"

    Your dispute will be rejected if you include sensitive information.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).

    Include at least the chargeback ID and a Nexio account username.\n\n
    \n\n## Request parameters\n- chargebackId\n- userName\n- description\n- images\n- images.name\n- images.data\n- isPreview\n\n## Response parameters\n- message\n\n
    "},"response":[{"id":"6c92ee1f-88f9-4904-b803-51efddb079d5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"chargebackId\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"images\": [\n {\n \"name\": \"\",\n \"data\": \"\"\n },\n {\n \"name\": \"\",\n \"data\": \"\"\n }\n ],\n \"isPreview\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/chargeback/v3/dispute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"8407e881-882c-48b8-a713-5e9eae537339","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"chargebackId\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"images\": [\n {\n \"name\": \"\",\n \"data\": \"\"\n },\n {\n \"name\": \"\",\n \"data\": \"\"\n }\n ],\n \"isPreview\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/chargeback/v3/dispute"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"70dc68be-972b-472f-928d-52872d684c99"},{"name":"View disputes","id":"7f3f35e7-1342-40ed-9800-e4b0c6e19645","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/chargeback/v3/dispute?limit=10&offset=0","host":["{{baseUrl}}"],"path":["chargeback","v3","dispute"],"query":[{"description":"Specifies the maximum number of disputed chargebacks to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 disputed chargebacks starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of disputed chargebacks. Use it in conjunction with the `limit` parameter to control which subset of disputed chargebacks the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 disputed chargebacks and returns the next 20 disputed chargebacks (in other words, disputed chargebacks 11 to 30).","key":"offset","value":"0"}]},"description":"Returns summary information for one or more disputed chargebacks.\n\n\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- limit\n- offset\n\n## Response parameters\n- count\n- rows\n- rows.id\n- rows.merchantId\n- rows.chargebackId\n- rows.createdAt\n- rows.updatedAt\n- limit\n\n
    "},"response":[{"id":"b8ec119d-621d-4b2a-bdd4-1c82df39d48c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3/dispute?limit=10&offset=0","host":["{{baseUrl}}"],"path":["chargeback","v3","dispute"],"query":[{"description":"Specifies the maximum number of disputed chargebacks to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 disputed chargebacks starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of disputed chargebacks. Use it in conjunction with the `limit` parameter to control which subset of disputed chargebacks the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 disputed chargebacks and returns the next 20 disputed chargebacks (in other words, disputed chargebacks 11 to 30).","key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"chargebackId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"chargebackId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"limit\": \"\"\n}"},{"id":"02f31615-e6b7-4081-a734-b408c1c7e111","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/chargeback/v3/dispute?limit=10&offset=0","host":["{{baseUrl}}"],"path":["chargeback","v3","dispute"],"query":[{"description":"Specifies the maximum number of disputed chargebacks to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 disputed chargebacks starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of disputed chargebacks. Use it in conjunction with the `limit` parameter to control which subset of disputed chargebacks the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 disputed chargebacks and returns the next 20 disputed chargebacks (in other words, disputed chargebacks 11 to 30).","key":"offset","value":"0"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"7f3f35e7-1342-40ed-9800-e4b0c6e19645"}],"id":"93c8b69c-90ff-41b0-a513-a6f7148526ae","description":"APIs for chargebacks","_postman_id":"93c8b69c-90ff-41b0-a513-a6f7148526ae"},{"name":"Deposits","item":[{"name":"View deposit summary","id":"9e94c5c8-cc20-4b6a-b5c9-ae6350f6a69d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/ach/v3?limit=10&offset=0&startDate=&endDate=&merchantIds=","host":["{{baseUrl}}"],"path":["ach","v3"],"query":[{"description":"Specifies the maximum number of deposit summaries to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 deposit summaries starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of deposit summaries. Use it in conjunction with the `limit` parameter to control which subset of deposit summaries the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 deposit summaries and returns the next 20 deposit summaries (in other words, deposit summaries 11 to 30).","key":"offset","value":"0"},{"description":"The start date. Format: YYYY-MM-DD. The default is 30 days prior to today's date.","key":"startDate","value":""},{"description":"The end date. Format: YYYY-MM-DD. The default is today's date.","key":"endDate","value":""},{"description":"A comma-separated list of merchant IDs.","key":"merchantIds","value":""}]},"description":"Returns a summary of all deposits with the given range for the specified merchant ID or IDs, or for all merchant accounts associated with the API user.\r\n\r\nYou send the request with zero of more of the query parameters to limit the results as in the following example:\r\n\r\n /ach/v3?limit=25&offest=0&startDate=2024-02-01&endDate=2024-02-08&merchantids=000999\r\n\r\nSee the [Filtering using query parameters](doc:filtering-using-query-parameters) topic in Guides for a full tutorial. Note that if you do not include a parameter for this endpoint, the system uses the default value for the request.\r\n\r\nFor the response, the amounts presented may be different than what was authorized, as the funds may not have settled yet. Amounts being processed may differ temporarily from batch totals if they experience a temporary risk hold; common reasons include large single transactions, unusual activity, or unexpected volume increases. Check the batch details in a few days after it's finalized.\r\n\r\n\r\n> ⚠️ Try It\r\n> \r\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\r\n\r\n\r\n
    \r\n\r\n## Request parameters\r\n- limit\r\n- offset\r\n- startDate\r\n- endDate\r\n- merchantIds\r\n\r\n## Response parameters\r\n- offset\r\n- limit\r\n- rows (array)\r\n- rows.id\r\n- rows.merchantId\r\n- rows.date\r\n- rows.dda\r\n- rows.amount\r\n- rows.currencyId\r\n- rows.createdAt\r\n- rows.updatedAt\r\n- rows.processor\r\n- rows.processor.id\r\n- rows.processor.originalId\r\n- rows.processor.processorType\r\n- rows.details (array)\r\n- rows.details.achDetailId\r\n- rows.details.type\r\n- rows.details.thirdPartyFundedAmount\r\n- rows.details.amount\r\n- rows.details.currencyId\r\n- rows.details.achSummaryId\r\n- rows.details.processor\r\n- rows.details.processor.id\r\n- rows.details.processor.originalId\r\n- rows.details.processor.processorType\r\n- rows.details.processor.batchRef\r\n- rows.details.processor.achDetailId\r\n- hasMore\r\n\r\n
    "},"response":[{"id":"54960fdb-63b9-4056-8ec4-7a1d40703c7a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/ach/v3?limit=10&offset=0&startDate=&endDate=&merchantIds=","host":["{{baseUrl}}"],"path":["ach","v3"],"query":[{"description":"Specifies the maximum number of deposit summaries to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 deposit summaries starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of deposit summaries. Use it in conjunction with the `limit` parameter to control which subset of deposit summaries the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 deposit summaries and returns the next 20 deposit summaries (in other words, deposit summaries 11 to 30).","key":"offset","value":"0"},{"description":"The start date. Format: YYYY-MM-DD. The default is 30 days prior to today's date.","key":"startDate","value":""},{"description":"The end date. Format: YYYY-MM-DD. The default is today's date.","key":"endDate","value":""},{"description":"A comma-separated list of merchant IDs.","key":"merchantIds","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": \"\",\n \"limit\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"date\": \"\",\n \"dda\": \"\",\n \"amount\": \"\",\n \"currencyId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"processor\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"processorType\": \"\"\n },\n \"details\": [\n {\n \"achDetailId\": \"\",\n \"type\": \"\",\n \"thirdPartyFundedAmount\": \"\",\n \"amount\": \"\",\n \"currencyId\": 840,\n \"achSummaryId\": \"\",\n \"processor\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"processorType\": \"\",\n \"batchRef\": \"\",\n \"achDetailId\": \"\"\n }\n },\n {\n \"achDetailId\": \"\",\n \"type\": \"\",\n \"thirdPartyFundedAmount\": \"\",\n \"amount\": \"\",\n \"currencyId\": 840,\n \"achSummaryId\": \"\",\n \"processor\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"processorType\": \"\",\n \"batchRef\": \"\",\n \"achDetailId\": \"\"\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"date\": \"\",\n \"dda\": \"\",\n \"amount\": \"\",\n \"currencyId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"processor\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"processorType\": \"\"\n },\n \"details\": [\n {\n \"achDetailId\": \"\",\n \"type\": \"\",\n \"thirdPartyFundedAmount\": \"\",\n \"amount\": \"\",\n \"currencyId\": 840,\n \"achSummaryId\": \"\",\n \"processor\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"processorType\": \"\",\n \"batchRef\": \"\",\n \"achDetailId\": \"\"\n }\n },\n {\n \"achDetailId\": \"\",\n \"type\": \"\",\n \"thirdPartyFundedAmount\": \"\",\n \"amount\": \"\",\n \"currencyId\": 840,\n \"achSummaryId\": \"\",\n \"processor\": {\n \"id\": \"\",\n \"originalId\": \"\",\n \"processorType\": \"\",\n \"batchRef\": \"\",\n \"achDetailId\": \"\"\n }\n }\n ]\n }\n ],\n \"hasMore\": \"\"\n}"},{"id":"9e246c2a-fcb1-428f-a762-833b7e200973","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/ach/v3?limit=10&offset=0&startDate=&endDate=&merchantIds=","host":["{{baseUrl}}"],"path":["ach","v3"],"query":[{"description":"Specifies the maximum number of deposit summaries to return in a single API response. For example, if you set `limit=20`, the API returns up to 20 deposit summaries starting from the position specified by the `offset` parameter.","key":"limit","value":"10"},{"description":"Specifies the starting point within the list of deposit summaries. Use it in conjunction with the `limit` parameter to control which subset of deposit summaries the API returns. For example, if you set `offset=10` and `limit=20`, the API skips the first 10 deposit summaries and returns the next 20 deposit summaries (in other words, deposit summaries 11 to 30).","key":"offset","value":"0"},{"description":"The start date. Format: YYYY-MM-DD. The default is 30 days prior to today's date.","key":"startDate","value":""},{"description":"The end date. Format: YYYY-MM-DD. The default is today's date.","key":"endDate","value":""},{"description":"A comma-separated list of merchant IDs.","key":"merchantIds","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"9e94c5c8-cc20-4b6a-b5c9-ae6350f6a69d"}],"id":"dbaca89a-cb41-4f3f-bd22-a43c87e93f5a","description":"APIs for deposits","_postman_id":"dbaca89a-cb41-4f3f-bd22-a43c87e93f5a"},{"name":"Statements and Adjustments","item":[],"id":"f5ef2549-906e-4081-b83a-1230e76e8675","description":"APIS for statements and adjustments","_postman_id":"f5ef2549-906e-4081-b83a-1230e76e8675"},{"name":"PDF Reports","item":[],"id":"8fbb4542-2dc8-42c2-b9b0-e93abcad2c5f","description":"APIs for PDF reports","_postman_id":"8fbb4542-2dc8-42c2-b9b0-e93abcad2c5f"},{"name":"User Management","item":[{"name":"Who am I","id":"5ca9579e-c677-418b-bbc9-b5686dab46be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/user/v3/account/whoAmI","description":"Returns basic user information for the account used to authenticate the request. \n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Response parameters\n- userName\n- cognitoSub\n- accountType\n- enabled\n- firstName\n- lastName\n- phone\n- address1\n- address2\n- city\n- state\n- postalCode\n- country\n- businessLegalName\n- billingContactFullName\n- billingContactPhone\n- billingContactEmail\n- isApiUser\n- isEnabledForCybersourceAccountUpdater\n- isEnabledForAccountUpdater\n- accessRights\n- accessRights.merchantIds\n- accessRights.role\n- payoutAccessRights\n- loginInfo\n- loginInfo.count\n- loginInfo.lastLogin\n- notifications\n- notifications.chargebacks\n- notifications.largeExports\n- notifications.fraud\n- notifications.payoutBatches\n- role\n- isEnabledAuthorizedStatus\n- isEnabledForVTerm\n- accountId\n- shouldShowPlatformAgreement\n- shouldShowPricingAgreement\n- dateCreated\n- dateLastModified\n\n
    "},"response":[{"id":"def0b08d-3b95-442a-8fb8-7a5a0cffd21f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/user/v3/account/whoAmI"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"\",\n \"userName\": \"\",\n \"accountType\": \"\",\n \"enabled\": true,\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"businessLegalName\": \"\",\n \"billingContactFullName\": \"\",\n \"billingContactPhone\": \"\",\n \"billingContactEmail\": \"\",\n \"isApiUser\": true,\n \"isEnabledAuthorizedStatus\": false,\n \"isEnabledForCybersourceAccountUpdater\": false,\n \"isEnabledForAccountUpdater\": false,\n \"accessRights\": {\n \"merchantIds\": {\n \"[merchant ID]\": \"\"\n },\n \"role\": \"\"\n },\n \"payoutAccessRights\": {\n \"[payout account ID]\": \"\"\n },\n \"loginInfo\": {\n \"count\": \"\",\n \"lastLogin\": \"\"\n },\n \"notifications\": {\n \"chargebacks\": true,\n \"largeExports\": true,\n \"fraud\": true,\n \"payoutBatches\": true\n },\n \"role\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"cognitoSub\": \"\",\n \"isEnabledForVTerm\": \"\",\n \"shouldShowPlatformAgreement\": \"\",\n \"shouldShowPricingAgreement\": \"\"\n}"},{"id":"c7159eee-8413-4eab-8262-b8f7829a33db","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":"{{baseUrl}}/user/v3/account/whoAmI"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"5ca9579e-c677-418b-bbc9-b5686dab46be"},{"name":"Update self","id":"f2f995b6-b73d-4599-80d1-3871fcab0137","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"notifications\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/self","description":"Updates user information.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- firstName\n- lastName\n- phone\n- notifications\n\n## Response parameters\n- userName\n- firstName\n- lastName\n- phone\n- enabled\n- notifications\n- accessRights\n- accessRights.merchantIds\n- accessRights.role\n- accountId\n- role\n- customAccess\n- cognitoSub\n- isEnabledForVTerm\n- shouldShowPlatformAgreement\n- shouldShowPricingAgreement\n- dateCreated\n- dateLastModified\n\n
    "},"response":[{"id":"ac6a3d58-0690-4faa-88d3-d55e50756fe8","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"notifications\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/self"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"\",\n \"userName\": \"\",\n \"accountType\": \"\",\n \"enabled\": true,\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"businessLegalName\": \"\",\n \"billingContactFullName\": \"\",\n \"billingContactPhone\": \"\",\n \"billingContactEmail\": \"\",\n \"isApiUser\": true,\n \"isEnabledAuthorizedStatus\": false,\n \"isEnabledForCybersourceAccountUpdater\": false,\n \"isEnabledForAccountUpdater\": false,\n \"accessRights\": {\n \"merchantIds\": {\n \"[merchant ID]\": \"\"\n },\n \"role\": \"\"\n },\n \"payoutAccessRights\": {\n \"[payout account ID]\": \"\"\n },\n \"loginInfo\": {\n \"count\": \"\",\n \"lastLogin\": \"\"\n },\n \"notifications\": {\n \"chargebacks\": true,\n \"largeExports\": true,\n \"fraud\": true,\n \"payoutBatches\": true\n },\n \"role\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\",\n \"cognitoSub\": \"\",\n \"isEnabledForVTerm\": \"\",\n \"shouldShowPlatformAgreement\": \"\",\n \"shouldShowPricingAgreement\": \"\"\n}"},{"id":"e212f757-d1b7-4b3f-90a4-8842693c74a3","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"notifications\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/self"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"f2f995b6-b73d-4599-80d1-3871fcab0137"},{"name":"Create user","id":"b4f4946e-f6f9-4cd0-92bb-9d5af5e84ec7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"role\": \"W\",\n \"merchantIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/account/emvioUser","description":"Creates a new user.\n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n> \n> Include at least the email address and value for the role of this new user.\n\n
    \n\n## Request parameters\n- email\n- role\n-merchantIds\n\n## Response parameters\n- message\n\n
    "},"response":[{"id":"a3ae0b7c-0d75-46fe-9eea-78582eefb69d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"role\": \"W\",\n \"merchantIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/account/emvioUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"userName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"enabled\": true,\n \"accessRights\": {\n \"merchantIds\": {\n \"[merchant ID]\": \"\"\n },\n \"role\": \"A\"\n },\n \"role\": \"\",\n \"cognitoSub\": \"\",\n \"isEnabledForVTerm\": \"\",\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\"\n}"},{"id":"b6cc7a17-dd01-45e3-a776-b2583724eeb3","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"role\": \"W\",\n \"merchantIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/account/emvioUser"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"b4f4946e-f6f9-4cd0-92bb-9d5af5e84ec7"},{"name":"Refresh credentials","id":"6af061c2-0c61-479e-be07-7b131e3e0c74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refreshToken\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/account/refresh","description":"Refreshes your credentials.\n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n> \n> Include the `refreshToken` from the [View credentials](ref:viewcredentials) endpoint.\n\n
    \n\n## Request parameters\n- refreshToken\n\n## Response parameters\n- idToken\n- accessToken\n- refreshToken\n- expiresIn\n\n
    "},"response":[{"id":"ef857fb7-6e82-43de-ab98-1bc443912312","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"refreshToken\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/account/refresh"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"idToken\": \"\",\n \"accessToken\": \"\",\n \"refreshToken\": \"\",\n \"expiresIn\": \"\"\n}"},{"id":"1a196e46-528e-48ad-bce0-a08fb330ad0f","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"refreshToken\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/account/refresh"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"6af061c2-0c61-479e-be07-7b131e3e0c74"},{"name":"View credentials","id":"41271501-6a5e-4c87-bd9a-55469fc7d22e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/login","description":"Retrieves authentication credentials based on username and password.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- username\n- password\n\n## Response parameters\n- idToken\n- accessToken\n- refreshToken\n- expiresIn\n\n
    "},"response":[{"id":"e8876c20-e991-4b34-ab78-6ecf4a8f495d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"idToken\": \"\",\n \"accessToken\": \"\",\n \"refreshToken\": \"\",\n \"expiresIn\": \"\"\n}"},{"id":"a3da9d4b-3b7c-43d9-95aa-81e8df168001","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/user/v3/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"41271501-6a5e-4c87-bd9a-55469fc7d22e"},{"name":"View merchants by ID","id":"debc84b9-fde2-40b6-b896-acc47b04896b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/merchant/v3?merchantIds=","host":["{{baseUrl}}"],"path":["merchant","v3"],"query":[{"description":"A comma-separated list of the merchant IDs to view information for. If the API user does not have access to the specified merchant ID, the response returns as successful (200) but does not include that merchant information in the response. To return all applicable merchant IDs for the API user, leave the parameter empty or do not include this as a query parameter in the request.","key":"merchantIds","value":""}]},"description":"Returns an array with information for one or more merchant accounts associated with the API user. \n\nTo view the complete list of merchant accounts assigned to the API user, do not include any merchant IDs in the request.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- merchantIds\n\n## Response parameters\n- merchantId\n- name\n- currencyId\n- isPaymentConfigured\n- isPaymentRecoveryConfigured\n- processor\n- processor.id\n- kountMerc\n- kount\n- kount.id\n- kount.merc\n- kount.merchantId\n- isApmConfigured\n- hasAuthorizeNetApmCreds\n- createdAt\n- updatedAt\n\n
    \n"},"response":[{"id":"5a3fc45b-a9f9-4dc0-b205-b43006620bf7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/merchant/v3?merchantIds=","host":["{{baseUrl}}"],"path":["merchant","v3"],"query":[{"description":"A comma-separated list of the merchant IDs to view information for. If the API user does not have access to the specified merchant ID, the response returns as successful (200) but does not include that merchant information in the response. To return all applicable merchant IDs for the API user, leave the parameter empty or do not include this as a query parameter in the request.","key":"merchantIds","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"merchantId\": \"\",\n \"name\": \"\",\n \"currencyId\": \"\",\n \"isPaymentConfigured\": \"\",\n \"isPaymentRecoveryConfigured\": \"\",\n \"processor\": {\n \"id\": \"\"\n },\n \"kountMerc\": \"\",\n \"kount\": {\n \"id\": \"\",\n \"merc\": \"\",\n \"merchantId\": \"\"\n },\n \"isApmConfigured\": \"\",\n \"hasAuthorizeNetApmCreds\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"merchantId\": \"\",\n \"name\": \"\",\n \"currencyId\": \"\",\n \"isPaymentConfigured\": \"\",\n \"isPaymentRecoveryConfigured\": \"\",\n \"processor\": {\n \"id\": \"\"\n },\n \"kountMerc\": \"\",\n \"kount\": {\n \"id\": \"\",\n \"merc\": \"\",\n \"merchantId\": \"\"\n },\n \"isApmConfigured\": \"\",\n \"hasAuthorizeNetApmCreds\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n]"},{"id":"27422c05-66b1-48fd-b7e1-53fde8055b56","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/merchant/v3?merchantIds=","host":["{{baseUrl}}"],"path":["merchant","v3"],"query":[{"description":"A comma-separated list of the merchant IDs to view information for. If the API user does not have access to the specified merchant ID, the response returns as successful (200) but does not include that merchant information in the response. To return all applicable merchant IDs for the API user, leave the parameter empty or do not include this as a query parameter in the request.","key":"merchantIds","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"debc84b9-fde2-40b6-b896-acc47b04896b"}],"id":"944ec19c-9e47-48e2-9202-dcabef7a321e","description":"APIs for user management","_postman_id":"944ec19c-9e47-48e2-9202-dcabef7a321e"},{"name":"Merchant Service","item":[{"name":"View merchants by ID","id":"770c7fd6-22b7-4dc7-99ff-1e32a598f71b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/merchant/v3?merchantIds=","host":["{{baseUrl}}"],"path":["merchant","v3"],"query":[{"description":"A comma-separated list of the merchant IDs to view information for. If the API user does not have access to the specified merchant ID, the response returns as successful (200) but does not include that merchant information in the response. To return all applicable merchant IDs for the API user, leave the parameter empty or do not include this as a query parameter in the request.","key":"merchantIds","value":""}]},"description":"Returns an array with information for one or more merchant accounts associated with the API user. \n\nTo view the complete list of merchant accounts assigned to the API user, do not include any merchant IDs in the request.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- merchantIds\n\n## Response parameters\n- merchantId\n- name\n- currencyId\n- isPaymentConfigured\n- isPaymentRecoveryConfigured\n- processor\n- processor.id\n- kountMerc\n- kount\n- kount.id\n- kount.merc\n- kount.merchantId\n- isApmConfigured\n- hasAuthorizeNetApmCreds\n- createdAt\n- updatedAt\n\n
    \n"},"response":[{"id":"f6b80ceb-4567-4f8e-9f50-089c362aadb1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/merchant/v3?merchantIds=","host":["{{baseUrl}}"],"path":["merchant","v3"],"query":[{"description":"A comma-separated list of the merchant IDs to view information for. If the API user does not have access to the specified merchant ID, the response returns as successful (200) but does not include that merchant information in the response. To return all applicable merchant IDs for the API user, leave the parameter empty or do not include this as a query parameter in the request.","key":"merchantIds","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"merchantId\": \"\",\n \"name\": \"\",\n \"currencyId\": \"\",\n \"isPaymentConfigured\": \"\",\n \"isPaymentRecoveryConfigured\": \"\",\n \"processor\": {\n \"id\": \"\"\n },\n \"kountMerc\": \"\",\n \"kount\": {\n \"id\": \"\",\n \"merc\": \"\",\n \"merchantId\": \"\"\n },\n \"isApmConfigured\": \"\",\n \"hasAuthorizeNetApmCreds\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"merchantId\": \"\",\n \"name\": \"\",\n \"currencyId\": \"\",\n \"isPaymentConfigured\": \"\",\n \"isPaymentRecoveryConfigured\": \"\",\n \"processor\": {\n \"id\": \"\"\n },\n \"kountMerc\": \"\",\n \"kount\": {\n \"id\": \"\",\n \"merc\": \"\",\n \"merchantId\": \"\"\n },\n \"isApmConfigured\": \"\",\n \"hasAuthorizeNetApmCreds\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n]"},{"id":"ccc755c9-430d-4f45-adc6-33f3f61aa935","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/merchant/v3?merchantIds=","host":["{{baseUrl}}"],"path":["merchant","v3"],"query":[{"description":"A comma-separated list of the merchant IDs to view information for. If the API user does not have access to the specified merchant ID, the response returns as successful (200) but does not include that merchant information in the response. To return all applicable merchant IDs for the API user, leave the parameter empty or do not include this as a query parameter in the request.","key":"merchantIds","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"770c7fd6-22b7-4dc7-99ff-1e32a598f71b"}],"id":"8569579c-285a-4bf7-90ed-531caae9d93e","description":"APIs for merchant service management","_postman_id":"8569579c-285a-4bf7-90ed-531caae9d93e"},{"name":"Webhook Service","item":[{"name":"Register webhook URLs","id":"ac957e44-c1a8-4546-988e-9640d7080189","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"webhookUrls\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/webhookUrls","description":"**New webhook workflow**\n\nRegisters webhooks for a specific merchant ID or payout account ID. These webhooks are callbacks for transactions, payouts, or spendbacks. \n\n- Each webhook for a merchant ID receives the same information for all transaction events. \n- Each webhook for a payout account ID receives the same information for all payout and spendback events.\n\nYou can create multiple webhooks for the same merchant ID or payout account ID. This is useful for situations where you have multiple workflows from a single event, such as when you need to send the information to two different internal departments but they need to do different things with the same information.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n> πŸ›‘ Important \n> \n> Nexio supports only either the legacy webhooks or these new ones. Before configuring URLs for your webhooks, ensure that you do not have any URLs for legacy ones configured: [View legacy merchant webhook configuration](ref:viewmerchantwebhookconfiguration).\n\n\n
    \n\n## Request parameters\n- merchantId\n- webhookUrls \n- payoutAccountId\n- accountId\n\n## Response parameters\n- merchantId\n- payoutAccountId\n- accountId\n- webhookUrls\n- dateCreated\n- dateLastModified\n\n
    \n\n## Next steps\n* If needed, whitelist the IP addresses that send the webhooks. You can find the list for both sandbox and production environments at [https://ip-ranges.nex.io/ip-ranges.json](https://ip-ranges.nex.io/ip-ranges.json).\n* [Retrieve a list of webhook URLs](ref:viewwebhookurlsbyidandtype) that are registered for a merchant ID or payout account ID.\n* For a tutorial on how to register and use webhooks, see [Webhooks](doc:webhooks) in Guides.\n\nFor the legacy method for creating webhooks, see the [Create legacy merchant webhooks](ref:createmerchantwebhooks) endpoint.\n"},"response":[{"id":"84678db6-eb3b-4a8b-b7a2-1b6d210647ca","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"webhookUrls\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/webhookUrls"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantId\": \"\",\n \"payoutAccountId\": \"\",\n \"accountId\": \"\",\n \"webhookUrls\": [\n \"\",\n \"\"\n ],\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\"\n}"},{"id":"0052cc5a-910c-4d42-a68e-94038b19c8b3","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"webhookUrls\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/webhookUrls"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"ac957e44-c1a8-4546-988e-9640d7080189"},{"name":"View webhook URLs by ID and type","id":"1769a0ba-0a0b-4115-bba8-c942d3cc1379","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/webhook/v3/webhookUrls/:id/:webhook_type","host":["{{baseUrl}}"],"path":["webhook","v3","webhookUrls",":id",":webhook_type"],"variable":[{"id":"0019d547-50d6-4e3b-ba2c-76e74a6f0345","key":"id","value":"","description":"(Required) The merchant ID, payout account ID, or Nexio account ID."},{"id":"64a3d035-4f27-4c65-9bff-5d2cd89cad87","key":"webhook_type","value":"","description":"(Required) The webhook type. Specify `MERCHANT`, `PAYOUT_ACCOUNT`, or `ACCOUNT`."}]},"description":"**Simplified webhook workflow**\n\nReturns the registered webhook URLs for the specified ID and webhook type.\n\nThe ID can be either a merchant ID, payout account ID, or reseller Nexio account ID. The webhook type needs to match the ID.\n\nFor a tutorial on how to register and use webhooks, see [Webhooks](doc:webhooks) in Guides.\n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- id\n- webhook_type\n\n## Response parameters\n- merchantId\n- payoutAccountId\n- accountId\n- webhookUrls\n- dateCreated\n- dateLastModified\n\n
    "},"response":[{"id":"a78b5a0e-49ef-4e06-9746-3f3b21984606","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/webhook/v3/webhookUrls/:id/:webhook_type","host":["{{baseUrl}}"],"path":["webhook","v3","webhookUrls",":id",":webhook_type"],"variable":[{"key":"id"},{"key":"webhook_type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantId\": \"\",\n \"payoutAccountId\": \"\",\n \"accountId\": \"\",\n \"webhookUrls\": [\n \"\",\n \"\"\n ],\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\"\n}"},{"id":"e92b8cc8-d118-4a97-812d-4f8e3716960b","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/webhook/v3/webhookUrls/:id/:webhook_type","host":["{{baseUrl}}"],"path":["webhook","v3","webhookUrls",":id",":webhook_type"],"variable":[{"key":"id"},{"key":"webhook_type"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"1769a0ba-0a0b-4115-bba8-c942d3cc1379"},{"name":"Create legacy merchant webhooks","id":"3c0e92b4-507d-4930-b90d-57a725aa5551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"webhooks\": {\n \"ACCOUNT_UPDATER_ACCOUNT_CLOSED\": {\n \"url\": \"\"\n },\n \"ACCOUNT_UPDATER_CONTACT_CARDHOLDER\": {\n \"url\": \"\"\n },\n \"CARD_DATA_UPDATED\": {\n \"url\": \"\"\n },\n \"CARD_SAVED\": {\n \"url\": \"\"\n },\n \"ECHECK_SAVED\": {\n \"url\": \"\"\n },\n \"SUBSCRIPTION_DETAILS\": {\n \"url\": \"\"\n },\n \"TRANSACTION_AUTHORIZED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_CAPTURED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_PENDING\": {\n \"url\": \"\"\n },\n \"TRANSACTION_REFUNDED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_SETTLED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_VOIDED\": {\n \"url\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/config","description":"Configures webhooks using the legacy workflow, including the URLs a merchant's webhooks are sent to and the event types which trigger webhooks.\n\nIf you need to whitelist the IP addresses that send the webhooks, you can find the list for both sandbox and production environments at [https://ip-ranges.nex.io/ip-ranges.json](https://ip-ranges.nex.io/ip-ranges.json).\n\nFor a tutorial about configuring and using webhooks, see [Configuring webhooks](doc:configuring-legacy-webhooks) in Guides.\n\n\n> πŸ“˜ Note\n> \n> For the current workflow, see the [Register webhook URLs](ref:registerwebhookurls) endpoint instead.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n\n> πŸ›‘ Important \n> \n> Nexio supports only either the new webhooks or these legacy ones. Before configuring URLs for legacy webhooks, ensure that you do not have any URLS for the new ones configured: [View webhook URLs by ID and type](ref:viewwebhookurlsbyidandtype).\n> \n> If you need to remove one or more (or all) legacy webhooks, use this endpoint, but send an empty `webhooks` object to remove all or, to remove just one, send all current configured webhooks minus the object that corresponds to the event type for the webhook you want to remove. For additional information, see [Deregistering legacy webhooks](doc:) in Guides.\n\n\n
    \n\n## Request parameters\n- merchantId\n- payoutAccountId\n- webhooks\n- webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED\n- webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED.url\n- webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER\n- webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER.url\n- webhooks.CARD_DATA_UPDATED\n- webhooks.CARD_DATA_UPDATED.url\n- webhooks.CARD_SAVED\n- webhooks.CARD_SAVED.url\n- webhooks.ECHECK_SAVED\n- webhooks.ECHECK_SAVED.url\n- webhooks.SUBSCRIPTION_DETAILS\n- webhooks.SUBSCRIPTION_DETAILS.url\n- webhooks.TRANSACTION_AUTHORIZED\n- webhooks.TRANSACTION_AUTHORIZED.url\n- webhooks.TRANSACTION_CAPTURED\n- webhooks.TRANSACTION_CAPTURED.url\n- webhooks.TRANSACTION_PENDING\n- webhooks.TRANSACTION_PENDING.url\n- webhooks.TRANSACTION_REFUNDED\n- webhooks.TRANSACTION_REFUNDED.url\n- webhooks.TRANSACTION_SETTLED\n- webhooks.TRANSACTION_SETTLED.url\n- webhooks.TRANSACTION_VOIDED\n- webhooks.TRANSACTION_VOIDED.url\n- webhooks.PAYOUT\n- webhooks.PAYOUT.url\n- webhooks.SPENDBACK\n- webhooks.SPENDBACK.url\n\n\n## Response parameters\n- merchantId\n- payoutAccountId\n- webhooks\n- webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED\n- webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED.url\n- webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER\n- webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER.url\n- webhooks.CARD_DATA_UPDATED\n- webhooks.CARD_DATA_UPDATED.url\n- webhooks.CARD_SAVED\n- webhooks.CARD_SAVED.url\n- webhooks.ECHECK_SAVED\n- webhooks.ECHECK_SAVED.url\n- webhooks.SUBSCRIPTION_DETAILS\n- webhooks.SUBSCRIPTION_DETAILS.url\n- webhooks.TRANSACTION_AUTHORIZED\n- webhooks.TRANSACTION_AUTHORIZED.url\n- webhooks.TRANSACTION_CAPTURED\n- webhooks.TRANSACTION_CAPTURED.url\n- webhooks.TRANSACTION_PENDING\n- webhooks.TRANSACTION_PENDING.url\n- webhooks.TRANSACTION_REFUNDED\n- webhooks.TRANSACTION_REFUNDED.url\n- webhooks.TRANSACTION_SETTLED\n- webhooks.TRANSACTION_SETTLED.url\n- webhooks.TRANSACTION_VOIDED\n- webhooks.TRANSACTION_VOIDED.url\n- webhooks.PAYOUT\n- webhooks.PAYOUT.url\n- webhooks.SPENDBACK\n- webhooks.SPENDBACK.url\n- dateCreated\n- dateLastModified\n\n
    "},"response":[{"id":"a99bdc70-d22d-4967-9623-009498e17138","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"webhooks\": {\n \"ACCOUNT_UPDATER_ACCOUNT_CLOSED\": {\n \"url\": \"\"\n },\n \"ACCOUNT_UPDATER_CONTACT_CARDHOLDER\": {\n \"url\": \"\"\n },\n \"CARD_DATA_UPDATED\": {\n \"url\": \"\"\n },\n \"CARD_SAVED\": {\n \"url\": \"\"\n },\n \"ECHECK_SAVED\": {\n \"url\": \"\"\n },\n \"SUBSCRIPTION_DETAILS\": {\n \"url\": \"\"\n },\n \"TRANSACTION_AUTHORIZED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_CAPTURED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_PENDING\": {\n \"url\": \"\"\n },\n \"TRANSACTION_REFUNDED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_SETTLED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_VOIDED\": {\n \"url\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantId\": \"\",\n \"payoutAccountId\": \"\",\n \"webhooks\": {\n \"ACCOUNT_UPDATER_ACCOUNT_CLOSED\": {\n \"url\": \"\"\n },\n \"ACCOUNT_UPDATER_CONTACT_CARDHOLDER\": {\n \"url\": \"\"\n },\n \"CARD_DATA_UPDATED\": {\n \"url\": \"\"\n },\n \"CARD_SAVED\": {\n \"url\": \"\"\n },\n \"ECHECK_SAVED\": {\n \"url\": \"\"\n },\n \"PAYOUT\": {\n \"url\": \"\"\n },\n \"SPENDBACK\": {\n \"url\": \"\"\n },\n \"SUBSCRIPTION_DETAILS\": {\n \"url\": \"\"\n },\n \"TRANSACTION_AUTHORIZED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_CAPTURED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_PENDING\": {\n \"url\": \"\"\n },\n \"TRANSACTION_REFUNDED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_SETTLED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_VOIDED\": {\n \"url\": \"\"\n }\n },\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\"\n}"},{"id":"f54795e4-50de-4d9f-9796-dd7a8658c7ad","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"webhooks\": {\n \"ACCOUNT_UPDATER_ACCOUNT_CLOSED\": {\n \"url\": \"\"\n },\n \"ACCOUNT_UPDATER_CONTACT_CARDHOLDER\": {\n \"url\": \"\"\n },\n \"CARD_DATA_UPDATED\": {\n \"url\": \"\"\n },\n \"CARD_SAVED\": {\n \"url\": \"\"\n },\n \"ECHECK_SAVED\": {\n \"url\": \"\"\n },\n \"SUBSCRIPTION_DETAILS\": {\n \"url\": \"\"\n },\n \"TRANSACTION_AUTHORIZED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_CAPTURED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_PENDING\": {\n \"url\": \"\"\n },\n \"TRANSACTION_REFUNDED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_SETTLED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_VOIDED\": {\n \"url\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/config"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requiredFieldsError\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}"},{"id":"ed1a53ad-8892-4b1c-a2a7-214a03f82c25","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\",\n \"webhooks\": {\n \"ACCOUNT_UPDATER_ACCOUNT_CLOSED\": {\n \"url\": \"\"\n },\n \"ACCOUNT_UPDATER_CONTACT_CARDHOLDER\": {\n \"url\": \"\"\n },\n \"CARD_DATA_UPDATED\": {\n \"url\": \"\"\n },\n \"CARD_SAVED\": {\n \"url\": \"\"\n },\n \"ECHECK_SAVED\": {\n \"url\": \"\"\n },\n \"SUBSCRIPTION_DETAILS\": {\n \"url\": \"\"\n },\n \"TRANSACTION_AUTHORIZED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_CAPTURED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_PENDING\": {\n \"url\": \"\"\n },\n \"TRANSACTION_REFUNDED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_SETTLED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_VOIDED\": {\n \"url\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/config"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"3c0e92b4-507d-4930-b90d-57a725aa5551"},{"name":"View legacy merchant webhook configuration","id":"f5e25afb-9c9d-47b1-90be-09b0fef70024","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/webhook/v3/config/:id","host":["{{baseUrl}}"],"path":["webhook","v3","config",":id"],"variable":[{"id":"1f95367e-7e90-4f05-af46-3467bf447244","key":"id","value":"","description":"(Required) The merchant ID or the payout account ID."}]},"description":"Returns a merchant's webhook configuration. For a tutorial about configuring and using webhooks, see [Configuring legacy webhooks](doc:configuring-legacy-webhooks) in Guides.\n\n\n> πŸ“˜ Note\n> \n> For the current workflow, see the [View webhook URLs by ID and type](ref:viewwebhookurlsbyidandtype) endpoint instead.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- id\n\n## Response parameters\n- merchantId\n- payoutAccountId\n- webhooks\n- webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED\n- webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED.url\n- webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER\n- webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER.url\n- webhooks.CARD_DATA_UPDATED\n- webhooks.CARD_DATA_UPDATED.url\n- webhooks.CARD_SAVED\n- webhooks.CARD_SAVED.url\n- webhooks.ECHECK_SAVED\n- webhooks.ECHECK_SAVED.url\n- webhooks.SUBSCRIPTION_DETAILS\n- webhooks.SUBSCRIPTION_DETAILS.url\n- webhooks.TRANSACTION_AUTHORIZED\n- webhooks.TRANSACTION_AUTHORIZED.url\n- webhooks.TRANSACTION_CAPTURED\n- webhooks.TRANSACTION_CAPTURED.url\n- webhooks.TRANSACTION_PENDING\n- webhooks.TRANSACTION_PENDING.url\n- webhooks.TRANSACTION_REFUNDED\n- webhooks.TRANSACTION_REFUNDED.url\n- webhooks.TRANSACTION_SETTLED\n- webhooks.TRANSACTION_SETTLED.url\n- webhooks.TRANSACTION_VOIDED\n- webhooks.TRANSACTION_VOIDED.url\n- webhooks.PAYOUT\n- webhooks.PAYOUT.url\n- webhooks.SPENDBACK\n- webhooks.SPENDBACK.url\n- dateCreated\n- dateLastModified\n\n
    "},"response":[{"id":"0b557950-e3a7-48c6-9dad-091937560177","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/webhook/v3/config/:id","host":["{{baseUrl}}"],"path":["webhook","v3","config",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantId\": \"\",\n \"payoutAccountId\": \"\",\n \"webhooks\": {\n \"ACCOUNT_UPDATER_ACCOUNT_CLOSED\": {\n \"url\": \"\"\n },\n \"ACCOUNT_UPDATER_CONTACT_CARDHOLDER\": {\n \"url\": \"\"\n },\n \"CARD_DATA_UPDATED\": {\n \"url\": \"\"\n },\n \"CARD_SAVED\": {\n \"url\": \"\"\n },\n \"ECHECK_SAVED\": {\n \"url\": \"\"\n },\n \"PAYOUT\": {\n \"url\": \"\"\n },\n \"SPENDBACK\": {\n \"url\": \"\"\n },\n \"SUBSCRIPTION_DETAILS\": {\n \"url\": \"\"\n },\n \"TRANSACTION_AUTHORIZED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_CAPTURED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_PENDING\": {\n \"url\": \"\"\n },\n \"TRANSACTION_REFUNDED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_SETTLED\": {\n \"url\": \"\"\n },\n \"TRANSACTION_VOIDED\": {\n \"url\": \"\"\n }\n },\n \"dateCreated\": \"\",\n \"dateLastModified\": \"\"\n}"},{"id":"24b11969-a05e-45f8-a202-d5d5a0c63abe","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/webhook/v3/config/:id","host":["{{baseUrl}}"],"path":["webhook","v3","config",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"f5e25afb-9c9d-47b1-90be-09b0fef70024"},{"name":"Create a webhook secret","id":"c1ce084e-9a4b-44d8-ab9b-dac2ac96dcf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/secret","description":"Creates a secret to be used in legacy webhooks for a merchant account or payout account. \n\nSet up a webhook secret for additional security. After you create a secret, each webhook includes a header containing a signature. You can use the signature to verify that all data received is authentic.\n\nFor a tutorial about configuring and using webhooks, see [Configuring legacy webhooks](doc:configuring-legacy-webhooks) in Guides.\n\n\n> πŸ“˜ Note\n> \n> For the current workflow, see the [Register webhook URLs](ref:registerwebhookurls) endpoint instead.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- merchantId\n- payoutAccountId\n\n## Response parameters\n- secret\n\n
    "},"response":[{"id":"801db1c3-749f-4773-a4f3-54d99f140137","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/secret"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"secret\": \"\"\n}"},{"id":"4c78c51b-7bdd-4d39-aa65-709178c3d992","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/webhook/v3/secret"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"c1ce084e-9a4b-44d8-ab9b-dac2ac96dcf9"},{"name":"View webhook secret","id":"8feac589-d66f-44bb-8be3-3485c32363b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/webhook/v3/secret/:id","host":["{{baseUrl}}"],"path":["webhook","v3","secret",":id"],"variable":[{"id":"9b85ab21-3944-4604-ada2-e2226fd77444","key":"id","value":"","description":"(Required) The merchant ID or payout account ID to get the webhook secret for."}]},"description":"Returns the webhook secret to be used in validating legacy webhooks for the specified merchant ID or payout account ID. To create a secret, use the [/webhook/v3/secret](ref:createwebhooksecret) endpoint.\n\nFor a tutorial about verifying the signature, see [Receiving legacy webhooks](doc:receiving-legacy-webhooks) in Guides.\n\n\n> πŸ“˜ Note\n>\n> For the current workflow, see the [Register webhook URLs](ref:registerwebhookurls) endpoint instead.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).\n\n\n
    \n\n## Request parameters\n- id\n\n## Response parameters\n- secret\n\n
    "},"response":[{"id":"e785f6fa-0e5b-42a1-a93c-a3a66c2a92ee","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/webhook/v3/secret/:id","host":["{{baseUrl}}"],"path":["webhook","v3","secret",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"secret\": \"\"\n}"},{"id":"dca35a0e-5a7b-4887-afb2-8f6d93aa2448","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/webhook/v3/secret/:id","host":["{{baseUrl}}"],"path":["webhook","v3","secret",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"8feac589-d66f-44bb-8be3-3485c32363b5"}],"id":"9d80f9db-3f76-461a-83b2-03ae424f4ce9","description":"APIs for webhooks","_postman_id":"9d80f9db-3f76-461a-83b2-03ae424f4ce9"},{"name":"Card Processing Online Application","item":[{"name":"Create online application","id":"4bc6df5d-1f46-447d-9e26-c1ec63bb1ce2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"repCode\": \"\",\n \"applicationType\": \"isv\",\n \"checkCredit\": true,\n \"hasPersonalGuarantor\": true,\n \"sendEmail\": \"\",\n \"sendEmailMessage\": \"\"\n },\n \"pricing\": {\n \"pricingNotes\": \"\",\n \"accountSetupFee\": \"\",\n \"accountServiceFee\": \"\",\n \"annualMembershipFee\": \"\",\n \"annualPciComplianceFee\": \"\",\n \"chargebackFee\": \"\",\n \"edcAVSFee\": \"\",\n \"helpDeskFee\": \"\",\n \"insufficientFundsFee\": \"\",\n \"monthlyBreachInsuranceFee\": \"\",\n \"monthlyDebitAccessFee\": \"\",\n \"monthlyMinimumFee\": \"\",\n \"monthlyRegulatoryFee\": \"\",\n \"onlineReportingAccessFee\": \"\",\n \"retrievalFee\": \"\",\n \"visaAuth\": \"\",\n \"visaBatch\": \"\",\n \"pinDebitPerItem\": \"\",\n \"pinDebitRate\": \"\",\n \"amexPricingType\": \"tiered\",\n \"visaPricingType\": \"tiered\",\n \"amexERRQualified\": \"\",\n \"amexERRNonQualified\": \"\",\n \"amexInterchange\": \"\",\n \"amexTieredQualified\": \"\",\n \"amexTieredMidQualified\": \"\",\n \"amexTieredNonQualified\": \"\",\n \"visaERRQualified\": \"\",\n \"visaERRNonQualified\": \"\",\n \"visaInterchange\": \"\",\n \"visaTieredQualified\": \"\",\n \"visaTieredMidQualified\": \"\",\n \"visaTieredNonQualified\": \"\",\n \"commercialNonQualifiedRate\": \"\"\n },\n \"owners\": {\n \"owner1\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"middleInitial\": \"\",\n \"title\": \"vice-president\",\n \"phone\": \"4444444444\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"JTO\",\n \"postal\": \"tEo3Jie\",\n \"country\": \"vTJHmzAXvXl\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"027217324\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"passport\",\n \"identificationState\": \"ssE\",\n \"identificationNumber\": \"\"\n },\n \"owner2\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"owner\",\n \"phone\": \"9701737048\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"yff\",\n \"postal\": \"8WzI8Wz\",\n \"country\": \"P\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"437083512\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"state-id\",\n \"identificationState\": \"EBH\",\n \"identificationNumber\": \"\"\n },\n \"owner3\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"president\",\n \"phone\": \"0553684055\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"gMy\",\n \"postal\": \"R2R2R2R\",\n \"country\": \"BkxjSAx\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"595959595\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"drivers-license\",\n \"identificationState\": \"Ahr\",\n \"identificationNumber\": \"\"\n },\n \"owner4\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"treasurer\",\n \"phone\": \"2222222222\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"QUm\",\n \"postal\": \"alyaly\",\n \"country\": \"rfy\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"008800880\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"drivers-license\",\n \"identificationState\": \"gwa\",\n \"identificationNumber\": \"\"\n }\n },\n \"business\": {\n \"taxPayerId\": \"736273627\",\n \"dbaName\": \"\",\n \"legalSameAsDBA\": \"\",\n \"legalName\": \"\",\n \"businessStartDate\": \"\",\n \"businessType\": \"partnership\",\n \"marketType\": \"\",\n \"productDescription\": \"\",\n \"website\": \"\",\n \"businessPhone\": \"2352067822\",\n \"corporatePhone\": \"1194119411\",\n \"customerServicePhone\": \"2320823208\",\n \"fax\": \"0930514093\",\n \"contactFirstName\": \"\",\n \"contactLastName\": \"\",\n \"contactEmail\": \"\",\n \"businessAddress\": \"\",\n \"businessCity\": \"\",\n \"businessState\": \"SjO\",\n \"businessPostal\": \"giWb8DH\",\n \"businessCountry\": \"zz\",\n \"legalAddress\": \"\",\n \"legalCity\": \"\",\n \"legalState\": \"wIT\",\n \"legalPostal\": \"iRHiewB\",\n \"legalCountry\": \"Gf\"\n },\n \"merchantProfile\": {\n \"isDirectSalesMLM\": \"\",\n \"acceptCard\": \"\",\n \"acceptPrePayment\": \"\",\n \"warranty\": \"\",\n \"averageTicketAmount\": \"\",\n \"highTicket\": \"\",\n \"monthlySalesVolume\": \"\",\n \"amex\": \"\",\n \"amexSe\": \"\",\n \"cardPresentSwiped\": \"\",\n \"cardPresentKeyed\": \"\",\n \"cardNotPresentMOTO\": \"\",\n \"cardNotPresentECommerce\": \"\"\n },\n \"bank\": {\n \"routingNumber\": \"097012603\",\n \"accountNumber\": \"482279219\"\n },\n \"compliance\": {\n \"adc\": \"\",\n \"adcDate\": \"\",\n \"pcidss\": \"\",\n \"pcidssDate\": \"\",\n \"fcn\": \"\",\n \"otherServiceProvider\": \"\",\n \"otherServiceProviderName\": \"\"\n },\n \"directSalesMLM\": {\n \"generalProductsServices\": \"\",\n \"generalAdvertise\": \"\",\n \"financialBankruptcy\": \"\",\n \"financialCommissionsRecruiting\": \"\",\n \"financialCommissionsSales\": \"\",\n \"financialGrossRevenue\": \"\",\n \"financialRecruitingGrossRevenuePercentage\": \"\",\n \"financialStartup\": false,\n \"operationalAdvanceCharges\": \"\",\n \"operationalComplaints\": \"\",\n \"operationalDistributorContract\": \"\",\n \"operationalDistributorDoc\": \"\",\n \"operationalDoesOfferTrial\": \"\",\n \"operationalTrialOffer\": \"\",\n \"operationalHasPeakSeason\": \"\",\n \"operationalPeakSeason\": \"\",\n \"operationalInventoryPurchase\": \"\",\n \"operationalMailTelephoneOrders\": \"\",\n \"operationalPhysicalLocations\": \"\",\n \"operationalProductFulfillment\": \"company\",\n \"operationalRecurringBilling\": \"\",\n \"operationalRecurringBillingInfo\": \"\",\n \"operationalRestockingFees\": \"\",\n \"operationalRefunds\": \"\",\n \"operationalTraining\": \"\",\n \"reputationalWorkingWithAttorney\": \"\",\n \"reputationalAttorney\": \"\",\n \"reputationalContact\": \"\",\n \"reputationalDSA\": \"\",\n \"reputationalIndictment\": \"\",\n \"reputationalSanctions\": \"\",\n \"reputationalShipping\": \"\"\n },\n \"merchantSiteSurveyReport\": {\n \"merchantLocation\": \"other\",\n \"merchantLocationOther\": \"\"\n },\n \"merchantProfileAnalysis\": {\n \"questionsContactNumber\": \"\",\n \"generalUsername\": \"\",\n \"generalPassword\": \"\",\n \"generalAdvertise\": \"\",\n \"generalBilledFrequency\": \"\",\n \"generalCancellation\": \"\",\n \"generalCardPayments\": \"\",\n \"generalControlPerson\": \"\",\n \"generalInAdvance\": \"\",\n \"generalInventory\": \"\",\n \"generalNutraceutical\": \"\",\n \"generalProductsServices\": \"\",\n \"generalRefund\": \"\",\n \"generalTelemarketing\": \"\",\n \"isCollectionServices\": \"\",\n \"collectionDebtType\": \"\",\n \"collectionIndustries\": \"\",\n \"isConsulting\": \"\",\n \"consultingDescribe\": \"\",\n \"consultingFiling\": \"\",\n \"isCreditRepairServices\": \"\",\n \"creditRepairAttorneyStaff\": \"\",\n \"creditRepairFees\": \"\",\n \"creditRepairTelemarketing\": \"\",\n \"isLendingServices\": \"\",\n \"lendingDisclose\": \"\",\n \"lendingOriginate\": \"\",\n \"isTravel\": \"\",\n \"travelARC\": \"\",\n \"travelCompany\": \"\",\n \"travelInsurance\": \"\",\n \"travelLicensedStates\": \"\",\n \"travelThirdParty\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/onlineapplication/v2/app","description":"Creates a prefilled form for the online application.\n\nThe 'pricing' object is optional. However, if included in the request, include all required and any applicable conditionally required parameters.\n\n\n> πŸ“˜ Notes\n> \n> - You cannot use this endpoint in the Nexio sandbox environment.\n> - For authentication with this endpoint, use your CForce credentials.\n\n\n> ⚠️ Try It\n> \n> Due to technical limitations, it is not possible to use the **Try It** feature with this endpoint. Instead, use something like Postman or your own server to make the request with the [base URL for the Nexio production environment](doc:base-urls-and-environments).\n\n\n
    \n\n## Request parameters\n- partner\n- partner.applicationType\n- partner.repCode\n- partner.checkCredit\n- partner.hasPersonalGuarantor\n- partner.repName\n- partner.contact\n- partner.agentEmail\n- partner.partnerRef\n- partner.redirectUrl\n- partner.sendEmail\n- partner.sendEmailMessage\n- owners\n- owners.owner1\n- owners.owner2\n- owners.owner3\n- owners.owner4\n- owners.owner[n].email\n- owners.owner[n].firstName\n- owners.owner[n].middleInitial\n- owners.owner[n].lastName\n- owners.owner[n].title\n- owners.owner[n].phone\n- owners.owner[n].address\n- owners.owner[n].city\n- owners.owner[n].state\n- owners.owner[n].postal\n- owners.owner[n].country\n- owners.owner[n].birthday\n- owners.owner[n].socialSecurityNumber\n- owners.owner[n].ownershipPercentage\n- owners.owner[n].identificationType\n- owners.owner[n].identificationState\n- owners.owner[n].identificationNumber\n- business\n- business.taxPayerId\n- business.dbaName\n- business.legalName\n- business.legalSameAsDBA\n- business.businessStartDate\n- business.businessType\n- business.marketType\n- business.productDescription\n- business.website\n- business.businessPhone\n- business.corporatePhone\n- business.customerServicePhone\n- business.fax\n- business.contactFirstName\n- business.contactLastName\n- business.contactEmail\n- business.businessAddress\n- business.businessCity\n- business.businessState\n- business.businessPostal\n- business.businessCountry\n- business.legalAddress\n- business.legalCity\n- business.legalState\n- business.legalPostal\n- business.legalCountry\n- merchantProfile\n- merchantProfile.isDirectSalesMLM\n- merchantProfile.acceptCard\n- merchantProfile.acceptPrePayment\n- merchantProfile.warranty\n- merchantProfile.averageTicketAmount\n- merchantProfile.highTicket\n- merchantProfile.monthlySalesVolume\n- merchantProfile.amex\n- merchantProfile.amexSe\n- merchantProfile.cardPresentSwiped\n- merchantProfile.cardPresentKeyed\n- merchantProfile.cardNotPresentMOTO\n- merchantProfile.cardNotPresentECommerce\n- bank\n- bank.routingNumber\n- bank.accountNumber\n- compliance\n- compliance.adc\n- compliance.adcDate\n- compliance.pcidss\n- compliance.pcidssDate\n- compliance.fcn\n- compliance.otherServiceProvider\n- compliance.otherServiceProviderName\n- pricing\n- pricing.pricingNotes\n- pricing.accountSetupFee\n- pricing.annualMembershipFee\n- pricing.annualPciComplianceFee\n- pricing.accountServiceFee\n- pricing.chargebackFee\n- pricing.edcAVSFee\n- pricing.helpDeskFee\n- pricing.insufficientFundsFee\n- pricing.monthlyBreachInsuranceFee\n- pricing.monthlyDebitAccessFee\n- pricing.monthlyMinimumFee\n- pricing.monthlyRegulatoryFee\n- pricing.onlineReportingAccessFee\n- pricing.retrievalFee\n- pricing.commercialNonQualifiedRate\n- pricing.pinDebitPerItem\n- pricing.pinDebitRate\n- pricing.amexPricingType\n- pricing.amexERRQualified\n- pricing.amexERRNonQualified\n- pricing.amexInterchange\n- pricing.amexTieredQualified\n- pricing.amexTieredMidQualified\n- pricing.amexTieredNonQualified\n- pricing.visaAuth\n- pricing.visaBatch\n- pricing.visaPricingType\n- pricing.visaERRQualified\n- pricing.visaERRNonQualified\n- pricing.visaInterchange\n- pricing.visaTieredQualified\n- pricing.visaTieredMidQualified\n- pricing.visaTieredNonQualified\n- directSalesMLM\n- directSalesMLM.generalProductsServices\n- directSalesMLM.generalAdvertise\n- directSalesMLM.financialBankruptcy\n- directSalesMLM.financialCommissionsRecruiting\n- directSalesMLM.financialCommissionsSales\n- directSalesMLM.financialGrossRevenue\n- directSalesMLM.financialRecruitingGrossRevenuePercentage\n- directSalesMLM.financialStartup\n- directSalesMLM.operationalAdvanceCharges\n- directSalesMLM.operationalComplaints\n- directSalesMLM.operationalDistributorContract\n- directSalesMLM.operationalDistributorDoc\n- directSalesMLM.operationalDoesOfferTrial\n- directSalesMLM.operationalHasPeakSeason\n- directSalesMLM.operationalInventoryPurchase\n- directSalesMLM.operationalMailTelephoneOrders\n- directSalesMLM.operationalPeakSeason\n- directSalesMLM.operationalPhysicalLocations\n- directSalesMLM.operationalProductFulfillment\n- directSalesMLM.operationalRecurringBilling\n- directSalesMLM.operationalRecurringBillingInfo\n- directSalesMLM.operationalRefunds\n- directSalesMLM.operationalRestockingFees\n- directSalesMLM.operationalTraining\n- directSalesMLM.operationalTrialOffer\n- directSalesMLM.reputationalAttorney\n- directSalesMLM.reputationalContact\n- directSalesMLM.reputationalDSA\n- directSalesMLM.reputationalIndictment\n- directSalesMLM.reputationalSanctions\n- directSalesMLM.reputationalShipping\n- directSalesMLM.reputationalWorkingWithAttorney\n- merchantSiteSurveyReport\n- merchantSiteSurveyReport.merchantLocation\n- merchantSiteSurveyReport.merchantLocationOther\n- merchantProfileAnalysis\n- merchantProfileAnalysis.generalUsername\n- merchantProfileAnalysis.generalPassword\n- merchantProfileAnalysis.generalControlPerson\n- merchantProfileAnalysis.questionsContactNumber\n- merchantProfileAnalysis.generalAdvertise\n- merchantProfileAnalysis.generalBilledFrequency\n- merchantProfileAnalysis.generalCancellation\n- merchantProfileAnalysis.generalCardPayments\n- merchantProfileAnalysis.generalInAdvance\n- merchantProfileAnalysis.generalInventory\n- merchantProfileAnalysis.generalNutraceutical\n- merchantProfileAnalysis.generalProductsServices\n- merchantProfileAnalysis.generalRefund\n- merchantProfileAnalysis.generalTelemarketing\n- merchantProfileAnalysis.isCollectionServices\n- merchantProfileAnalysis.collectionDebtType\n- merchantProfileAnalysis.collectionIndustries\n- merchantProfileAnalysis.isConsulting\n- merchantProfileAnalysis.consultingDescribe\n- merchantProfileAnalysis.consultingFiling\n- merchantProfileAnalysis.isCreditRepairServices\n- merchantProfileAnalysis.creditRepairAttorneyStaff\n- merchantProfileAnalysis.creditRepairFees\n- merchantProfileAnalysis.creditRepairTelemarketing\n- merchantProfileAnalysis.isLendingServices\n- merchantProfileAnalysis.lendingDisclose\n- merchantProfileAnalysis.lendingOriginate\n- merchantProfileAnalysis.isTravel\n- merchantProfileAnalysis.travelARC\n- merchantProfileAnalysis.travelCompany\n- merchantProfileAnalysis.travelInsurance\n- merchantProfileAnalysis.travelLicensedStates\n- merchantProfileAnalysis.travelThirdParty\n\n\n## Response parameters\n- merchantLink\n- token\n\n
    \n"},"response":[{"id":"a6942f2e-f714-4bfe-b7b3-d9659b793a0f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"repCode\": \"\",\n \"applicationType\": \"isv\",\n \"checkCredit\": true,\n \"hasPersonalGuarantor\": true,\n \"sendEmail\": \"\",\n \"sendEmailMessage\": \"\"\n },\n \"pricing\": {\n \"pricingNotes\": \"\",\n \"accountSetupFee\": \"\",\n \"accountServiceFee\": \"\",\n \"annualMembershipFee\": \"\",\n \"annualPciComplianceFee\": \"\",\n \"chargebackFee\": \"\",\n \"edcAVSFee\": \"\",\n \"helpDeskFee\": \"\",\n \"insufficientFundsFee\": \"\",\n \"monthlyBreachInsuranceFee\": \"\",\n \"monthlyDebitAccessFee\": \"\",\n \"monthlyMinimumFee\": \"\",\n \"monthlyRegulatoryFee\": \"\",\n \"onlineReportingAccessFee\": \"\",\n \"retrievalFee\": \"\",\n \"visaAuth\": \"\",\n \"visaBatch\": \"\",\n \"pinDebitPerItem\": \"\",\n \"pinDebitRate\": \"\",\n \"amexPricingType\": \"tiered\",\n \"visaPricingType\": \"tiered\",\n \"amexERRQualified\": \"\",\n \"amexERRNonQualified\": \"\",\n \"amexInterchange\": \"\",\n \"amexTieredQualified\": \"\",\n \"amexTieredMidQualified\": \"\",\n \"amexTieredNonQualified\": \"\",\n \"visaERRQualified\": \"\",\n \"visaERRNonQualified\": \"\",\n \"visaInterchange\": \"\",\n \"visaTieredQualified\": \"\",\n \"visaTieredMidQualified\": \"\",\n \"visaTieredNonQualified\": \"\",\n \"commercialNonQualifiedRate\": \"\"\n },\n \"owners\": {\n \"owner1\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"middleInitial\": \"\",\n \"title\": \"vice-president\",\n \"phone\": \"4444444444\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"JTO\",\n \"postal\": \"tEo3Jie\",\n \"country\": \"vTJHmzAXvXl\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"027217324\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"passport\",\n \"identificationState\": \"ssE\",\n \"identificationNumber\": \"\"\n },\n \"owner2\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"owner\",\n \"phone\": \"9701737048\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"yff\",\n \"postal\": \"8WzI8Wz\",\n \"country\": \"P\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"437083512\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"state-id\",\n \"identificationState\": \"EBH\",\n \"identificationNumber\": \"\"\n },\n \"owner3\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"president\",\n \"phone\": \"0553684055\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"gMy\",\n \"postal\": \"R2R2R2R\",\n \"country\": \"BkxjSAx\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"595959595\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"drivers-license\",\n \"identificationState\": \"Ahr\",\n \"identificationNumber\": \"\"\n },\n \"owner4\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"treasurer\",\n \"phone\": \"2222222222\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"QUm\",\n \"postal\": \"alyaly\",\n \"country\": \"rfy\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"008800880\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"drivers-license\",\n \"identificationState\": \"gwa\",\n \"identificationNumber\": \"\"\n }\n },\n \"business\": {\n \"taxPayerId\": \"736273627\",\n \"dbaName\": \"\",\n \"legalSameAsDBA\": \"\",\n \"legalName\": \"\",\n \"businessStartDate\": \"\",\n \"businessType\": \"partnership\",\n \"marketType\": \"\",\n \"productDescription\": \"\",\n \"website\": \"\",\n \"businessPhone\": \"2352067822\",\n \"corporatePhone\": \"1194119411\",\n \"customerServicePhone\": \"2320823208\",\n \"fax\": \"0930514093\",\n \"contactFirstName\": \"\",\n \"contactLastName\": \"\",\n \"contactEmail\": \"\",\n \"businessAddress\": \"\",\n \"businessCity\": \"\",\n \"businessState\": \"SjO\",\n \"businessPostal\": \"giWb8DH\",\n \"businessCountry\": \"zz\",\n \"legalAddress\": \"\",\n \"legalCity\": \"\",\n \"legalState\": \"wIT\",\n \"legalPostal\": \"iRHiewB\",\n \"legalCountry\": \"Gf\"\n },\n \"merchantProfile\": {\n \"isDirectSalesMLM\": \"\",\n \"acceptCard\": \"\",\n \"acceptPrePayment\": \"\",\n \"warranty\": \"\",\n \"averageTicketAmount\": \"\",\n \"highTicket\": \"\",\n \"monthlySalesVolume\": \"\",\n \"amex\": \"\",\n \"amexSe\": \"\",\n \"cardPresentSwiped\": \"\",\n \"cardPresentKeyed\": \"\",\n \"cardNotPresentMOTO\": \"\",\n \"cardNotPresentECommerce\": \"\"\n },\n \"bank\": {\n \"routingNumber\": \"097012603\",\n \"accountNumber\": \"482279219\"\n },\n \"compliance\": {\n \"adc\": \"\",\n \"adcDate\": \"\",\n \"pcidss\": \"\",\n \"pcidssDate\": \"\",\n \"fcn\": \"\",\n \"otherServiceProvider\": \"\",\n \"otherServiceProviderName\": \"\"\n },\n \"directSalesMLM\": {\n \"generalProductsServices\": \"\",\n \"generalAdvertise\": \"\",\n \"financialBankruptcy\": \"\",\n \"financialCommissionsRecruiting\": \"\",\n \"financialCommissionsSales\": \"\",\n \"financialGrossRevenue\": \"\",\n \"financialRecruitingGrossRevenuePercentage\": \"\",\n \"financialStartup\": false,\n \"operationalAdvanceCharges\": \"\",\n \"operationalComplaints\": \"\",\n \"operationalDistributorContract\": \"\",\n \"operationalDistributorDoc\": \"\",\n \"operationalDoesOfferTrial\": \"\",\n \"operationalTrialOffer\": \"\",\n \"operationalHasPeakSeason\": \"\",\n \"operationalPeakSeason\": \"\",\n \"operationalInventoryPurchase\": \"\",\n \"operationalMailTelephoneOrders\": \"\",\n \"operationalPhysicalLocations\": \"\",\n \"operationalProductFulfillment\": \"company\",\n \"operationalRecurringBilling\": \"\",\n \"operationalRecurringBillingInfo\": \"\",\n \"operationalRestockingFees\": \"\",\n \"operationalRefunds\": \"\",\n \"operationalTraining\": \"\",\n \"reputationalWorkingWithAttorney\": \"\",\n \"reputationalAttorney\": \"\",\n \"reputationalContact\": \"\",\n \"reputationalDSA\": \"\",\n \"reputationalIndictment\": \"\",\n \"reputationalSanctions\": \"\",\n \"reputationalShipping\": \"\"\n },\n \"merchantSiteSurveyReport\": {\n \"merchantLocation\": \"other\",\n \"merchantLocationOther\": \"\"\n },\n \"merchantProfileAnalysis\": {\n \"questionsContactNumber\": \"\",\n \"generalUsername\": \"\",\n \"generalPassword\": \"\",\n \"generalAdvertise\": \"\",\n \"generalBilledFrequency\": \"\",\n \"generalCancellation\": \"\",\n \"generalCardPayments\": \"\",\n \"generalControlPerson\": \"\",\n \"generalInAdvance\": \"\",\n \"generalInventory\": \"\",\n \"generalNutraceutical\": \"\",\n \"generalProductsServices\": \"\",\n \"generalRefund\": \"\",\n \"generalTelemarketing\": \"\",\n \"isCollectionServices\": \"\",\n \"collectionDebtType\": \"\",\n \"collectionIndustries\": \"\",\n \"isConsulting\": \"\",\n \"consultingDescribe\": \"\",\n \"consultingFiling\": \"\",\n \"isCreditRepairServices\": \"\",\n \"creditRepairAttorneyStaff\": \"\",\n \"creditRepairFees\": \"\",\n \"creditRepairTelemarketing\": \"\",\n \"isLendingServices\": \"\",\n \"lendingDisclose\": \"\",\n \"lendingOriginate\": \"\",\n \"isTravel\": \"\",\n \"travelARC\": \"\",\n \"travelCompany\": \"\",\n \"travelInsurance\": \"\",\n \"travelLicensedStates\": \"\",\n \"travelThirdParty\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/onlineapplication/v2/app"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantLink\": \"\",\n \"token\": \"\"\n}"},{"id":"41c69912-f700-4b7d-a20e-5ca52b77491c","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"repCode\": \"\",\n \"applicationType\": \"isv\",\n \"checkCredit\": true,\n \"hasPersonalGuarantor\": true,\n \"sendEmail\": \"\",\n \"sendEmailMessage\": \"\"\n },\n \"pricing\": {\n \"pricingNotes\": \"\",\n \"accountSetupFee\": \"\",\n \"accountServiceFee\": \"\",\n \"annualMembershipFee\": \"\",\n \"annualPciComplianceFee\": \"\",\n \"chargebackFee\": \"\",\n \"edcAVSFee\": \"\",\n \"helpDeskFee\": \"\",\n \"insufficientFundsFee\": \"\",\n \"monthlyBreachInsuranceFee\": \"\",\n \"monthlyDebitAccessFee\": \"\",\n \"monthlyMinimumFee\": \"\",\n \"monthlyRegulatoryFee\": \"\",\n \"onlineReportingAccessFee\": \"\",\n \"retrievalFee\": \"\",\n \"visaAuth\": \"\",\n \"visaBatch\": \"\",\n \"pinDebitPerItem\": \"\",\n \"pinDebitRate\": \"\",\n \"amexPricingType\": \"tiered\",\n \"visaPricingType\": \"tiered\",\n \"amexERRQualified\": \"\",\n \"amexERRNonQualified\": \"\",\n \"amexInterchange\": \"\",\n \"amexTieredQualified\": \"\",\n \"amexTieredMidQualified\": \"\",\n \"amexTieredNonQualified\": \"\",\n \"visaERRQualified\": \"\",\n \"visaERRNonQualified\": \"\",\n \"visaInterchange\": \"\",\n \"visaTieredQualified\": \"\",\n \"visaTieredMidQualified\": \"\",\n \"visaTieredNonQualified\": \"\",\n \"commercialNonQualifiedRate\": \"\"\n },\n \"owners\": {\n \"owner1\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"middleInitial\": \"\",\n \"title\": \"vice-president\",\n \"phone\": \"4444444444\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"JTO\",\n \"postal\": \"tEo3Jie\",\n \"country\": \"vTJHmzAXvXl\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"027217324\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"passport\",\n \"identificationState\": \"ssE\",\n \"identificationNumber\": \"\"\n },\n \"owner2\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"owner\",\n \"phone\": \"9701737048\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"yff\",\n \"postal\": \"8WzI8Wz\",\n \"country\": \"P\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"437083512\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"state-id\",\n \"identificationState\": \"EBH\",\n \"identificationNumber\": \"\"\n },\n \"owner3\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"president\",\n \"phone\": \"0553684055\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"gMy\",\n \"postal\": \"R2R2R2R\",\n \"country\": \"BkxjSAx\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"595959595\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"drivers-license\",\n \"identificationState\": \"Ahr\",\n \"identificationNumber\": \"\"\n },\n \"owner4\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"middleInitial\": \"\",\n \"lastName\": \"\",\n \"title\": \"treasurer\",\n \"phone\": \"2222222222\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"QUm\",\n \"postal\": \"alyaly\",\n \"country\": \"rfy\",\n \"birthday\": \"\",\n \"socialSecurityNumber\": \"008800880\",\n \"ownershipPercentage\": \"\",\n \"identificationType\": \"drivers-license\",\n \"identificationState\": \"gwa\",\n \"identificationNumber\": \"\"\n }\n },\n \"business\": {\n \"taxPayerId\": \"736273627\",\n \"dbaName\": \"\",\n \"legalSameAsDBA\": \"\",\n \"legalName\": \"\",\n \"businessStartDate\": \"\",\n \"businessType\": \"partnership\",\n \"marketType\": \"\",\n \"productDescription\": \"\",\n \"website\": \"\",\n \"businessPhone\": \"2352067822\",\n \"corporatePhone\": \"1194119411\",\n \"customerServicePhone\": \"2320823208\",\n \"fax\": \"0930514093\",\n \"contactFirstName\": \"\",\n \"contactLastName\": \"\",\n \"contactEmail\": \"\",\n \"businessAddress\": \"\",\n \"businessCity\": \"\",\n \"businessState\": \"SjO\",\n \"businessPostal\": \"giWb8DH\",\n \"businessCountry\": \"zz\",\n \"legalAddress\": \"\",\n \"legalCity\": \"\",\n \"legalState\": \"wIT\",\n \"legalPostal\": \"iRHiewB\",\n \"legalCountry\": \"Gf\"\n },\n \"merchantProfile\": {\n \"isDirectSalesMLM\": \"\",\n \"acceptCard\": \"\",\n \"acceptPrePayment\": \"\",\n \"warranty\": \"\",\n \"averageTicketAmount\": \"\",\n \"highTicket\": \"\",\n \"monthlySalesVolume\": \"\",\n \"amex\": \"\",\n \"amexSe\": \"\",\n \"cardPresentSwiped\": \"\",\n \"cardPresentKeyed\": \"\",\n \"cardNotPresentMOTO\": \"\",\n \"cardNotPresentECommerce\": \"\"\n },\n \"bank\": {\n \"routingNumber\": \"097012603\",\n \"accountNumber\": \"482279219\"\n },\n \"compliance\": {\n \"adc\": \"\",\n \"adcDate\": \"\",\n \"pcidss\": \"\",\n \"pcidssDate\": \"\",\n \"fcn\": \"\",\n \"otherServiceProvider\": \"\",\n \"otherServiceProviderName\": \"\"\n },\n \"directSalesMLM\": {\n \"generalProductsServices\": \"\",\n \"generalAdvertise\": \"\",\n \"financialBankruptcy\": \"\",\n \"financialCommissionsRecruiting\": \"\",\n \"financialCommissionsSales\": \"\",\n \"financialGrossRevenue\": \"\",\n \"financialRecruitingGrossRevenuePercentage\": \"\",\n \"financialStartup\": false,\n \"operationalAdvanceCharges\": \"\",\n \"operationalComplaints\": \"\",\n \"operationalDistributorContract\": \"\",\n \"operationalDistributorDoc\": \"\",\n \"operationalDoesOfferTrial\": \"\",\n \"operationalTrialOffer\": \"\",\n \"operationalHasPeakSeason\": \"\",\n \"operationalPeakSeason\": \"\",\n \"operationalInventoryPurchase\": \"\",\n \"operationalMailTelephoneOrders\": \"\",\n \"operationalPhysicalLocations\": \"\",\n \"operationalProductFulfillment\": \"company\",\n \"operationalRecurringBilling\": \"\",\n \"operationalRecurringBillingInfo\": \"\",\n \"operationalRestockingFees\": \"\",\n \"operationalRefunds\": \"\",\n \"operationalTraining\": \"\",\n \"reputationalWorkingWithAttorney\": \"\",\n \"reputationalAttorney\": \"\",\n \"reputationalContact\": \"\",\n \"reputationalDSA\": \"\",\n \"reputationalIndictment\": \"\",\n \"reputationalSanctions\": \"\",\n \"reputationalShipping\": \"\"\n },\n \"merchantSiteSurveyReport\": {\n \"merchantLocation\": \"other\",\n \"merchantLocationOther\": \"\"\n },\n \"merchantProfileAnalysis\": {\n \"questionsContactNumber\": \"\",\n \"generalUsername\": \"\",\n \"generalPassword\": \"\",\n \"generalAdvertise\": \"\",\n \"generalBilledFrequency\": \"\",\n \"generalCancellation\": \"\",\n \"generalCardPayments\": \"\",\n \"generalControlPerson\": \"\",\n \"generalInAdvance\": \"\",\n \"generalInventory\": \"\",\n \"generalNutraceutical\": \"\",\n \"generalProductsServices\": \"\",\n \"generalRefund\": \"\",\n \"generalTelemarketing\": \"\",\n \"isCollectionServices\": \"\",\n \"collectionDebtType\": \"\",\n \"collectionIndustries\": \"\",\n \"isConsulting\": \"\",\n \"consultingDescribe\": \"\",\n \"consultingFiling\": \"\",\n \"isCreditRepairServices\": \"\",\n \"creditRepairAttorneyStaff\": \"\",\n \"creditRepairFees\": \"\",\n \"creditRepairTelemarketing\": \"\",\n \"isLendingServices\": \"\",\n \"lendingDisclose\": \"\",\n \"lendingOriginate\": \"\",\n \"isTravel\": \"\",\n \"travelARC\": \"\",\n \"travelCompany\": \"\",\n \"travelInsurance\": \"\",\n \"travelLicensedStates\": \"\",\n \"travelThirdParty\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/onlineapplication/v2/app"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"4bc6df5d-1f46-447d-9e26-c1ec63bb1ce2"},{"name":"View application by onboarding ID","id":"31d2174f-bc7a-4679-82ec-ac676ded2998","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/processorOnboarding/v2/applications/:onboardingId","host":["{{baseUrl}}"],"path":["processorOnboarding","v2","applications",":onboardingId"],"variable":[{"id":"b3767991-e94e-4bb3-88b9-240e8d393a19","key":"onboardingId","value":"","description":"(Required) Specifies the ID associated with the application for a prospective merchant."}]},"description":"Returns the application information for a specific `onboardingId` that is associated with the Nexio account used to [authenticate](doc:authentication). \n\n\n> πŸ“˜ Notes\n> \n> - You cannot use this endpoint in the sandbox environment.\n> - For authentication with this endpoint, use your Production API user credentials.\n\n\n> ⚠️ Try It\n> \n> Due to technical limitations, it is not possible to use the Try It feature with this endpoint. Instead, for the production environment, use something like Postman or your own server (along with the credentials for your [Production API user](doc:sandbox-environments#production-environment)) to make the request.\n\n\n
    \n\n## Request parameters\n- onboardingId\n\n## Response parameters\n- merchantName\n- merchantId\n- status\n- signer\n- phoneNumber\n- agentName\n- repCode\n- agentId\n- onboardingId\n- credsReady\n- pendingItemsUpdatedAt\n- pendingNotes.dateAdded\n- pendingNotes.note\n- apiUserCredentials.apiKey\n- apiUserCredentials.userName\n- apiUserCredentials.merchantIds\n- apiUserCredentials.accountId\n\n
    \n"},"response":[{"id":"a9e7e2a5-2524-4f5f-bc3f-48f3f0d558bc","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/processorOnboarding/v2/applications/:onboardingId","host":["{{baseUrl}}"],"path":["processorOnboarding","v2","applications",":onboardingId"],"variable":[{"key":"onboardingId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantName\": \"\",\n \"merchantId\": \"\",\n \"status\": \"Underwriting Signed\",\n \"signer\": \"\",\n \"phoneNumber\": \"\",\n \"agentName\": \"\",\n \"repCode\": \"\",\n \"agentId\": \"\",\n \"onboardingId\": \"\",\n \"credsReady\": \"\",\n \"pendingItemsUpdatedAt\": \"\",\n \"pendingNotes\": [\n {\n \"dateAdded\": \"\",\n \"note\": \"\"\n },\n {\n \"dateAdded\": \"\",\n \"note\": \"\"\n }\n ],\n \"apiUserCredentials\": [\n {\n \"apiKey\": \"\",\n \"userName\": \"\",\n \"merchantIds\": [\n \"\",\n \"\"\n ],\n \"accountId\": \"\"\n },\n {\n \"apiKey\": \"\",\n \"userName\": \"\",\n \"merchantIds\": [\n \"\",\n \"\"\n ],\n \"accountId\": \"\"\n }\n ]\n}"},{"id":"c74e2694-026b-4fa6-95f3-9691b7cfa30d","name":"Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/processorOnboarding/v2/applications/:onboardingId","host":["{{baseUrl}}"],"path":["processorOnboarding","v2","applications",":onboardingId"],"variable":[{"key":"onboardingId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"31d2174f-bc7a-4679-82ec-ac676ded2998"}],"id":"8572848b-6b82-4c0e-9676-c92925637fba","description":"APIs for the Card Processing Online Application","_postman_id":"8572848b-6b82-4c0e-9676-c92925637fba"}],"auth":{"type":"basic","basic":{"username":"{{basicAuthUsername}}","password":"{{basicAuthPassword}}"}},"variable":[{"key":"baseUrl","value":"https://api.nexiopaysandbox.com"}]}