{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2e56e934-3dd4-409f-be75-34ec2ed3d0f1","name":"PayNow APIs","description":"_Revised 04/25/23_\n\nThe Payouts Network PayNow Platform is a singular platform which facilitates multiple ways to disburse funds to customers, employees, or businesses.\n\n<img src=\"https://content.pstmn.io/7364333a-8d2f-4341-b839-0aac441e82e5/R3JvdXAgNTIzLnBuZw==\" width=\"401\" height=\"163\">\n\nThe platform is made up of 3 primary methods of disbursement:\n\n## Instant Payouts\n\nA Payouts Network disbursement method which involves a direct transfer of funds to a Recipient's account. Instant Payouts can be facilitated using the Recipient claim web flow or using the Drop-in UI.\n\n> Example: a restaurant wants to disburse tips digitally to an employee and allow that employee to deposit funds directly to their checking account, instantly via their debit card. \n  \n\n### Instant Payout Product Flow\n\n<img src=\"https://content.pstmn.io/c6cf4a9a-0300-4ee3-af47-b55825a250a8/aW5zdGFudCBmbG93LnBuZw==\" width=\"287\" height=\"100\">\n\n**Step 1:** Payout Request is generated using the console or API\n\n**Step 2:** Payout Request is approved via Approver using the console or via API\n\n**Step 3:** Funds are claimed by Recipient\n\n## Digital Credits (Vouchers)\n\nA Payouts Network disbursement method which requires a Recipient to make a qualifying purchase at a qualifying merchant location or category in order to receive their funds via reimbursement (statement credit). The Recipient must first enroll their payment card using the Digital Credit web flow.\n\n> Example: an airline delivers a Digital Credit to a consumer in the form of a Meal Voucher that can only be redeemed when the customer purchases lunch at a qualifying merchant location in the airport terminal. \n  \n\n### Digital Credit (Vouchers) Product Flow\n\n<img src=\"https://content.pstmn.io/c194aff2-a79e-40f2-8851-c134a8a30c82/dm91Y2hlcnMucG5n\" width=\"425\" height=\"114\">\n\n**Step 1:** Digital Credit is issued via console or API\n\n**Step 2:** Recipient receives notification containing Digital Credit URL. Recipient activates Digital Credit by entering credit or debit card and linking Digital Credit to their card\n\n**Step 3:** Customer makes a purchase at a qualifying merchant location using their linked card\n\n**Step 4:** Card is reimbursed for the amount of the transaction, up to the value of the Digital Credit\n\n## Pay with Points\n\nA Payouts Network disbursement method which requires a consumer to make a qualifying purchase at a qualifying merchant or merchant category, and then agree to exchange points to offset a portion of the original purchase amount.\n\n> Example: an issuing bank wants to provide its customers more options to redeem points outside of traditional methods, so they enable Pay with Points to allow their customers to pay with points immediately after a qualifying transaction with their enrolled credit or debit card. \n  \n\n### Pay with Points Product Flow\n\n<img src=\"https://content.pstmn.io/f35b61e8-e382-44ce-a010-0998b27b6d30/UFdQLnBuZw==\" width=\"435\" height=\"116\">\n\n**Step 1:** Consumer enrolls card in PWP program via API\n\n**Step 2:** Consumer makes purchase at qualifying merchant location using linked card\n\n**Step 3:** Consumer is presented with an opportunity to apply points to their recent purchase exchange for a cash refund back to their card\n\n**Step 4:** If customer accepts offer, funds are pushed back onto the card that is enrolled\n\n# Global Account Settings\n\nEach Payouts Network Organization is configured with the following global account settings:\n\n| **Setting** | **Description** |\n| --- | --- |\n| Max Payout Issuance Limit | The maximum allowable amount for an individual `claim` |\n| Max Payout Aggregate Issuance Limit (Optional) | The maximum allowable aggregate `payout` amount (example: a single payout request with multiple claims cannot exceed $1000) |\n| Max Digital Credit Issuance Limit | The maximum allowable amount for a Digital Credit |\n| Enabled/Disabled Email Notifications | All email notifications can be enabled or disabled. See email notifications tables below. |\n| Role-based Access Controls | All platform roles can be configured to account for granular scopes. New roles may also be added. Contact your Payouts Network representative for additional detail. |\n| SSO Role-Mapping (Optional) | All Payouts Network platform roles can be mapped to the roles of an existing identity provider to support Single Sign-On. Contact your Payouts Network representative for additional detail. |\n| Allow Automatic Deposit (Instant Payouts) | Hides or displays the option to sign up for automatic deposit at the end of the Instant Payout claim flow. Automatic Deposit allows Recipients to save their card on file to receive funds automatically the next time they are paid using the platform. |\n| OCR Card Scanning / Validation (Optional) | Requires a Recipient to scan their debit card within the Instant Payout claim flow for the purpose of verifying that the intended Recipient owns the checking account associated with the entered debit card. Contact your Payouts Network representative for additional detail. |\n\n# Guide: Instant Payouts\n\nInstant Payouts can be facilitated using one of the three methods below:\n\n| Features | **Console - no code** | **API with ready-made claim flow** | **API with Drop-in UI** |\n| --- | --- | --- | --- |\n| Send Payouts | Directly via console | via API or console | API only |\n| Create Recipients | Directly via console | via API or console | API only |\n| Multi-party approval workflow | Built-in | Optional - can issue Payout via API but still require Business users to approve Payout Requests via console | No |\n| Role-based access controls & payout limits by role | Built-in | Optional - for console Business Users only, does not apply to API-based Payout requests | No |\n| White-label emails | Yes - optional | Yes - optional | Confirmation email only (optional) |\n| White-label claim flow | Yes | Yes - no development required | No - Drop-in UI is fully embedded into your application |\n| Reporting | Built-in | via API or console | via API |\n\n## Instant Payout API Workflow\n\nThe following steps outline the general workflow for implementing Instant Payouts:\n\n<img src=\"https://content.pstmn.io/9aba02e1-0e06-4d38-866a-78fc71a497df/aW5zdGFudCBmbG93LnBuZw==\" width=\"447\" height=\"57\">\n\n**Step 1 - Create Recipeint -** Prior to issuing an Instant Payout, a `recipient` must be created by calling the [Create Recipient](https://docs.payoutsnetwork.com/#2102d806-ddbf-4994-bc37-3664e7e59e73) API. The response to the [Create Recipients](https://docs.payoutsnetwork.com/#2102d806-ddbf-4994-bc37-3664e7e59e73) API request will include an `id` which will be required to create the Payout Request in step 2. If you do not wish to store the Recipient `id` , you may also call the [Recipient Details](https://docs.payoutsnetwork.com/#5ca56dd3-f767-4549-bf4c-08182f48a622) API using the Recipient's `email_address` in order to retrieve the Recipient `id`.\n\n**Step 2 - Create Payout Request -** Once one or many Recipients have been created, use the [Create Payout Request](https://docs.payoutsnetwork.com/#2549fdad-b189-45c1-b5fb-f50dbf611d17) API to initiate the Payout process. A singular Payout Request must contain an array of one or many `claims`. A claim represents a unique transfer of funds to a singular Recipient with its own `value`.\n\n**Step 3 - Approve Payout Request -** Once the Payout Request has been created, it must be approved in order to release all associated `claims` to each Recipient. A Payout Request can be approved using the [Change Status of Payout Request](https://docs.payoutsnetwork.com/#b35e0f6a-f2cb-460f-9ad2-7ed2cb65cf01) API by changing the Payout `state` to `PAYOUT-001`.\n\n> Note: it is possible to leverage the Create Payout Request API to trigger an email notification to all Principals (business users) with the Approver role. The email notification will contain a link directing the user to the console where they can manually review and approve the Payout Request. This can be done by bypassing Step 3 above and configuring email notifications for your account. \n  \n> Note: You can use of the test cards listed blow to simulate a payout claim by entering the card number in the claim flow. \n  \n\n**Step 4 - Monitor Activity -** Using [webhooks](https://docs.payoutsnetwork.com/#webhooks), you can monitor the state of all `payouts` and `claims` in real-time.\n\n## Instant Payout Test Cards\n\nUse any of the following test cards to simulate an Instant Payout claim\n\n| **Card Number** | **Pass/Fail** |\n| --- | --- |\n| 4622943120000006 | Pass |\n| 4622943120000014 | Pass |\n| 4622943120000022 | Pass |\n| 4622943120000030 | Pass |\n| 4622943120000048 | Pass |\n\n## Instant Payout Programs\n\nInstant Payout programs may be pre-configured and specified when a Payout is created. The table below outlines the attributes that can be configured at the program level. If program `nickname` is specified when calling the [Create Payout Request](https://docs.payoutsnetwork.com/#2549fdad-b189-45c1-b5fb-f50dbf611d17) API, the following attributes specific to that program will be applied:\n\n| **Program Attribute** | **Description** |\n| --- | --- |\n| Brand Logo URL | Brand logo that is surfaced in the consumer claim flow and email notifications |\n| Primary Brand Color | Primary brand color reflected in the consumer claim flow (CTA buttons etc) and email notifications |\n| Secondary Brand Color | Secondary brand color reflected in the consumer claim flow (hyperlinked text etc) |\n| Sent From Email Address | [your_co@payoutsnetwork.com](https://mailto:your_co@payoutsnetwork.com) - all emails delivered by Payouts Network to customers will be from this address |\n| Reply To Email Address | [your_co@payoutsnetwork.com](https://mailto:your_co@payoutsnetwork.com) |\n| Sent From Email Name | Your Co |\n| Sent By Name | The Sender Name displayed to the Recipient within the claim flow |\n\n## Instant Payout Notifications\n\nThe following email notifications can be configured for accounts using Instant Payouts.\n\n| **Message Type (Email)** | **Description** |\n| --- | --- |\n| claim:issued | Notifies a Recipient that they have received a payout (claim). Provides link and expiration timeframe to Recipient. |\n| claim:payout | Email confirmation to Recipient that their payout (claim) has been processed and funds will arrive in their account within 30 minutes. |\n| claim:reminder | Email notification to Recipient reminding Recipient to claim their payout (claim) before it expires. |\n| payout:approved | Notification to the Payout requester that a Payout Request has been approved. |\n| payout:confirmation | Confirmation email sent to Payout requester notifying requestor that their Payout Request is out for approval. |\n| payout:pending | Notification to all Organization Approvers and Administrators that a Payout has been requested and requires an approval. |\n| payout:rejected | Notification to the Payout Requester that a Payout Request has been rejected. |\n\n## Instant Payout Metadata Fields\n\nOptional metadata fields may be configured for any Payouts Network account and can be associated with any Instant Payout program. This allows teams to collect specific metadata fields for specific programs if desired.\n\n> Example: An airline wants to capture a booking ID and airport code when issuing an Instant Payout and appends this metadata to the specific Instant Payout record \n  \n\nMetadata fields can be provided via API when distributing an Instant Payout. Metadata fields configured for a program will also display as entry fields within the send flow for Instant Payouts in the console. Each field can be set as required or optional within the console UI.\n\nMetadata fields associated with a specific Instant Payout `claim` will be returned when calling the [Request Details](https://docs.payoutsnetwork.com/#cdd965ef-00e1-45f6-8045-252efd0e5b0d) API. They will also display in the Payout Detail view in the console, as well as the console activity export.\n\n# Drop-in UI\n\nThe purpose of the Drop-in UI is to allow Payouts Network partners to embed Instant Payouts directly within their own application or experience. The Drop-in UI enables partners to collect card data from Recipients within a partner-hosted CX while remaining outside of PCI scope. The Drop-in UI is hosted by Payouts Network, and all subsequent card tokenization and storage is within the scope of Payouts Network. Partners using the Drop-in UI are required to handle all Recipient-facing communications.\n\n## Sample Partner Application Flow\n\n<img src=\"https://content.pstmn.io/77da7996-38b0-4d00-9f46-849ffaca2847/ZHJvcC1pbiBzYW1wbGUucG5n\" width=\"443\" height=\"200\">\n\n## Look and Feel\n\nThe Drop-in UI can appear as a modal, or can be inserted without borders to fit seamlessly into your existing application. Custom fonts are currently not supported but are planned for a future release. Primary brand color, header text, and body text are pre-configured by Payouts Network per customer specifications.\n\n<img src=\"https://content.pstmn.io/150c5782-65e1-4a84-b8ec-401c7e55e25b/ZHJvcC1pbiBsb29rIGFuZCBmZWVsLnBuZw==\" width=\"457\" height=\"135\">\n\n## API Workflow\n\nThe following diagram illustrates the end-to-end API workflow for pushing funds to a Recipient’s card using the drop-in UI. First, a Recipient must be created, after which a card can be saved and associated with the Recipient using the Drop-in UI. After a card has been saved, the /payouts endpoint can be called in order to create a Payout and push funds to the card as many times as necessary. A card will remain saved on file until replaced or deleted.\n\n<img src=\"https://content.pstmn.io/6b1f53a7-75e7-44fa-b386-4b54abf032aa/UGljdHVyZTEucG5n\" width=\"461\" height=\"192\">\n\n### **Step 1: Create Recipient**\n\nCreate a `recipient` by calling the [Create Recipient](https://docs.payoutsnetwork.com/#2102d806-ddbf-4994-bc37-3664e7e59e73) API. The response to the [Create Recipient](https://docs.payoutsnetwork.com/#2102d806-ddbf-4994-bc37-3664e7e59e73) API request will include an `id` which will be required to authenticate the Drop-in UI in Step 2. You may optionally use the `email_address` as well.\n\n_Note: mailing address is required when creating a Recipient for the Drop-in UI._\n\n### **Step 2: Authenticate the Drop-in UI**\n\nAuthenticate the Drop-in UI by calling the [Authenticate Drop-in UI](https://docs.payoutsnetwork.com/#ef7748e9-ae46-4a76-ac84-862f64565833) API using the Recipient `id` or `email_address` from Step 1. This generates session tokens that need to be passed into the Drop-in UI. This session token allows the Drop-in UI to add a `card` to the `recipient` for which the session was generated.\n\nThe `AccessToken` is valid for an amount of time indicated by the ExpiresIn property. The `RefreshToken` allows the Drop In Card UI to request a new access token if the first expires while the user is still using the Drop-in UI.\n\n### **Step 3: Initialize the Drop-in UI & Capture the Card Create Response**\n\nThe Drop In Card UI consists of an iframe which will allow the user to enter Card Information without increasing your PCI-scope.\n\n#### Communication Basics\n\nCommunication between your application and the Drop In Card UI iFrame is done using the postMessage API ([https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage)), using redux-style Actions as the message data. Actions will always have a \"type\" property indicating what action has occurred, as well as an optional payload property which will carry the data in the message.\n\n#### Load the iFrame\n\nWithin your application, load the Drop In Card UI in an html iframe\n\n<h4>Initialization</h4>\n\n<p>To initialize, an \"INITIALIZE\" action needs to be sent to the iFrame. This action contains the authentication information and what Program to use for color and branding purposes. The Program needs to be defined with Payouts Network prior to use.</p>\n\n<p>Payload Property:</p>\n\n<ul><li><div>Authentication: The session token information retrieved from the<a rel=\"noreferrer noopener nofollow\" href=\"https://docs.payoutsnetwork.com/#ef7748e9-ae46-4a76-ac84-862f64565833\" target=\"_blank\" url=\"https://docs.payoutsnetwork.com/#ef7748e9-ae46-4a76-ac84-862f64565833\">Authenticate Drop-in UI</a>API</div></li><li><div>Program: The nickname of the program to use</div></li></ul>\n\n```\n{ \n \"type\": \"INITIALIZE\", \n \"payload\": { \n \"AuthenticationResult\": { \n \"AccessToken\": <string containing the Access Token>, \n \"ExpiresIn\": <number indicating the token expiration in seconds>, \n \"IdToken\": <string containing the ID Token>, \n \"RefreshToken\": <string containing the Refresh Token> \n \"TokenType\": \"Bearer\" \n }, \n \"program\": <string containing program_nickname> \n } \n} \n\n ```\n\n<h4><br>Card Create Response</h4>\n\n<p>Once a user has successfully added a <code>card</code>, the Drop-in UI will send a message back to your application with a <code>SUCCESS_CARD_CREATE</code> action. If any errors occurred during the creation, a message with a <code>FAIL_CARD_CREATE</code> will be sent, along with relevant error information.</p>\n\n<p>You can test adding a card in the Drop-in UI by using any of the following card numbers:</p>\n\n| **Card Number** | **Pass/Fail** |\n| --- | --- |\n| 4622943120000006 | Pass |\n| 4622943120000014 | Pass |\n| 4622943120000022 | Pass |\n| 4622943120000030 | Pass |\n| 4622943120000048 | Pass |\n\n<p><b>Successful Card Creation Action</b></p>\n\n```\n{ \n \"type\": \"SUCCESS_CARD_CREATE\", \n \"payload\": { \n \"cardId\": <string with the new card ID> \n } \n} \n\n ```\n\n<p><b>Failed Card Creation Action</b></p>\n\n```\n{ \n \"type\": \"FAIL_CARD_CREATE\", \n \"payload\": { \n \"message\": <string with the friendly message supplied to the user>, \n \"code\": <string with the unique error code associated with the error> \n } \n} \n\n ```\n\n### Drop-in UI iFrame Sample\n\nContact your Payouts Network representative for a sample html snippet for instantiating the Drop-in UI. Note: the sample snippet must be run on a web server.\n\n<h3><b>Step 4: Create and Approve Payout</b></h3>\n\n<p>Now that a <code>card</code> has been created for a given <code>recipient</code>, the<a href=\"https://docs.payoutsnetwork.com/#2549fdad-b189-45c1-b5fb-f50dbf611d17\">Create Payout Request API</a>can be used to set up a Payout Request for the given <code>recipient</code>. Create the Payout Request using the<a href=\"https://docs.payoutsnetwork.com/#2549fdad-b189-45c1-b5fb-f50dbf611d17\">Create Payout Request</a>API. Capture the <code>rid</code> from the response body, as this will be required to complete Step 5 below.</p>\n\n<p>Finally, set the Payout Request to approved using the<a href=\"https://docs.payoutsnetwork.com/#b35e0f6a-f2cb-460f-9ad2-7ed2cb65cf01\">Change Status of Payout Request</a>API by changing the Payout <code>state</code> to <code>PAYOUT-001</code>.</p>\n\n<h3><b>Step 5: Push Funds to Debit Card</b></h3>\n\n<p>Once a Payout for the given Recipient has been created and approved, the final step is to initiate the transfer of funds to the Recipient's <code>card</code> using the<a href=\"https://docs.payoutsnetwork.com/#fca42ffe-03ec-4e27-a741-28415de534c4\">Claim Money</a>API. This will transfer funds to the Recipient's <code>card</code> on file using the Recipient's <code>card_id</code> and the <code>claim</code> <code>rid</code> from the <code>payout</code>. Transfers to cards typically complete within seconds, but may take up to 30 minutes to become available within the Recipient's checking account.</p>\n\n<h3>Handling Exceptions</h3>\n\nThe following flows illustrate the two primary exception scenarios (failure or timeout) and how to handle them. For either scenario, we strongly recommend that the same `claim` `rid` is used in any retry attempts, as opposed to creating a new `payout` and `claim`. This allows for a detailed historical audit to be stored regarding a singular `claim` which can be returned in the Payout Request Details API or the Recipient Details API. This is particularly useful for support requests regarding a claim in which an API or console user can see the full lifecycle of a particular claim, including every error and card that was used in the claim attempt.\n\n_**Note**__**__**__: Failure to use the same_ `claim` _in any retry scenario and instead creating a new payout request may lead to duplicate payments to the same individual_. If a new `claim` must be created, ensure that the original `claim` is [cancelled ](https://docs.payoutsnetwork.com/#e10e2872-7b2c-4305-9025-6d74ab91c1fb) _**before creating a new payout request**_.\n\n#### Scenario 1 - Claim failure\n\n<img src=\"https://content.pstmn.io/4ea4c5cb-bc42-4abe-8b08-d1dd41f04985/cGF5b3V0X2ZhaWxfc2VxdWVuY2UucG5n\" width=\"497\" height=\"236\">\n\n#### Scenario 2 - Claim timeout\n\n<img src=\"https://content.pstmn.io/9273c338-e774-474c-84ee-6dd64dbb7fd8/cGF5b3V0X3RpbWVvdXRfc2VxdWVuY2UucG5n\" width=\"477\" height=\"256\">\n\n<h1>Guide: Digital Credits</h1>\n\n<p>The following steps outline the general workflow for implementing Digital Credits:</p>\n\n<img src=\"https://content.pstmn.io/91ca7b46-f158-427a-b42e-9fbf426227fa/RENBUEl3b3JrZmxvdy5wbmc=\" width=\"485\" height=\"86\">\n\n<p><b>Step 1 - Establish Digital Credit Program(s) -</b> Prior to disbursing a Digital Credit (voucher), a program must be pre-configured with the desired Digital Credit attributes. Programs can be configured by Payouts Network upon request. Upon creating the program, Payouts Network will return a program <code>nickname</code> that must be included in the<a href=\"https://docs.payoutsnetwork.com/#40475d4b-fc48-4cce-81d6-e8a0d06edd27\">Distribute Voucher</a>API request.</p>\n\n<p><b>Step 2 - Distribute Digital Credit (Voucher) -</b> Once a Digital Credit program has been established, the Digital Credit can be distributed to a Recipient using the<a href=\"https://docs.payoutsnetwork.com/#40475d4b-fc48-4cce-81d6-e8a0d06edd27\">Distribute Voucher</a>API.</p>\n\n<p><i>Note: You can simulate the end-to-end redemption experience by first distributing a voucher, then activating the voucher (using a test card listed below), then simulating a voucher redemption using the</i><a href=\"https://docs.payoutsnetwork.com/#f93ec610-c62d-4a3b-9106-7172db2ee65a\"><i>Qualified Transactions</i></a><i>API.</i></p>\n\n<p><b>Step 3 - Monitor Activity -</b> Using<a href=\"https://docs.payoutsnetwork.com/#webhooks\">webhooks</a>, you can monitor the state of all Digital Credits in real time (<i>coming soon).</i></p>\n\n## Digital Credit Test Cards\n\nUse one of the following test card numbers in the Digital Credit activation flow to test card activation. Once activated, you can simulate a redemption using the [Qualified Transactions](https://docs.payoutsnetwork.com/#f93ec610-c62d-4a3b-9106-7172db2ee65a) API.\n\n| **Card Number** | **Pass/Fail** |\n| --- | --- |\n| Contact your Payouts Network representative for Digital Credit PANs that will pass activation | Pass |\n| 4111111111111111 | Fail |\n| 4222222222222222 | Fail |\n\n<h2>Digital Credit Program Attributes</h2>\n\n<p>Digital Credit programs inform the end-to-end Recipient experience of receiving, activating, and redeeming a Digital Credit (voucher). This includes all email notifications and the white labeled web-based activation flow. When configuring a program, Payouts Network will provide integrators with a detailed configuration document and samples of the UI.</p>\n\n<table><tbody><tr><th><b>Program Attribute</b></th><th><b>Description</b></th></tr><tr><td><div>Qualifying Merchant Locations</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Qualifying merchants or merchant categories where the Recipient can redeem their Digital Credit</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Brand Logo URL</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Brand logo that is surfaced in the consumer claim flow and email notifications</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Hero Image URL</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Hero image presented to Recipient on the Digital Credit landing page</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Email Message Body</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Optional email message describing Digital Credit to Recipient</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Landing Page Description</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Optional descriptor text for Digital Credit landing page</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Primary Brand Color</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Primary brand color reflected in the consumer claim flow (CTA buttons etc) and email notifications</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Secondary Brand Color</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Secondary brand color reflected in the consumer claim flow (hyperlinked text etc)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Sent From Email Address</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>e.g. your_co@payoutsnetwork.com- all emails delivered by Payouts Network to customers will be from this address</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Reply To Email Address</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>e.g. your_co@payoutsnetwork.com</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Sent From Email Name</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>e.g. Your_co</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Sent By Name</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The Sender Name displayed to the Recipient within the claim flow</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Default Voucher Values</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Default values that are displayed in the console when issuing a Digital Credit (voucher). Example: $10, $20, $30, $40</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Custom Voucher Value</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Optional: displays a custom value entry field in the Digital Credit (voucher) issuance flow which enables the user to enter a custom dollar value. This can be hidden or displayed for each program.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h2>Digital Credit Notifications</h2>\n\n<table><tbody><tr><th><b>Message Type (Email)</b></th><th><b>Description</b></th></tr><tr><td><div>Digital Credit Issued</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>White labeled email notifying Recipient that they have received a Digital Credit (voucher) from a business. This email contains a custom message from the business, days before expiration, and a link to activate your Digital Credit.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Digital Credit Activated</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>White labeled email notifying Recipient that their Digital Credit has been activated. This email contains additional information about how to redeem as well as a link back to the Digital Credit description/landing page.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Digital Credit Redeemed</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>White labeled emailed notifying Recipient that their Digital Credit has been Redeemed. This email includes the value redeemed and value remaining.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h2>Digital Credit Metadata Fields</h2>\n\n<p>Optional metadata fields may be configured for any Payouts Network account and can be associated with any Digital Credit program. This allows teams to collect specific metadata fields for specific programs if desired.</p>\n\n<blockquote>Example: An airline wants to capture a booking ID and airport code when issuing a Digital Credit and appends this metadata to the specific Digital Credit record</blockquote>\n\n<p>Metadata fields can be provided via API when distributing a Digital Credit. Metadata fields configured for a program will also display within the Digital Credit issuance flow in the console. Each field can be set as required or optional within the console UI.</p>\n\n<p>Metadata fields associated with a specific Digital Credit will be returned when calling the<a href=\"https://docs.payoutsnetwork.com/#e0722184-bf65-48ae-828c-522e1303bbde\">Voucher by ID</a>API. They will also display in the Voucher Detail view in the console, as well as the console activity export.</p>\n\n<h1>Authentication</h1>\n\n<p>Authentication to the API involves receiving an invite to the Payouts Network Web Console.</p>\n\n<p>All requests are authenticated by either Bearer tokens issued by our OIDC provider or with service account credentials. They are both processed on the same Header key/value pattern.</p>\n\n<p>By adding the <code>Authorization</code> header, you can authenticate a service account and complete any of the requests that the key is authorized to make (e.g.)</p>\n\n<p><code>Authorization: Bearer ReAlLySeCrEtSeRvIcEaCcOuNt</code></p>\n\n<h1>Querying Collections</h1>\n\n<p>Certain service endpoints feature a special DSL (Domain Specific Language) specification that enables fast searches against a potentially large dataset. Some of these endpoints also provided aggregate data calculations, further simplifying your integration. The following endpoints can use these features:</p>\n\n<ol><li><div><code>/recipients</code></div></li><li><div><code>/payouts</code></div></li><li><div><code>/vouchers</code></div></li><li><div><code>/activity</code></div></li><li><div><code>/statements</code></div></li></ol>\n\n<h2>Query Parameters</h2>\n\n<table><tbody><tr><th>Name</th><th>Description</th><th>Default Value</th></tr><tr><td><div>page</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>A positive integer that specifies the page number to use.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>1</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>page_size</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The maximum number of items to return in a response body. Note - <code>page_size</code> in excess of 1000 may result in an error message due response size limitations. If you receive a http response code other than \\`200\\` try lowering the \\`page_size\\` param.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>10</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>sort</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>A comma delineated list of how to sort the results where the order of occurrence informs the precedence.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>-</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>search</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>keywords, text, numeric, or date selection criteria to be used <i>after aggregates are calculated. See more details below.</i></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>-</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>filter</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>keywords, numeric, or date selection criteria that will affect aggregate calculations but will provide slightly improved performance.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>-</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<p><b>NOTE</b> Not all <code>search</code> query fields can be used with <code>filter</code> query fields. For instance, you will not be able to <i>filter on </i><code><i>recipient.name</i></code><i>, but you can certainly search with it. If you would like to filter on a recipient, you must use the </i><code><i>recipient.id</i></code><i> instead.</i></p>\n\n<h2>Operators</h2>\n\n<p>The following characters allow comparison against fields within a specific collection. The following checks are supported</p>\n\n<ul><li><div><code>:</code> - Equals</div></li><li><div><code>:&gt;</code> - Greater than</div></li><li><div><code>:&lt;</code> - Less than</div></li></ul>\n\n<h4>Wildcard/Fuzzy Searching</h4>\n\n<p>Using an asterisk, you can accomplish a \"fuzzy\" search.</p>\n\n<p>Example: ?search=\\\\\\\\\\\\\\\\\\\\\\\\\\\\*:bob</p>\n\n<p>However, this fuzzy search only looks at text fields.</p>\n\n<p><b>NOTE</b> Fuzzy/Wildcard searching cannot be used with the <code>filter</code> query parameter.</p>\n\n<h4>Argument Chaining w/ <code>filter</code> &amp; <code>search</code></h4>\n\n<p>It is possible to query more than one field using a list of field/argument pairs that are comma delineated.</p>\n\n<p><b>NOTE</b> Always URL encode your arguments. Do not encode the entire query parameter as that will have undesired effects</p>\n\n<p><b>Examples specifying one or many arguments</b></p>\n\n<ul><li><div><code>?filter=name:Bob Ross</code></div></li><li><div><code>?search=name:Bob,product:mesa,state.code:RECIPIENT-000</code></div></li></ul>\n\n<h2>Field Specification</h2>\n\n<p>Using dot notation, you can select nested fields on an entity when specifying your search criteria.</p>\n\n<p>For example, if the entity looks like:</p>\n\n```\n{\n    \"id\": 1,\n    \"created_by\": {\n        \"name\": \"Ted Turner\"\n        \"email\": \"ted.turner@gmail.com\"\n    }\n}\n\n ```\n\n<p>You can search the name field by specifying <code>created_by.email:</code></p>\n\n<p><b>Constraints</b></p>\n\n<p>Currently there is no way to specify fields that are within a nested array.</p>\n\n<h2>Date Ranges &amp; Numeric Types</h2>\n\n<p><b>Constraints</b></p>\n\n<ol><li><div>All date ranges supplied must be in a complete, extended<a rel=\"noreferrer noopener nofollow\" href=\"http://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" url=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a>timestamp (including timezone). You <i>must URL encode these timestamps.</i></div></li><li><div>You must URL encode date arguments. For instance, <code>2019-01-01T00:00:00.000Z</code> will become <code>2019-01-01T00:00:00.000Z</code></div></li></ol>\n\n<p><b>Example</b> <code>?search=object.created:&gt;2019-01-01T00:00:00.000Z</code></p>\n\n---\n\n<h2>Response Body</h2>\n\n<p>Every collection response will envelope the data within an object that also expresses metadata about the result set. The structure looks like the following:</p>\n\n```\n{\n    \"object\": \"collection\",\n    \"page\": {\n        \"total\": 1000,\n        \"pages\": 100,\n        \"page\": 1,\n        \"per_page\": 10,\n        \"has_next\": true\n    },\n    \"data\": [\n        ...\n    ],\n    \"aggregates\": {\n        ...\n    }\n}\n\n ```\n\n<h4>object</h4>\n\n<p>Value is always \"collection\"</p>\n\n<h4>page</h4>\n\n<table><tbody><tr><th>Key</th><th>Description</th></tr><tr><td><div><code>total</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The total number of entities. Affected by the <code>filter</code> query parameter.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>pages</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Based on the pagination options, the number of pages to iterate on to examine all the entities</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>page</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The current page number</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>per_page</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The maximum number entities that could be included in the response</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>has_next</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Whether or not incrementing the page would return more than zero entities</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h3>data</h3>\n\n<p>An array representing the collection of resources specified by the service endpoint.</p>\n\n<h3>aggregates</h3>\n\n<p>An object that may be included if and only if the collection endpoint has this enabled. If present, the properties of the object will vary. When you use the <code>filter</code> query parameter, these calculations <i>are affected. Conversely, </i><code><i>search</i></code><i> query parameters do not affect these calculations.</i></p>\n\n---\n\n<h4>Provided Examples</h4>\n\n<p>Suppose we have the following search requirements:</p>\n\n<ol><li><div>I want to filter and select all the activity sent with a value greater than $20 <i>after 2018. I also want the aggregate calculations to only consider my criteria.</i></div></li><li><div>I want to find any activity directly related to issuances by my employee Adam Williams <i>between 2018 and 2020. I want the aggregate calculations ignore my criteria completely.</i></div></li><li><div>I want aggregate calculations just on activity <i>between 2018 and 2020 and see all of Bob's activity within 2018. I want the default page size, but I am interested in page 3 specifically. I found Bob's recipient ID and it is </i><code><i>1</i></code><i>.</i></div></li><li><div>I want to see all my expired vouchers without any redemptions before 2020, but I want my aggregates to not be affected. I want them in descending order based on their creation date. I want no more than 1 entity per page.</div></li></ol>\n\n<p>The following query parameters will implement desired results:</p>\n\n<ol><li><div><code>/activity?filter=object.properties.value:&gt;20,object.created:&gt;2019-01-01T00:00:00.000Z</code></div></li><li><div><code>/activity?search=object.created_by.name:Adam Williams,object.created:&gt;2018-01-01T00:00:00.000Z,object.created:&lt;2019-01-01T00:00:00.000Z</code></div></li><li><div><code>/activity?filter=object.properties.recipient.id:1,object.created:&gt;2018-01-01T00:00:00.000Z,object.created:&lt;2019-01-01T00:00:00.000Z&amp;page=3</code></div></li><li><div><code>/vouchers?filter=state.code:VOUCHER-008&amp;search=issued_on:&lt;2020-01-01T00:00:00.000Z&amp;page_size=1</code></div></li></ol>\n\n---\n\n<h1>Webhooks</h1>\n\n<p>Webhooks are used to notify your application any time an event state change occurs within your account. They can be setup and configured for any or all of the following state change events within the Payouts Network platform:</p>\n\n<table><tbody><tr><th><b>Event Name</b></th><th><b>Description</b></th></tr><tr><td><div><code>payout:created</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>An individual webhook per PAYOUT sent when a Payout is first created</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>payout:approved</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>An individual webhook per PAYOUT sent when a Payout is approved</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>payout:canceled</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when all individual Claims within a Payout have been deactivated/canceled</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>claim:deactivated</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when an individual Claim within a Payout is deactivated/canceled by a console user</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>claim:expired</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when an individual Claim expires</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>claim:payout</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when an individual Claim is successfully claimed by the Recipient (funds have been transferred)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>claim:nameverification</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when a Recipient fails final name verification during OCR scan flow (i.e. their name on card does not match the name provided by the Originator). <b>Note: only applicable to accounts with OCR card scan enabled.</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>claim:ofacfailed</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when a Recipient fails the OFAC check during the claim flow. <b>Note: only applicable when the Recipient provides their own mailing address -- not applicable if the Originator provides the mailing address during Recipient creation.</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>claim:failed</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when a claim fails and includes a detailed error message relating to failure</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>voucher:issued</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent upon voucher creation and issuance to customer</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>voucher:activated</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when the consumer links a credit card to the voucher</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>voucher:redeemed</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when a consumer credit card redemption is successfully processed (can have multiple redemptions per a single voucher)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>voucher:expired</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sent when the voucher expires. This event occurs when a voucher has no redemptions or is partially redeemed.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h2>Configuration</h2>\n\n<p>To configure a webhook the following details are required:</p>\n\n```\n\"default\": {\n    \"enabled\": true,\n    \"hostname\": \"localhost\",\n    \"method\": \"POST\",\n    \"path\": \"webhooks\",\n    \"protocol\": \"https\",\n    \"tls\": true\n}\n\n ```\n\n<blockquote>Note: For all production webhooks, a valid TLS 1.2 and HTTPS server certificate supported endpoint is required</blockquote>\n\n<p>Webhooks can be configured individually based on the event which occurs, for example:</p>\n\n```\n\"payout:approved\" {\n    \"enabled\": true,\n    \"hostname\": \"localhost\",\n    \"method\": \"POST\",\n    \"path\": \"webhooks/approved\",\n    \"protocol\": \"https\",\n    \"tls\": true\n}\n\n ```\n\n<p>Furthermore, webhooks can be disabled on a individual basis if you do not wish to receive notification for any specific event - <code>\"enabled\": false</code></p>\n\n<h2>Payload</h2>\n\n<p>Webhooks provide all the relevant information about the event that occurred, which includes:</p>\n\n<ul><li><div><code>id</code>: Resource ID of the object, within the Payouts Network platform, for which the event occurred</div></li><li><div><code>object_type</code>: The type of object (payout or claim)</div></li><li><div><code>event_type</code> The event which occurred, (created, approved, payout, expired)</div></li></ul>\n\n<p>By <b>default</b>, when a webhook event is triggered, Payouts Network will submit a HTTP/HTTPS POST request, with the payload shown below, to any URL endpoint defined.</p>\n\n```\n{\n    \"id\": \"1000000000000000001\",\n    \"object_type\": \"payout\",\n    \"event_type\": \"approved\"\n}\n\n ```\n\n<h2>Responding to Webhook Events</h2>\n\n<p>In order to provide Payouts Network with a successful receipt of a webhook event, you must acknowledge and respond with a <code>2XX</code> HTTP status code. It is in best practice to acknowledge the webhook event prior to any logic that takes place in order to prevent timeouts.</p>\n\n<p>All response code outside of this range will indicate to Payouts Network that you did not receive the webhook event.</p>\n\n<h3>Handle duplicate events</h3>\n\n<p>Webhook endpoints may occasionally receive the same event more than once. We advise you to guard against duplicated event receipts by making your event processing idempotent. One way of doing this is logging the events you’ve processed, and then not processing already-logged events.</p>\n\n<h3>Retry Logic</h3>\n\n<p>Payouts Network can retry a webhook/s simply by being provided a time frame for which to replay or the resource ID of a specific object.</p>\n\n<blockquote>Note: When requesting a specific resource ID to be replayed, all events which have occurred will be submitted.</blockquote>\n\n<p>Please reach out to our support team with one of the previously listed information to request a replay: support@payoutsnetwork.com</p>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2756631","collectionId":"2e56e934-3dd4-409f-be75-34ec2ed3d0f1","publishedId":"SVSBureF","public":true,"publicUrl":"https://docs.payoutsnetwork.com","privateUrl":"https://go.postman.co/documentation/2756631-2e56e934-3dd4-409f-be75-34ec2ed3d0f1","customColor":{"top-bar":"FFFFFF","right-sidebar":"0A3ACA","highlight":"0A3ACA"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-11-08T01:47:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Prod (Integration)","id":"841e40a8-5c21-4227-bc7d-65c25b094a0e","owner":"2756631","values":[{"key":"scheme","value":"https","enabled":true,"type":"default"},{"key":"legacy_api","value":"tx.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"serverless_partner_api","value":"api.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"serverless_consumer_api","value":"app.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"serverless_authorization_api","value":"api.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"mesa_client_id","value":"1b0pg7pfs91r8jv4bknvq1h3da","enabled":true,"type":"default"},{"key":"apex_client_id","value":"579uan8cbqkp2pnkofgr84gn49","enabled":true,"type":"default"},{"key":"admin_client_id","value":"1daqlfnl25h50svv6pvtsp50jn","enabled":true,"type":"default"},{"key":"admin_access_token","value":"eyJraWQiOiI3cm5GSldUc05EMXZcL2RPaVwvb05vT2pPSFNWemNSQmwycTBYUEduUlIyb3c9IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkZWMxOWNmMy1mYjg3LTRhMTUtYmNmMS0zZGQxMjEwYWQxNTkiLCJldmVudF9pZCI6ImY3NWQxZTY1LTlkYmEtNDcwNy04MDJiLWExYzBkODlhOGEwMCIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYXdzLmNvZ25pdG8uc2lnbmluLnVzZXIuYWRtaW4iLCJhdXRoX3RpbWUiOjE2MDUxMTkwOTksImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC51cy1lYXN0LTEuYW1hem9uYXdzLmNvbVwvdXMtZWFzdC0xX1Y0d2FMOE5hVCIsImV4cCI6MTYwNTEyMjY5OSwiaWF0IjoxNjA1MTE5MTAxLCJqdGkiOiIyOTA2NjBhMy0wNzQ5LTRhOWUtODI0ZS0wNTA5ODY0N2RhYjMiLCJjbGllbnRfaWQiOiIxZGFxbGZubDI1aDUwc3Z2NnB2dHNwNTBqbiIsInVzZXJuYW1lIjoiZGVjMTljZjMtZmI4Ny00YTE1LWJjZjEtM2RkMTIxMGFkMTU5In0.IM3zmbe_lkzneIur5c_4pNJTu70nmmMxFXm3rXuwn31Z_IO2Tz0akdmwfSu3t7FGgZCrmy3QHLkiWgbmuiopOLJSY1zI6HIjgVbx4J_41BDgaxrLks7i03qe6-fgL4IwjAmAdEROROg9TrOlLkprtmxzyfEIbXqq9DW78pzalEhZpV0nq2xSuYOLOCYfiWZK4Yd6rxzr7X--v0n1tmUPnWc_9mVWDT-qW58kvlus8wYIuv4ofhXfnH9QlikryvxKcKbdJADsVyqLIoNOYC70I-VG4hwkeDYTI8z3rgLtNyY70W4VCIV2GjgCVWjcvkjAEMKvsM8wFhWAdYr6A7Uk1g","enabled":true,"type":"default"},{"key":"role_id","value":"","enabled":true,"type":"default"},{"key":"payout_id","value":"651031612489729454","enabled":true,"type":"default"},{"key":"voucher_id","value":"640838430359553428","enabled":true,"type":"default"},{"key":"api_key","value":"","enabled":true,"type":"default"},{"key":"recipient_id","value":"650895884812289161","enabled":true,"type":"default"},{"key":"claim_id","value":"651031612489729455","enabled":true,"type":"default"},{"key":"linked_offers","value":"tx.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"serverless_admin_api","value":"admin.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"apex_cognito_session","value":"8YcS7XyDO2RwdexkQXVWxqDC097Z1IKEd_XEZdLvmC84DaLsmsJapiz-7HKyOqqsAvl_2iSqCWoaZzl28GuSGl_EzGUgOE63X0evqqzPAoHwVWtPsQZDfLL1ZxM969rJ6te-PU2MTNCU5mvUUovPX0Yi5F_qmLxEEbkWtVb2LekoFwWYW_CWEYT_8NDhUtJNSzrRvIQx0a4GLjmYp_LK7uSCiI5M77rXMFQjNqgllqtueQHMIIb8YtrDbvhtH59qr_V_lX7nZZpHp0IcoOWYlU3fREzNbeBZhu2RFt7qBSYq9HoL4QKzgiyiCRoDe90lShkPrQkwXdCl-n_6ZYfV1eI7DZYJuk45VH82vdDKay3hJLa6EiSFEhqKutZWi7UBbJjw3oLqahKsa-A5UQr2I7XPR6UWphwlz1wWw0jg9VOP5mCv-Zk7rsIASrO08pRNrk9rlehSTouZUM78rfniQ4C0whQt3vqUe0a4ZzwGsmjGjA8Lj5JalDMf1g4-KVTh-KR0yhZOwRYvCqWVGqSD4Uw64JjzhcUvFGjrN2sbCd-vW7CMTp4j9PGnWV6wDHVZgfmD7gKnSsEx0Lxbx0xX4xqMT510nEhWeA_amBuoyNhM21Gy_QCpc71fbeuQrD93vCuzw_m2p2QdTR_DVJSTLA_I8lvj1ZKr2sxLlJ6y2pMKBkhI3kXEBJqHBhrofZLLsBCEYugkpkzK2djjRbcZr20GZfgxJzSa_OqzaMeNMIaBnlrlx46fFGA-IX2Zb75ban_rfiEtlpb09jDiYUl1PvcY_Nt0DY62g8l1F1gi7FTWpjCF0iRkcV6eXL_BagKTGrirN1p7Ft1SVr5iYMNJZ2sTy4qUD58lYepP9Ve7Xbu3I7IrUIEgOrEP6BlL6EDLYmIXKJgQk9pUq1TyiskMVxchqoS9Bvl4kDuVZGhWRsObvLzSCSEndNi-nBy1vE2guoAGs5SAIxBez0hyrivaW0F_gLUYHbOdnrHftcn9rSBRdn2raNX4GmHsYlHi1Mfi9ZH2VSwksbaaRFi9d0uCbcpRuIFB4jM2LxXOzVy3Z8Ns5FdVUulEtBCZ2O4","enabled":true,"type":"default"},{"key":"program_id","value":"baggage_delay_preview","enabled":true,"type":"default"},{"key":"distribution_id","value":"295132494561281068","enabled":true,"type":"default"},{"key":"enrollment_api","value":"enrollments.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"enrollment_api_key","value":"gSy78TgSy78TRNSuKaZXJzByP4ArPHiSbykW39IE1n2g9c2AB3b25kZXJfdGVjaG5vbG9naWVzRNSuKaZXJzByP4ArPHiSbykW39IE1n2g9c2AB3b25kZXJfdGVjaG5vbG9naWVz","enabled":true,"type":"default"},{"key":"CCPA_remove_user","value":null,"enabled":true,"type":"default"},{"key":"amount","value":"11","enabled":true,"type":"default"},{"key":"mesa_rid","value":"MNp7ZfZSJ","enabled":true,"type":"default"},{"key":"rid","value":"ZiGwwe0DWK","enabled":true,"type":"default"},{"key":"random_Four","value":"4089","enabled":true,"type":"default"},{"key":"random_Two","value":"99","enabled":true,"type":"default"},{"key":"unix_time","value":"1591914089","enabled":true,"type":"default"},{"key":"enrollment_id","value":"306789589450753690","enabled":true,"type":"default"},{"key":"reference_id","value":"MOCK1591918651","enabled":true,"type":"default"},{"key":"gift_id","value":"306785185431553597","enabled":true,"type":"default"},{"key":"loyalty_api","value":"","enabled":true,"type":"default"},{"key":"unix_Time","value":"1592236297","enabled":true,"type":"default"},{"key":"randNum","value":"","enabled":true,"type":"default"},{"key":"enrollment_api_key-FIS","value":"aj-gmzAwgh_kP5OqqCpHXXSpDncjN4aCbf4HnUYi0uVmaXM","enabled":true,"type":"default"},{"key":"offer_id","value":"","enabled":true,"type":"default"},{"key":"serverless_consumer_mesa_api","value":"app.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"program","value":"preview_baggage_voucher","enabled":true,"type":"default"},{"key":"CyberSourceOrg","value":"","enabled":true,"type":"default"},{"key":"scope_id","value":"","enabled":true,"type":"default"},{"key":"account_client_id","value":"4te186fc32v9hr8ppbcbr9cn9c","enabled":true,"type":"default"},{"key":"account_cognito_session","value":"","enabled":true,"type":"default"},{"key":"consumer_access_token","value":"","enabled":true,"type":"default"},{"key":"serverless_consumer_profile_api","value":"account.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"gowonder_api","value":"api.prodint.gowonder.com","enabled":true,"type":"default"},{"key":"sms_id","value":"","enabled":true,"type":"default"},{"key":"card_id","value":"","enabled":true,"type":"default"},{"key":"integration_layer_access_token","value":"","enabled":true,"type":"default"},{"key":"integration_layer_api","value":"integration.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"randomAmount1","value":"","enabled":true,"type":"default"},{"key":"randomAmount2","value":"","enabled":true,"type":"default"},{"key":"expressRecipient1","value":"701476993236993759","enabled":true,"type":"default"},{"key":"expressRecipient2","value":"701480600338433809","enabled":true,"type":"default"},{"key":"serverless_communicator_api","value":"api.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"visaDirectCard","value":"4622943120000048","enabled":true,"type":"default"},{"key":"thunes_api_key","value":"z-sNpSPT0DBOSNxvULqb9gMn6bQCEaZ9r_mYwuF65kdwbmk","enabled":true,"type":"default"},{"key":"pni_thunes_api_key","value":"z-sNpSPT0DBOSNxvULqb9gMn6bQCEaZ9r_mYwuF65kdwbmk","enabled":true,"type":"default"},{"key":"mesa_cognito_session","value":"","enabled":true,"type":"any"},{"key":"privacy_form_id","value":"","enabled":true,"type":"any"},{"key":"tos_form_id","value":"","enabled":true,"type":"any"},{"key":"trx_form_id","value":"","enabled":true,"type":"any"},{"key":"payout_form_id","value":"","enabled":true,"type":"any"},{"key":"address_form_id","value":"","enabled":true,"type":"any"},{"key":"payout_consent_token","value":"","enabled":true,"type":"any"},{"key":"privacy_consent_token","value":"","enabled":true,"type":"any"},{"key":"tos_consent_token","value":"","enabled":true,"type":"any"},{"key":"trx_consent_token","value":"","enabled":true,"type":"any"},{"key":"address_consent_token","value":"","enabled":true,"type":"any"},{"key":"recipient_email","value":"","enabled":true,"type":"any"},{"key":"pni_thunes_monitor_card","value":"4622943120000006","enabled":true,"type":"default"},{"key":"card_api_access_token","value":"","enabled":true,"type":"any"},{"key":"serverless_card_api","value":"card-api.prodint.payoutsnetwork.com","enabled":true,"type":"default"},{"key":"cardlink_form_id","value":"","enabled":true,"type":"any"},{"key":"spirit_api_key","value":"QXv1cbD9H0lBjpLZdcw-deKNtAnMtWXoLoKrfcsJzeJzcGlyaXQ","enabled":true,"type":"default"},{"key":"payoutsnework_api_key","value":"j63UTrHsZO2HK4__u-w0dS-deCf1Q9zvCQNX_B8O5WdwYXlvdXRzbmV0d29yaw","enabled":true,"type":"default"},{"key":"fis_base_url","value":"olmretailrewardsuat.com","enabled":true,"type":"default"},{"key":"qa_env_5_api_key","value":"V2hN7I_M43DBP_UlYLuvBqC5UIP-NBmmHKcdHxjtE05wYXlvdXRzbmV0d29yaw","enabled":true,"type":"default"},{"key":"$mcsCardSuccess","value":"5107559999999945","enabled":true,"type":"default"},{"key":"phone_number","value":"+14065555555","enabled":false,"type":"default"},{"key":"qa_env_1_api_key","value":"TZkD-aWtO6sDUfkE9RXIKOrl6aUNHSeJSpQG0SBK89VwbmlfYmFuY29ycA","enabled":true,"type":"default"},{"key":"email","value":"qa","enabled":false,"type":"default"},{"key":"mesa_batch_hash","value":"","enabled":true,"type":"any"},{"key":"qa_env_6_api_key","value":"y1kV1OkCDD8cNb68kQUUJ3DNmu4BNPBlkzYK5x5m-9xwbmlfYmFuY29ycA","enabled":true,"type":"default"},{"key":"qa_org_6_program","value":"preview_voucher","enabled":true,"type":"default"},{"key":"qa_6_org_email","value":"","enabled":true,"type":"any"},{"key":"voucher_batch_hash","value":"","enabled":true,"type":"any"},{"key":"voucher_batch_title","value":"","enabled":true,"type":"any"},{"key":"voucher_batch_id","value":"","enabled":true,"type":"any"},{"key":"pni_cybersource_api_key","value":"","enabled":true,"type":"any"},{"key":"calsera_enrollment_email","value":"","enabled":true,"type":"any"},{"key":"enrollment_user_id","value":"","enabled":true,"type":"any"},{"key":"enrollment_euid","value":"","enabled":true,"type":"any"},{"key":"wonder_technologies_api_key","value":"","enabled":true,"type":"default"},{"key":"apex_voucher_batch_processing_tries","value":"","enabled":true,"type":"any"},{"key":"wonder_technologies_API_Key","value":"","enabled":true,"type":"default"},{"key":"mesa_batch_title","value":"","enabled":true,"type":"any"},{"key":"environment","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://payoutsnetwork.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Prod (Integration)","value":"2756631-841e40a8-5c21-4227-bc7d-65c25b094a0e"}],"canonicalUrl":"https://docs.payoutsnetwork.com/view/metadata/SVSBureF"}