{ "opencollection": "1.0.0", "info": { "name": "Core API", "version": "3.0.39" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "accepted countries", "type": "folder" }, "items": [ { "info": { "name": "Lists all accepted countries", "type": "http" }, "http": { "method": "GET", "url": "/v3/acceptedcountries", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of accepted countries to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "whitelist", "value": "", "type": "query", "description": "Whitelist" }, { "name": "search_type", "value": "", "type": "query", "description": "Search type" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all accepted countries" }, { "info": { "name": "Returns a specific accepted country", "type": "http" }, "http": { "method": "GET", "url": "/v3/acceptedcountries/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Accepted country token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns a specific accepted country" } ] }, { "info": { "name": "account holder groups", "type": "folder" }, "items": [ { "info": { "name": "Lists account holder groups", "type": "http" }, "http": { "method": "GET", "url": "/v3/accountholdergroups", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve. Count can be between 1 - 10 items." }, { "name": "start_index", "value": "", "type": "query", "description": "Indicates from what row to start returning data." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime." } ] }, "docs": "Lists account holder groups" }, { "info": { "name": "Creates an account holder group object", "type": "http" }, "http": { "method": "POST", "url": "/v3/accountholdergroups", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an account holder group object" }, { "info": { "name": "Returns a specific account holder group object", "type": "http" }, "http": { "method": "GET", "url": "/v3/accountholdergroups/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Account holder group token" } ] }, "docs": "Returns a specific account holder group object" }, { "info": { "name": "Updates an account holder group object", "type": "http" }, "http": { "method": "PUT", "url": "/v3/accountholdergroups/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an account holder group object" } ] }, { "info": { "name": "Credit Accounts", "type": "folder" }, "items": [ { "info": { "name": "List accounts", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts", "params": [ { "name": "card_token", "value": "", "type": "query", "description": "Unique identifier of the credit card associated with the account." }, { "name": "count", "value": "", "type": "query", "description": "Number of credit account resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." }, { "name": "light_response", "value": "", "type": "query", "description": "If `true`, returns a lightweight response without any balances and usages." }, { "name": "secured_account_token", "value": "", "type": "query", "description": "Unique identifier of an existing secured account.\nThis field is required when policy product subtype is `SECURED`." }, { "name": "user_token", "value": "", "type": "query", "description": "Unique identifier of the user by which to filter accounts." } ] }, "docs": "Retrieve an array of credit accounts.\n\nThis endpoint supports <>." }, { "info": { "name": "Retrieve account", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token", "params": [ { "name": "effective_fee_schedule_only", "value": "", "type": "query", "description": "Display the effective fee schedule only." }, { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account to retrieve.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "light_response", "value": "", "type": "query", "description": "If true, returns a lightweight response without any balances and usages." } ] }, "docs": "Retrieve a credit account." }, { "info": { "name": "Update account", "type": "http" }, "http": { "method": "PUT", "url": "/v3/accounts/:account_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account to update.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a credit account." } ] }, { "info": { "name": "Account Transitions", "type": "folder" }, "items": [ { "info": { "name": "List account transitions", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/accounttransitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve transitions.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of account transition resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`." } ] }, "docs": "Retrieve an array of transitions on a credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Transition account status", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/accounttransitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to transition a status.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transition a credit account to a new status." }, { "info": { "name": "Retrieve account transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/accounttransitions/:token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve a transition.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the account transition you want to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/accounttransitions` to retrieve existing account transition tokens." } ] }, "docs": "Retrieve a transition for a credit account." }, { "info": { "name": "Resend credit event notification", "type": "http" }, "http": { "method": "POST", "url": "/v3/webhooks/:event_type/:resource_token", "params": [ { "name": "event_type", "value": "", "type": "path", "description": "Specifies the type of event you want to resend." }, { "name": "resource_token", "value": "", "type": "path", "description": "Unique identifier of the resource for which you want to resend a notification.\n\n* Send a `GET` request to `/credit/accounts/{account_token}/journalentries` to retrieve existing journal entry tokens.\n* Send a `GET` request to `/credit/accounts/{account_token}/ledgerentries` to retrieve existing ledger entry tokens.\n* Send a `GET` request to `/accounts/{account_token}/accounttransitions` to retrieve existing account transition tokens.\n* Send a `GET` request to `/credit/accounts/{account_token}/payments/{payment_token}` to retrieve existing payment transition tokens.\n* Send a `GET` request to `/accounts/{account_token}/statements` to retrieve existing statement summary tokens.\n* Send a `GET` request to `/accounts/{account_token}/delinquencystate/transitions` to retrieve existing delinquency state transition tokens.\n* Send a `GET` request to `/accounts/{account_token}/statements/{statement_summary_token}/paymentreminders/{token}` to retrieve existing payment reminder tokens.\n* Send a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens.\n* Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens and identify the specific account for the resend event." } ] }, "docs": "Resends a credit event notification to your webhook endpoint.\n\nAlthough you send this request as a `POST`, all parameters are passed in the URL and the body is empty.\nThe event notification is resent to your webhook endpoint and also returned in the response to this request.\n\nFor details on how to configure your webhook endpoint, see the About Webhooks <>.\nFor the complete `/webhooks` endpoint reference, see <>." } ] }, { "info": { "name": "Adjustments", "type": "folder" }, "items": [ { "info": { "name": "List account adjustments", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/adjustments", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve adjustments.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of account adjustment resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." } ] }, "docs": "Retrieve an array of adjustments for a credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Create account adjustment", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/adjustments", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to create an adjustment.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an adjustment for an existing credit account." }, { "info": { "name": "Retrieve account adjustment", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/adjustments/:adjustment_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve an adjustment.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "adjustment_token", "value": "", "type": "path", "description": "Unique identifier of the adjustment to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/adjustments` to retrieve existing account adjustment tokens." } ] }, "docs": "Retrieve an adjustment for a credit account." } ] }, { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "Get billing cycle by account token", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/billingcycle", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve delinquency state details.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ] }, "docs": "Retrieves the billing cycle details for a specific account token." }, { "info": { "name": "Get all active and upcoming periodic fee schedules of an account", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/periodicfeeschedules", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "account token" }, { "name": "count", "value": "", "type": "query", "description": "Number of periodic fee schedule resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." } ] }, "docs": "Get all active and upcoming periodic fee schedules of an account" } ] }, { "info": { "name": "Account Bundle Transitions", "type": "folder" }, "items": [ { "info": { "name": "List account bundle transitions", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/bundletransitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve bundle transitions.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of account bundle transition resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `updated_time`." } ] }, "docs": "Retrieve an array of bundle transitions on a credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Transition account bundle", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/bundletransitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to transition a bundle." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transition a credit account to a new bundle." }, { "info": { "name": "Retrieve account bundle transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/bundletransitions/:token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve a bundle transition.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the account bundle transition you want to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/bundletransitions` to retrieve existing account bundle transition tokens." } ] }, "docs": "Retrieve a bundle transition for a credit account." } ] }, { "info": { "name": "Account Cards", "type": "folder" }, "items": [ { "info": { "name": "List account cards", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/cards", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve credit cards.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "status", "value": "", "type": "query", "description": "Status of the credit cards to retrieve." }, { "name": "count", "value": "", "type": "query", "description": "Number of credit card resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of cards for a credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Create account card", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/cards", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to create a credit card.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a credit card for an existing credit account.\n\n[NOTE]\nYou can ship cards to an address different from the <> address.\nAfter creating a card, send a `PUT` request to the `/cards` endpoint with the new address in the `fulfillment.shipping` object.\nFor more, see <>." }, { "info": { "name": "Retrieve account card", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/cards/:card_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve a credit card.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "card_token", "value": "", "type": "path", "description": "Unique identifier of the credit card to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/cards` to retrieve existing credit card tokens." } ] }, "docs": "Retrieve a credit card for a credit account." } ] }, { "info": { "name": "Balance Refunds", "type": "folder" }, "items": [ { "info": { "name": "Create balance refund", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/creditbalancerefunds", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to create a balance refund.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new balance refund, which can be issued to the account holder if their credit account balance is negative." } ] }, { "info": { "name": "Delinquency", "type": "folder" }, "items": [ { "info": { "name": "Retrieve delinquency state", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/delinquencystate", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve delinquency state details.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ] }, "docs": "Retrieve details of the current delinquency state of a credit account.\n\nAn account is delinquent when it is past due on payments and current when it is up to date on payments." }, { "info": { "name": "List delinquency state transitions", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/delinquencystate/transitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account whose delinquency state transitions you want to retrieve.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `impactTime`, and not by the field names appearing in response bodies such as `impact_time`." } ] }, "docs": "Retrieve an array of delinquency state transitions for a credit account.\n\nA delinquency state transition occurs when an account's delinquency state transitions between delinquent and current.\nAn account becomes delinquent when it falls behind on payments and becomes current when payments are made up to date." }, { "info": { "name": "Retrieve delinquency state transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/delinquencystate/transitions/:delinquency_transition_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account whose delinquency state transition you want to retrieve.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "delinquency_transition_token", "value": "", "type": "path", "description": "Unique identifier of the delinquency state transition." } ] }, "docs": "Retrieve a specific delinquency state transition on a credit account.\n\nA delinquency state transition occurs when an account's delinquency state transitions between delinquent and current.\nAn account becomes delinquent when it falls behind on payments and becomes current when payments are made up to date." } ] }, { "info": { "name": "Credit Account Disputes", "type": "folder" }, "items": [ { "info": { "name": "List account disputes", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/disputes", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve the disputes.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of disputes resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." }, { "name": "ledger_entry_tokens", "value": "", "type": "query", "description": "Unique identifier of the journal entry in dispute.\nThis type of identifier can only be used for `authorization.clearing`-type journal entries." }, { "name": "statuses", "value": "", "type": "query", "description": "Status of the dispute." } ] }, "docs": "Retrieve an array of disputes on a credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Create account dispute", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/disputes", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to create a dispute.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a dispute of a journal entry on a credit account." }, { "info": { "name": "Retrieve account dispute", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/disputes/:dispute_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account from which to retrieve a dispute.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "dispute_token", "value": "", "type": "path", "description": "Unique identifier of the dispute to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/disputes` to retrieve existing dispute tokens." } ] }, "docs": "Retrieve a dispute from a credit account." }, { "info": { "name": "Update account dispute", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/disputes/:dispute_token/transitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account from which to update a dispute.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "dispute_token", "value": "", "type": "path", "description": "Unique identifier of the dispute to update.\n\nSend a `GET` request to `/credit/accounts/{account_token}/disputes` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the amount or status of a dispute on a credit account." } ] }, { "info": { "name": "Account Documents", "type": "folder" }, "items": [ { "info": { "name": "List documents", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/documents", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to get documents.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ] }, "docs": "Retrieve an array of documents on a credit account." }, { "info": { "name": "Retrieve document", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/documents/:document_type", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve a specific type of document.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "document_type", "value": "", "type": "path" } ] }, "docs": "Retrieve a specific type of document on a credit account." }, { "info": { "name": "Retrieve document history", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/documents/:document_type/history", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to get document history.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "document_type", "value": "", "type": "path" }, { "name": "count", "value": "", "type": "query", "description": "Number of account document resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `effectiveDate`, and not by the field names appearing in response bodies such as `effective_date`." } ] }, "docs": "Retrieve the history of a specific type of document on a credit account." } ] }, { "info": { "name": "Fees", "type": "folder" }, "items": [ { "info": { "name": "List account fees", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/fees", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve fees.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of account fee resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." } ] }, "docs": "Retrieve an array of fees for a credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Create fee for an account", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/fees", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to create a fee.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a fee for an existing credit account." } ] }, { "info": { "name": "fees", "type": "folder" }, "items": [ { "info": { "name": "Retrieve account fee", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/fees/:fee_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve the fee.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "fee_token", "value": "", "type": "path", "description": "Unique identifier of the fee to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/fees` to retrieve existing account fee tokens." } ] }, "docs": "Retrieve a fee for a credit account." }, { "info": { "name": "Lists all fees", "type": "http" }, "http": { "method": "GET", "url": "/v3/fees", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of fees to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all fees" }, { "info": { "name": "Creates a fee", "type": "http" }, "http": { "method": "POST", "url": "/v3/fees", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a fee" }, { "info": { "name": "Returns a specific fee", "type": "http" }, "http": { "method": "GET", "url": "/v3/fees/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Fee token" } ] }, "docs": "Returns a specific fee" }, { "info": { "name": "Updates a specific fee", "type": "http" }, "http": { "method": "PUT", "url": "/v3/fees/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Fee token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific fee" } ] }, { "info": { "name": "Journal Entries", "type": "folder" }, "items": [ { "info": { "name": "List account journal entries", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/journalentries", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve journal entries.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of journal entry resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "start_date", "value": "", "type": "query", "description": "Starting date of the date range from which to return journal entries." }, { "name": "end_date", "value": "", "type": "query", "description": "Ending date of the date range from which to return journal entries." }, { "name": "start_impact_time", "value": "", "type": "query", "description": "Starting `impact_time` of the date range from which to return journal entries." }, { "name": "end_impact_time", "value": "", "type": "query", "description": "Ending `impact_time` of the date range from which to return journal entries." }, { "name": "start_created_time", "value": "", "type": "query", "description": "Starting `created_date` of the date range from which to return journal entries." }, { "name": "end_created_time", "value": "", "type": "query", "description": "Ending `created_date` of the date range from which to return journal entries." }, { "name": "statuses", "value": "", "type": "query", "description": "Array of statuses by which to filter journal entries." }, { "name": "detail_token", "value": "", "type": "query", "description": "Detail token of the journal entries to return." }, { "name": "groups", "value": "", "type": "query", "description": "Array of groups by which to filter journal entries.\n\nTo return all journal entry groups, do not include this query parameter." }, { "name": "expand", "value": "", "type": "query", "description": "Embeds the specified object into the response." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`." }, { "name": "card_tokens", "value": "", "type": "query", "description": "Array of card tokens by which to filter journal entries.\nReturns journal entries associated with the specified card tokens.\n\nSend a `GET` request to `/credit/accounts/{account_token}/cards/` to retrieve existing card tokens." }, { "name": "user_tokens", "value": "", "type": "query", "description": "Array of user tokens by which to filter journal entries.\nReturns journal entries associated with the specified user tokens.\n\nSend a `GET` request to `/users` to retrieve existing user tokens." }, { "name": "types", "value": "", "type": "query", "description": "Array of <> by which to filter journal entries.\n\nTo return all event types, do not include this query parameter." } ] }, "docs": "Retrieve an array of journal entries on a credit account.\n\nThis endpoint supports <> and <>." }, { "info": { "name": "Retrieve account journal entry", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/journalentries/:journal_entry_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve journal entries.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "journal_entry_token", "value": "", "type": "path", "description": "Unique identifier of the journal entry you want to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/journalentries` to retrieve existing journal entry tokens." } ] }, "docs": "Retrieve a journal entry for a credit account." } ] }, { "info": { "name": "Ledger Entries", "type": "folder" }, "items": [ { "info": { "name": "List account ledger entries", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/ledgerentries", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve ledger entries.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of ledger entry resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "start_date", "value": "", "type": "query", "description": "Starting date of the date range from which to return ledger entries." }, { "name": "end_date", "value": "", "type": "query", "description": "Ending date of the date range from which to return ledger entries." }, { "name": "statuses", "value": "", "type": "query", "description": "Array of statuses by which to filter ledger entries." }, { "name": "description", "value": "", "type": "query", "description": "Description of the ledger entries to return." }, { "name": "detail_token", "value": "", "type": "query", "description": "Detail token of the ledger entries to return." }, { "name": "groups", "value": "", "type": "query", "description": "Array of groups by which to filter ledger entries.\n\nTo return all ledger entry groups, do not include this query parameter." }, { "name": "amount", "value": "", "type": "query", "description": "Number of ledger entries to return." }, { "name": "expand", "value": "", "type": "query", "description": "Embeds the specified object into the response." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`." } ] }, "docs": "Retrieve an array of ledger entries on a credit account.\n\nThis endpoint supports <> and <>." }, { "info": { "name": "Retrieve account ledger entry", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/ledgerentries/:ledger_entry_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve ledger entries.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "ledger_entry_token", "value": "", "type": "path", "description": "Unique identifier of the ledger entry you want to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/ledgerentries` to retrieve existing ledger entry tokens." } ] }, "docs": "Retrieve a ledger entry for a credit account." } ] }, { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "List account payments", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/payments", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve payments.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "start_date", "value": "", "type": "query", "description": "Beginning of the date range of the payments to return." }, { "name": "end_date", "value": "", "type": "query", "description": "End of the date range of the payments to return." }, { "name": "count", "value": "", "type": "query", "description": "Number of account payments resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." }, { "name": "statuses", "value": "", "type": "query", "description": "Array of statuses by which to filter payments." } ] }, "docs": "Retrieve an array of payments on a credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Create account payment", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/payments", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to create a payment.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new payment to apply toward a credit account's balance." }, { "info": { "name": "Retrieve account payment", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/payments/:payment_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve a payment.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "payment_token", "value": "", "type": "path", "description": "Unique identifier of the payment to retrieve.\n\nSend a `GET` request to `/credit/accounts/{token}/payments` to retrieve existing payment tokens." } ] }, "docs": "Retrieve a payment for a credit account." }, { "info": { "name": "Release payment hold", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/payments/:payment_token/releasehold", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account on which a payment hold is being released.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "payment_token", "value": "", "type": "path", "description": "Unique identifier of the payment currently on hold.\n\nSend a `GET` request to `/credit/accounts/{account_token}/payments` to retrieve existing payment tokens." } ] }, "docs": "Manually release a payment hold on a credit account." }, { "info": { "name": "Transition account payment status", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/payments/:payment_token/transitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to transition a payment status.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "payment_token", "value": "", "type": "path", "description": "Unique identifier of the payment whose status you want to transition.\n\nSend a `GET` request to `/credit/accounts/{account_token}/payments` endpoint to retrieve existing payment tokens for a given account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transition a credit account payment's status to a new status." } ] }, { "info": { "name": "Payment Schedules", "type": "folder" }, "items": [ { "info": { "name": "List payment schedules", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/paymentschedules", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve payment schedules.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statuses", "value": "", "type": "query", "description": "Status of the payment schedules to retrieve." }, { "name": "frequency", "value": "", "type": "query", "description": "Frequency of the payment schedules to retrieve." }, { "name": "count", "value": "", "type": "query", "description": "Number of payment schedule resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of payment schedules on a specific credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Create payment schedule", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/paymentschedules", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to create a payment schedule.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new payment schedule, either one-time or recurring." }, { "info": { "name": "Retrieve payment schedule", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/paymentschedules/:payment_schedule_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve a payment schedule.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "payment_schedule_token", "value": "", "type": "path", "description": "Unique identifier of the payment schedule that you want to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens." } ] }, "docs": "Retrieve a single payment schedule on a specific credit account." }, { "info": { "name": "Retrieve payment schedule transitions", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/paymentschedules/:payment_schedule_token/transitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve payment schedule transitions.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "payment_schedule_token", "value": "", "type": "path", "description": "Unique identifier of the payment schedule for which you want to retrieve transitions.\n\nSend a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of payment schedule resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`." } ] }, "docs": "Retrieve an array of payment schedule transitions on a specific credit account." }, { "info": { "name": "Create payment schedule transition", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/paymentschedules/:payment_schedule_token/transitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account on which to transition a payment schedule.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "payment_schedule_token", "value": "", "type": "path", "description": "Unique identifier of the payment schedule whose status is to transition.\n\nSend a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transition a payment schedule to a new status." }, { "info": { "name": "Retrieve payment schedule transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/paymentschedules/:payment_schedule_token/transitions/:token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve a payment schedule transition.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "payment_schedule_token", "value": "", "type": "path", "description": "Unique identifier of the payment schedule you want to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens." }, { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the payment schedule transition you want to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/paymentschedules/{payment_schedule_token}/transitions` to retrieve existing payment schedule transition tokens." } ] }, "docs": "Retrieve a single payment schedule transition on a specific credit account." } ] }, { "info": { "name": "Account Refunds", "type": "folder" }, "items": [ { "info": { "name": "List account refunds", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/refunds", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve refunds.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "start_date", "value": "", "type": "query", "description": "Beginning of the date range of the refunds to return." }, { "name": "end_date", "value": "", "type": "query", "description": "End of the date range of the refunds to return." }, { "name": "count", "value": "", "type": "query", "description": "Number of account refund resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\nOnly supports `lastModifiedTime` and `-lastModifiedTime`.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `updated_time`." }, { "name": "statuses", "value": "", "type": "query", "description": "Array of statuses by which to filter refunds." } ] }, "docs": "Use the `/credit/accounts/{account_token}/refunds` endpoint to retrieve an array of refunds on a credit account.\n\nThis endpoint supports <>." }, { "info": { "name": "Create refund", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/refunds", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to create a balance refund.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new refund, which you can issue to the account holder if their credit account balance is negative." }, { "info": { "name": "Retrieve account refund", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/refunds/:refund_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve a refund.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "refund_token", "value": "", "type": "path", "description": "Unique identifier of the refund to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/refunds/{refund_token}` to retrieve existing refunds." } ] }, "docs": "Use the `/accounts/{account_token}/refunds/{refund_token}` endpoint to retrieve a refund." }, { "info": { "name": "Transition account refund status", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/refunds/:refund_token/transitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to transition a refund status.\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "refund_token", "value": "", "type": "path", "description": "Unique identifier of the refund whose status you want to transition.\nSend a `GET` request to `/credit/accounts/{account_token}/refunds` endpoint to retrieve existing refund tokens for a given account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/accounts/{account_token}/refunds/{refund_token}/transitions` endpoint to transition a credit account refund's status to a new status." } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "List transitions associated with a refund", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/refunds/:refund_token/transitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account" }, { "name": "refund_token", "value": "", "type": "path", "description": "Unique identifier of the refund" }, { "name": "count", "value": "", "type": "query", "description": "The number of resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "The sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`." } ] }, "docs": "Retrieve a list of transitions associated with the refund." }, { "info": { "name": "Get deposit account user token.", "type": "http" }, "http": { "method": "GET", "url": "/v3/depositaccounts/user/:token/direct", "params": [ { "name": "token", "value": "", "type": "path", "description": "Token" } ] }, "docs": "Get deposit account user token." }, { "info": { "name": "Creates a fraud feedback", "type": "http" }, "http": { "method": "POST", "url": "/v3/feedback/fraud", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is to get a fraud feedback from the customer." }, { "info": { "name": "Get spaces.", "type": "http" }, "http": { "method": "GET", "url": "/v3/spaces" }, "docs": "Get spaces." }, { "info": { "name": "Create space.", "type": "http" }, "http": { "method": "POST", "url": "/v3/spaces" }, "docs": "Create space." }, { "info": { "name": "deleteQueue", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/spaces/redis-queue/:queueName", "params": [ { "name": "queueName", "value": "", "type": "path" } ] } }, { "info": { "name": "Get space.", "type": "http" }, "http": { "method": "GET", "url": "/v3/spaces/:space/:key", "params": [ { "name": "space", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" }, { "name": "timeout", "value": "", "type": "query" } ] }, "docs": "Get space." }, { "info": { "name": "Create space for key.", "type": "http" }, "http": { "method": "POST", "url": "/v3/spaces/:space/:key", "params": [ { "name": "space", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" }, { "name": "timeout", "value": "", "type": "query" } ] }, "docs": "Create space for key." }, { "info": { "name": "Delete space.", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/spaces/:space/:key", "params": [ { "name": "space", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ] }, "docs": "Delete space." } ] }, { "info": { "name": "Account Rewards", "type": "folder" }, "items": [ { "info": { "name": "Create account reward", "type": "http" }, "http": { "method": "POST", "url": "/v3/accounts/:account_token/rewards", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to create a reward.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a reward for an existing credit account." } ] }, { "info": { "name": "Rewards", "type": "folder" }, "items": [ { "info": { "name": "Retrieve account signup bonus progress.", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/signupbonusprogress", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve the sign up bonus for.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ] }, "docs": "Retrieve the signup bonus progress, including the bonus amount and the remaining amount to be earned." } ] }, { "info": { "name": "Statements", "type": "folder" }, "items": [ { "info": { "name": "List account statement summaries", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve statement summaries.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "start_date", "value": "", "type": "query", "description": "Returns statements with a matching opening date.\n\nIf both `start_date` and `end_date` are specified, statements whose closing date falls between the start and end dates are returned." }, { "name": "end_date", "value": "", "type": "query", "description": "Returns statements with a matching closing date.\n\nIf both `start_date` and `end_date` are specified, statements whose closing date falls between the start and end dates are returned." }, { "name": "count", "value": "", "type": "query", "description": "Number of account statement resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`." } ] }, "docs": "Retrieve an array of statement summaries tied to a cardholder's account.\n\nThe statement summary, which is a summary of account activity on a statement, provides account holders with a synopsis of activity that occurred on the account during a specified billing cycle.\n\nThis endpoint supports <>.\nYou can use optional query parameters to return a statement based on its exact opening or closing date, or a statement whose closing date falls wi" }, { "info": { "name": "List files for an account", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/files", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve statement files.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "start_date", "value": "", "type": "query", "description": "Start date of the date range for which to return statement files." }, { "name": "end_date", "value": "", "type": "query", "description": "End date of the date range for which to return statement files." }, { "name": "count", "value": "", "type": "query", "description": "Number of statement file resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`." } ] }, "docs": "Retrieve an array of statement files for a specific credit account." }, { "info": { "name": "Retrieve account statement summary", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve a statement summary.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary to retrieve.\n\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." } ] }, "docs": "Retrieve a statement summary for a credit account." }, { "info": { "name": "List files for a statement summary", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/files", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve statement files for a statement summary.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary whose statement files you want to retrieve.\n\nSend a `GET` request to `/credit/accounts/{token}/statements` to retrieve existing statement summary tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of statement files to return." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index from which to begin returning files." } ] }, "docs": "Retrieve an array of statement files for a specific statement summary." }, { "info": { "name": "Retrieve account statement interest charges", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/interestcharges", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve the statement interest charges.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary from which to retrieve the interest charges.\n\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." } ] }, "docs": "Retrieve the interest charges on a credit account's statement summary." }, { "info": { "name": "List account statement journal entries", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/journalentries", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve the statement journal entries.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary from which to retrieve journal entries.\n\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of journal entry resources to return." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "expand", "value": "", "type": "query", "description": "Embeds the specified object into the response." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of journal entries on a credit account's statement summary.\n\nThis endpoint supports <>." }, { "info": { "name": "List account statement ledger entries", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/ledgerentries", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which to retrieve the statement ledger entries.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary from which to retrieve ledger entries.\n\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." }, { "name": "expand", "value": "", "type": "query", "description": "Embeds the specified object into the response." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "[IMPORTANT]\nThis feature is being deprecated and replaced by statement journal entries.\nTo list statement journal entries, see <>.\n\nRetrieve an array of ledger entries on a credit account's statement summary.\n\nThis endpoint supports <>." }, { "info": { "name": "Retrieve account statement payment information", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/paymentinfo", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve the statement payment information.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary from which to retrieve the payment information.\n\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." } ] }, "docs": "Retrieve the payment information on a credit account's statement summary." }, { "info": { "name": "List payment reminders by statement summary", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/paymentreminders/", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve the statement payment information.\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary from which to retrieve the payment information.\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of payment reminder resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n*NOTE:*\nYou must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`." } ] }, "docs": "Retrieve an array of payment reminder details for a specific statement summary token." }, { "info": { "name": "Get payment reminder", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/paymentreminders/:token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve the statement payment reminder.\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary for which you want to retrieve the statement payment reminder.\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." }, { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the payment reminder you want to retrieve.\nSend a `GET` request to `/credit/accounts/{account_token}/statements/{statement_summary_token}/paymentreminders/{token}` to retrieve existing payment reminder tokens." } ] }, "docs": "Retrieve a single payment reminder on a specific statement summary" }, { "info": { "name": "Retrieve account statement rewards", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/rewards", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account from which to retrieve statement rewards.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary from which to retrieve rewards.\n\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." } ] }, "docs": "Retrieve the rewards on a credit account's statement summary." }, { "info": { "name": "Retrieve account statement year-to-date totals", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/statements/:statement_summary_token/yeartodate", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account from which to retrieve statement year-to-date totals.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the statement summary from which to retrieve year-to-date totals.\n\nSend a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens." } ] }, "docs": "Retrieve the year-to-date fee and interest totals on a credit account's statement summary." } ] }, { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "info": { "name": "List account transactions", "type": "http" }, "http": { "method": "GET", "url": "/v3/accounts/:account_token/transactions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve transactions." }, { "name": "count", "value": "", "type": "query", "description": "Number of transaction resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Starting index for pagination." }, { "name": "start_date", "value": "", "type": "query", "description": "Start date for transaction filter. Defaults to 30 days ago if not provided." }, { "name": "end_date", "value": "", "type": "query", "description": "End date for transaction filter. Defaults to current date if not provided." }, { "name": "status", "value": "", "type": "query", "description": "Filter by transaction status. Allowed values are PENDING, POSTED, DECLINED, and ERROR. When no status is provided, PENDING, POSTED, DECLINED, and ERROR transactions are returned by default." }, { "name": "card_token", "value": "", "type": "query", "description": "Filter transactions by card token." }, { "name": "user_token", "value": "", "type": "query", "description": "Filter transactions by user token." } ] }, "docs": "Retrieve an array of transactions on a credit account." }, { "info": { "name": "List transactions", "type": "http" }, "http": { "method": "GET", "url": "/v3/transactions", "params": [ { "name": "count", "value": "", "type": "query", "description": "The number of transactions to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "The sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." }, { "name": "start_date", "value": "", "type": "query", "description": "The starting date (or date-time) of a date range from which to return transactions.\nTo return transactions for a single day, enter the same date in both the `start_date` and `end_date` fields." }, { "name": "end_date", "value": "", "type": "query", "description": "The ending date (or date-time) of a date range from which to return transactions.\nTo return transactions for a single day, enter the same date in both the `end_date` and `start_date` fields." }, { "name": "type", "value": "", "type": "query", "description": "Comma-delimited list of transaction types to include." }, { "name": "user_token", "value": "", "type": "query", "description": "The unique identifier of the user account holder." }, { "name": "business_token", "value": "", "type": "query", "description": "The unique identifier of the business account holder." }, { "name": "acting_user_token", "value": "", "type": "query", "description": "The unique identifier of the acting user." }, { "name": "card_token", "value": "", "type": "query", "description": "The unique identifier of the card." }, { "name": "account_token", "value": "", "type": "query", "description": "Account token" }, { "name": "state", "value": "", "type": "query", "description": "Comma-delimited list of transaction states to display." }, { "name": "version", "value": "", "type": "query", "description": "Specifies the API version for the request." }, { "name": "start_identifier", "value": "", "type": "query", "description": "Start identifier" } ] }, "docs": "List all transactions.\n\nBy default, this endpoint returns transactions conducted within the last 30 days.\nTo return transactions older than 30 days, you must include the `start_date` and `end_date` query parameters in your request.\n\nBy default, `GET /transactions` returns transactions having either `PENDING` or `COMPLETION` states.\n\nThis endpoint supports <> and <>." }, { "info": { "name": "List transactions for a funding account", "type": "http" }, "http": { "method": "GET", "url": "/v3/transactions/fundingsource/:funding_source_token", "params": [ { "name": "funding_source_token", "value": "", "type": "path", "description": "The unique identifier of the funding account." }, { "name": "count", "value": "", "type": "query", "description": "The number of transactions to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "The sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." }, { "name": "start_date", "value": "", "type": "query", "description": "The starting date (or date-time) of a date range from which to return transactions.\nTo return transactions for a single day, enter the same date in both the `start_date` and `end_date` fields." }, { "name": "end_date", "value": "", "type": "query", "description": "The ending date (or date-time) of a date range from which to return transactions.\nTo return transactions for a single day, enter the same date in both the `end_date` and `start_date` fields." }, { "name": "type", "value": "", "type": "query", "description": "Comma-delimited list of transaction types to include." }, { "name": "polarity", "value": "", "type": "query", "description": "Specifies whether to return credit or debit transactions." }, { "name": "version", "value": "", "type": "query", "description": "Specifies the API version for the request." } ] }, "docs": "List transactions for a specific funding source.\n\nBy default, this endpoint returns transactions conducted within the last 30 days.\nTo return transactions older than 30 days, you must include the `start_date` and `end_date` query parameters in your request.\n\nBy default, `GET /transactions/fundingsource/{funding_source_token}` returns transactions having either `PENDING` or `COMPLETION` states.\n\nThis endpoint supports <> and <>." }, { "info": { "name": "Create bundle", "type": "http" }, "http": { "method": "POST", "url": "/v3/bundles", "body": { "type": "json", "data": "{}" } }, "docs": "Create a bundle." }, { "info": { "name": "Retrieve bundle", "type": "http" }, "http": { "method": "GET", "url": "/v3/bundles/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the bundle to retrieve.\n\nSend a `GET` request to `/credit/bundles` to retrieve existing tokens." }, { "name": "expand_objects", "value": "", "type": "query", "description": "Embeds the associated object of the specified type into the response.\nFor more, see <>." } ] }, "docs": "Retrieve a specific bundle." }, { "info": { "name": "Update bundle", "type": "http" }, "http": { "method": "PUT", "url": "/v3/bundles/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Token of the bundle to update.\n\nSend a `GET` request to `/credit/bundles` to retrieve existing tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific bundle that is not `ACTIVE` or `ARCHIVED`.\nBundles are created in a `DRAFT` state, and are still modifiable at this point.\nUsing the transitions endpoint, a bundle can be transitioned from `DRAFT`, to `ACTIVE`.\nOnce a bundle is active, it cannot be modified." }, { "info": { "name": "Clone bundle", "type": "http" }, "http": { "method": "POST", "url": "/v3/bundles/:token/clone", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the bundle to clone.\n\nSend a `GET` request to `/bundles` to retrieve existing bundle tokens." } ] }, "docs": "Create a new bundle based on an existing bundle." }, { "info": { "name": "List related bundles", "type": "http" }, "http": { "method": "GET", "url": "/v3/bundles/:token/lineage", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the parent product bundle.\n\nSend a `GET` request to `/bundles` to retrieve existing product bundles tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of related bundle product resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." }, { "name": "status", "value": "", "type": "query", "description": "Array of statuses by which to filter bundles." } ] }, "docs": "Retrieve an array of related product bundles.\n\nThis endpoint supports <>." }, { "info": { "name": "Promote bundle", "type": "http" }, "http": { "method": "PUT", "url": "/v3/bundles/:token/promote", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the bundle to promote.\n\nSend a `GET` request to `/bundles` to retrieve existing bundle tokens." } ] }, "docs": "Promote a specific bundle that replaces the current active bundle and activates the promoted bundle." }, { "info": { "name": "Transition a bundle", "type": "http" }, "http": { "method": "POST", "url": "/v3/bundles/:token/transitions", "params": [ { "name": "token", "value": "", "type": "path", "description": "Token of the bundle whose status you want to transition.\n\nSend a `GET` request to `/credit/bundles` to retrieve existing tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transition the status of a specific bundle." } ] }, { "info": { "name": "businesses", "type": "folder" }, "items": [ { "info": { "name": "Lists all businesses", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesses", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of users to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "business_name_dba", "value": "", "type": "query", "description": "Business name DBA" }, { "name": "business_name_legal", "value": "", "type": "query", "description": "Business name legal" }, { "name": "search_type", "value": "", "type": "query", "description": "Search type" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all businesses" }, { "info": { "name": "Creates a business", "type": "http" }, "http": { "method": "POST", "url": "/v3/businesses", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a business" }, { "info": { "name": "Returns a specific business", "type": "http" }, "http": { "method": "POST", "url": "/v3/businesses/lookup", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a specific business" }, { "info": { "name": "Creates a BusinessDirector for a business", "type": "http" }, "http": { "method": "POST", "url": "/v3/businesses/:business_token/directors", "params": [ { "name": "business_token", "value": "", "type": "path", "description": "Business token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a BusinessDirector for a business" }, { "info": { "name": "Returns a specific business director", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesses/:business_token/directors/:token", "params": [ { "name": "business_token", "value": "", "type": "path", "description": "Business token" }, { "name": "token", "value": "", "type": "path", "description": "Business Director token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns a specific business director" }, { "info": { "name": "Updates a specific business director for a business", "type": "http" }, "http": { "method": "PUT", "url": "/v3/businesses/:business_token/directors/:token", "params": [ { "name": "business_token", "value": "", "type": "path", "description": "Business token" }, { "name": "token", "value": "", "type": "path", "description": "Business Director token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific business director for a business" }, { "info": { "name": "Returns a specific business director's SSN", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesses/:business_token/directors/:token/identifications", "params": [ { "name": "business_token", "value": "", "type": "path", "description": "Business token" }, { "name": "token", "value": "", "type": "path", "description": "Business Director token" }, { "name": "full_ssn", "value": "", "type": "query" } ] }, "docs": "Returns a specific business director's SSN" }, { "info": { "name": "Lists all children of a parent business", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesses/:parent_token/children", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of users to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "parent_token", "value": "", "type": "path", "description": "Token of parent business" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all children of a parent business" }, { "info": { "name": "Returns a specific business", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesses/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Business token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns a specific business" }, { "info": { "name": "Updates a specific business", "type": "http" }, "http": { "method": "PUT", "url": "/v3/businesses/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Business token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific business" }, { "info": { "name": "Lists business notes", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesses/:token/notes", "params": [ { "name": "token", "value": "", "type": "path", "description": "Business token" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "count", "value": "", "type": "query", "description": "Number of notes to retrieve" }, { "name": "created_by", "value": "", "type": "query", "description": "Created by" }, { "name": "created_by_user_role", "value": "", "type": "query", "description": "Comma-delimited list of created by user roles" }, { "name": "include_private", "value": "", "type": "query", "description": "Include private notes and private fields in note response" }, { "name": "search_type", "value": "", "type": "query", "description": "Search type" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists business notes" }, { "info": { "name": "Creates a note for a business", "type": "http" }, "http": { "method": "POST", "url": "/v3/businesses/:token/notes", "params": [ { "name": "token", "value": "", "type": "path", "description": "Business token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a note for a business" }, { "info": { "name": "Updates a specific note for a business", "type": "http" }, "http": { "method": "PUT", "url": "/v3/businesses/:token/notes/:notes_token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Business token" }, { "name": "notes_token", "value": "", "type": "path", "description": "Notes token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific note for a business" }, { "info": { "name": "Returns a specific business proprietor's SSN", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesses/:token/ssn", "params": [ { "name": "token", "value": "", "type": "path", "description": "Business token" }, { "name": "full_ssn", "value": "", "type": "query" } ] }, "docs": "Returns a specific business proprietor's SSN" } ] }, { "info": { "name": "business transitions", "type": "folder" }, "items": [ { "info": { "name": "Creates a business transition", "type": "http" }, "http": { "method": "POST", "url": "/v3/businesstransitions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a business transition" }, { "info": { "name": "Returns transitions for a given business", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesstransitions/business/:business_token", "params": [ { "name": "business_token", "value": "", "type": "path", "description": "Business token" }, { "name": "count", "value": "", "type": "query", "description": "Number of business transitions to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Returns transitions for a given business" }, { "info": { "name": "Returns a business transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/businesstransitions/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Transition token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns a business transition" } ] }, { "info": { "name": "Card Group", "type": "folder" }, "items": [ { "info": { "name": "List Card Groups", "type": "http" }, "http": { "method": "GET", "url": "/v3/cardgroups", "params": [ { "name": "card_tokens", "value": "", "type": "query", "description": "list of unique card identifiers to retrieve." }, { "name": "count", "value": "", "type": "query", "description": "Number of card group resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." } ] }, "docs": "Get a list of all card groups in the program" }, { "info": { "name": "Create Card Group", "type": "http" }, "http": { "method": "POST", "url": "/v3/cardgroups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new card group object" }, { "info": { "name": "Retrieve Card Group", "type": "http" }, "http": { "method": "GET", "url": "/v3/cardgroups/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the card group to retrieve" } ] }, "docs": "Retrieves the Card Group with the given token" } ] }, { "info": { "name": "card products", "type": "folder" }, "items": [ { "info": { "name": "Lists all card products", "type": "http" }, "http": { "method": "GET", "url": "/v3/cardproducts", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve. Count can be between 1 - 10 items." }, { "name": "start_index", "value": "", "type": "query", "description": "Indicates from what row to start returning data." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all card products" }, { "info": { "name": "Creates a card product", "type": "http" }, "http": { "method": "POST", "url": "/v3/cardproducts", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a card product" }, { "info": { "name": "Returns a specific card product", "type": "http" }, "http": { "method": "GET", "url": "/v3/cardproducts/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card product token" } ] }, "docs": "Returns a specific card product" }, { "info": { "name": "Updates a specific card product", "type": "http" }, "http": { "method": "PUT", "url": "/v3/cardproducts/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card product token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific card product" } ] }, { "info": { "name": "cards", "type": "folder" }, "items": [ { "info": { "name": "Lists cards by the last 4 digits", "type": "http" }, "http": { "method": "GET", "url": "/v3/cards", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of cards to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "last_four", "value": "", "type": "query", "description": "Last four digits of card number" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists cards by the last 4 digits" }, { "info": { "name": "Creates a card", "type": "http" }, "http": { "method": "POST", "url": "/v3/cards", "params": [ { "name": "show_cvv_number", "value": "", "type": "query", "description": "Show CVV" }, { "name": "show_pan", "value": "", "type": "query", "description": "Show PAN" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a card" }, { "info": { "name": "Returns a card's metadata", "type": "http" }, "http": { "method": "GET", "url": "/v3/cards/barcode/:barcode", "params": [ { "name": "barcode", "value": "", "type": "path", "description": "Barcode" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns a card's metadata" }, { "info": { "name": "Returns user and card tokens for the specified PAN", "type": "http" }, "http": { "method": "POST", "url": "/v3/cards/getbypan", "body": { "type": "json", "data": "{}" } }, "docs": "Returns user and card tokens for the specified PAN" }, { "info": { "name": "Lists all cards for a specific user", "type": "http" }, "http": { "method": "GET", "url": "/v3/cards/user/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "User token" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all cards for a specific user" }, { "info": { "name": "Returns a specific card", "type": "http" }, "http": { "method": "GET", "url": "/v3/cards/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "expand", "value": "", "type": "query", "description": "Object to expand" } ] }, "docs": "Returns a specific card" }, { "info": { "name": "Updates a specific card", "type": "http" }, "http": { "method": "PUT", "url": "/v3/cards/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific card" }, { "info": { "name": "Returns a specific card - PAN visible", "type": "http" }, "http": { "method": "GET", "url": "/v3/cards/:token/showpan", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "show_cvv_number", "value": "", "type": "query" } ] }, "docs": "Returns a specific card - PAN visible" }, { "info": { "name": "Lists all stop orders for a card", "type": "http" }, "http": { "method": "GET", "url": "/v3/cards/:token/stoporders", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card token" }, { "name": "count", "value": "", "type": "query", "description": "Number of stop orders to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" } ] }, "docs": "Lists all stop orders for a card" }, { "info": { "name": "Creates a stop order for a card transaction", "type": "http" }, "http": { "method": "POST", "url": "/v3/cards/:token/stoporders", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a stop order for a card transaction" }, { "info": { "name": "Retrieves a specific stop order", "type": "http" }, "http": { "method": "GET", "url": "/v3/cards/:token/stoporders/:stop_order_token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card token" }, { "name": "stop_order_token", "value": "", "type": "path", "description": "Stop order token" } ] }, "docs": "Retrieves a specific stop order" }, { "info": { "name": "Updates a stop order by token", "type": "http" }, "http": { "method": "PUT", "url": "/v3/cards/:token/stoporders/:stop_order_token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card token" }, { "name": "stop_order_token", "value": "", "type": "path", "description": "Stop order token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a stop order by token" }, { "info": { "name": "Returns transactions for a specific card", "type": "http" }, "http": { "method": "GET", "url": "/v3/cards/:token/transactions", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of transactions to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "token", "value": "", "type": "path", "description": "Card token" }, { "name": "user_token", "value": "", "type": "query", "description": "User token" }, { "name": "start_date", "value": "", "type": "query", "description": "Start date (yyyy-MM-dd | yyyy-MM-ddTHH:mm:ss.SS)" }, { "name": "end_date", "value": "", "type": "query", "description": "End date (yyyy-MM-dd | yyyy-MM-ddTHH:mm:ss.SS)" }, { "name": "is_recurring", "value": "", "type": "query", "description": "Filter by recurring transaction flag" } ] }, "docs": "Returns transactions for a specific card" } ] }, { "info": { "name": "card transitions", "type": "folder" }, "items": [ { "info": { "name": "Creates a card transition object", "type": "http" }, "http": { "method": "POST", "url": "/v3/cardtransitions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a card transition object" }, { "info": { "name": "Lists all card transitions", "type": "http" }, "http": { "method": "GET", "url": "/v3/cardtransitions/card/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card token" }, { "name": "count", "value": "", "type": "query", "description": "Number of card transitions to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all card transitions" }, { "info": { "name": "Returns a card transition object", "type": "http" }, "http": { "method": "GET", "url": "/v3/cardtransitions/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Card transition token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns a card transition object" } ] }, { "info": { "name": "chargebacks", "type": "folder" }, "items": [ { "info": { "name": "List all chargebacks", "type": "http" }, "http": { "method": "GET", "url": "/v3/chargebacks", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of chargebacks to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "network_reference_id", "value": "", "type": "query", "description": "Network reference ID" }, { "name": "transaction_token", "value": "", "type": "query", "description": "Transaction token" }, { "name": "amount", "value": "", "type": "query", "description": "Amount" }, { "name": "states", "value": "", "type": "query", "description": "Comma-delimited list of chargeback states to display e.g. INITIATED | REPRESENTMENT | PREARBITRATION | ARBITRATION | CASE_WON | CASE_LOST | NETWORK_REJECTED | WITHDRAWN | WRITTEN_OFF_ISSUER | WRITTEN_OFF_PROGRAM" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" }, { "name": "network_case_id", "value": "", "type": "query" } ] }, "docs": "List all chargebacks" }, { "info": { "name": "Creates a chargeback", "type": "http" }, "http": { "method": "POST", "url": "/v3/chargebacks", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a chargeback" }, { "info": { "name": "Creates a chargeback allocation acknowledgement", "type": "http" }, "http": { "method": "POST", "url": "/v3/chargebacks/allocationacknowledgement", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a chargeback allocation acknowledgement" }, { "info": { "name": "Creates a chargeback transition", "type": "http" }, "http": { "method": "POST", "url": "/v3/chargebacks/transitions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a chargeback transition" }, { "info": { "name": "Returns a specific chargeback transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/chargebacks/transitions/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Chargeback transition token" } ] }, "docs": "Returns a specific chargeback transition" }, { "info": { "name": "Lists all chargeback transitions that are related to a chargeback", "type": "http" }, "http": { "method": "GET", "url": "/v3/chargebacks/:chargeback_token/transitions", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of transitions to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" }, { "name": "chargeback_token", "value": "", "type": "path", "description": "Chargeback token" } ] }, "docs": "Lists all chargeback transitions that are related to a chargeback" }, { "info": { "name": "Returns a specific chargeback", "type": "http" }, "http": { "method": "GET", "url": "/v3/chargebacks/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Returns a specific chargeback" }, { "info": { "name": "Updates chargeback data", "type": "http" }, "http": { "method": "PUT", "url": "/v3/chargebacks/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates chargeback data" }, { "info": { "name": "Grants provisional credit", "type": "http" }, "http": { "method": "PUT", "url": "/v3/chargebacks/:token/grantprovisionalcredit", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Grants provisional credit" }, { "info": { "name": "Reverses provisional credit", "type": "http" }, "http": { "method": "PUT", "url": "/v3/chargebacks/:token/reverseprovisionalcredit", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Reverses provisional credit" } ] }, { "info": { "name": "commando modes", "type": "folder" }, "items": [ { "info": { "name": "Lists all commando mode control sets", "type": "http" }, "http": { "method": "GET", "url": "/v3/commandomodes", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of commando modes to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all commando mode control sets" }, { "info": { "name": "Returns a specific commando mode transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/commandomodes/transitions/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Commando mode transition token" } ] }, "docs": "Returns a specific commando mode transition" }, { "info": { "name": "Lists all commando mode transitions related to a commando mode control set", "type": "http" }, "http": { "method": "GET", "url": "/v3/commandomodes/:commandomode_token/transitions", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of transitions to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" }, { "name": "commandomode_token", "value": "", "type": "path", "description": "Commando mode token" } ] }, "docs": "Lists all commando mode transitions related to a commando mode control set" }, { "info": { "name": "Returns a specific commando mode control set", "type": "http" }, "http": { "method": "GET", "url": "/v3/commandomodes/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Returns a specific commando mode control set" } ] }, { "info": { "name": "direct deposit accounts", "type": "folder" }, "items": [ { "info": { "name": "Creates new direct deposit account for cardholder.", "type": "http" }, "http": { "method": "POST", "url": "/v3/depositaccounts", "body": { "type": "json", "data": "{}" } }, "docs": "Creates new direct deposit account for cardholder." }, { "info": { "name": "Get User for Plain Text Account Number", "type": "http" }, "http": { "method": "GET", "url": "/v3/depositaccounts/account/:account_number/user", "params": [ { "name": "account_number", "value": "", "type": "path", "description": "Get user associated with direct deposit account number" } ] }, "docs": "Get User for Plain Text Account Number" }, { "info": { "name": "Creates new transition for a direct deposit account.", "type": "http" }, "http": { "method": "POST", "url": "/v3/depositaccounts/transitions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates new transition for a direct deposit account." }, { "info": { "name": "Get direct deposit account transition.", "type": "http" }, "http": { "method": "GET", "url": "/v3/depositaccounts/transitions/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Get specific direct deposit account transition" } ] }, "docs": "Get direct deposit account transition." }, { "info": { "name": "List all specific direct deposit accounts.", "type": "http" }, "http": { "method": "GET", "url": "/v3/depositaccounts/user/:token", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of users to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" }, { "name": "state", "value": "", "type": "query", "description": "Direct deposit account status" }, { "name": "token", "value": "", "type": "path", "description": "Get specific direct deposit account" } ] }, "docs": "List all specific direct deposit accounts." }, { "info": { "name": "Get direct deposit account.", "type": "http" }, "http": { "method": "GET", "url": "/v3/depositaccounts/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Get specific direct deposit account" } ] }, "docs": "Get direct deposit account." }, { "info": { "name": "Update direct deposit account.", "type": "http" }, "http": { "method": "PUT", "url": "/v3/depositaccounts/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update direct deposit account." }, { "info": { "name": "Get direct deposit account transition list for card holder.", "type": "http" }, "http": { "method": "GET", "url": "/v3/depositaccounts/:token/cdd", "params": [ { "name": "token", "value": "", "type": "path", "description": "Get CDD info for a specific DDA token" } ] }, "docs": "Get direct deposit account transition list for card holder." }, { "info": { "name": "Update CDD answers for Direct Deposit Account", "type": "http" }, "http": { "method": "PUT", "url": "/v3/depositaccounts/:token/cdd/:cddtoken", "params": [ { "name": "token", "value": "", "type": "path" }, { "name": "cddtoken", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update CDD answers for Direct Deposit Account" }, { "info": { "name": "Get direct deposit account transition list for card holder.", "type": "http" }, "http": { "method": "GET", "url": "/v3/depositaccounts/:user_token/transitions", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of users to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" }, { "name": "user_token", "value": "", "type": "path", "description": "Get direct deposit account transition list for user" } ] }, "docs": "Get direct deposit account transition list for card holder." } ] }, { "info": { "name": "Digital Wallets Management", "type": "folder" }, "items": [ { "info": { "name": "Create digital wallet token provisioning request for Google Wallet", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwalletprovisionrequests/androidpay", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to return card data for use in provisioning a digital wallet token into Google Wallet.\n\nThe returned card data is encrypted using the digital wallet provider's encryption key, thereby reducing your PCI compliance overhead." }, { "info": { "name": "Create digital wallet token provisioning request for Apple Wallet", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwalletprovisionrequests/applepay", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to return card data for use in provisioning a digital wallet token into Apple Wallet.\n\nThe returned card data is encrypted using the digital wallet provider's encryption key, thereby reducing your PCI compliance overhead." }, { "info": { "name": "Create digital wallet token provisioning request for Samsung Wallet", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwalletprovisionrequests/samsungpay", "body": { "type": "json", "data": "{}" } }, "docs": "[NOTE]\nThis endpoint is limited in availability.\nFor more information, contact your Marqeta representative.\n\nUse this endpoint to return card data for use in provisioning a digital wallet token into Samsung Wallet.\n\nThe returned card data is encrypted using the digital wallet provider's encryption key, thereby reducing your PCI compliance overhead." }, { "info": { "name": "Create digital wallet token provisioning request for XPay", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwalletprovisionrequests/xpay", "body": { "type": "json", "data": "{}" } }, "docs": "[NOTE]\nThis endpoint is limited in availability.\nFor more information, contact your Marqeta representative.\n\nUse this endpoint to return card data for use in provisioning a digital wallet token into an XPay digital wallet.\n\nThe returned card data is encrypted using the digital wallet provider's encryption key, thereby reducing your PCI compliance overhead." }, { "info": { "name": "Delete an additional Visa Alias", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/digitalwallets/aliasdirectory/visa/additionalAliases/:additionalAliasId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "additionalAliasId", "value": "a44c9553-e687-4f3c-b7e7-a4245d9f238e", "type": "path", "description": "Unique identifier of the additional Visa Aliases." } ] }, "docs": "Use this endpoint to delete an additional Visa Alias by its Visa Alias ID." }, { "info": { "name": "Create a Visa Alias", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a Visa Alias." }, { "info": { "name": "Retrieve alias internal ID", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/aliasId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to retrieve the internal ID associated with a Visa Alias." }, { "info": { "name": "Retrieve Visa Alias by external ID", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/getByExternalId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to retrieve a Visa Alias by its external ID." }, { "info": { "name": "Check for Visa Alias", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/inquiry", "headers": [ { "name": "participant-id", "value": "123456789001" }, { "name": "req-sys-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to check for available Visa Aliases for alias resolution.\nOne or more Visa Aliases may be available." }, { "info": { "name": "Resolve a Visa Alias", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/resolve", "headers": [ { "name": "participant-id", "value": "123456789001" }, { "name": "req-sys-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve information about a Visa Alias and all the associated payment credentials." }, { "info": { "name": "Retrieve Visa Alias by Visa Alias ID", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/:aliasId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "Unique identifier of the Visa Alias." } ] }, "docs": "Use this endpoint to retrieve a Visa Alias by its Visa Alias ID." }, { "info": { "name": "Update Visa Alias by Visa Alias ID", "type": "http" }, "http": { "method": "PUT", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/:aliasId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "Unique identifier of the Visa Alias." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update a Visa Alias by its Visa Alias ID." }, { "info": { "name": "Delete Visa Alias by Visa Alias ID", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/:aliasId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "aliasId", "value": "a44c9553-e687-4f3c-b7e7-a4245d9f238e", "type": "path", "description": "Unique identifier of the Visa Alias." } ] }, "docs": "Use this endpoint to delete a Visa Alias by Visa Alias ID." }, { "info": { "name": "Create an additional Visa Alias", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/:aliasId/additionalAlias", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "Unique identifier of the Visa Alias." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create additional Visa Aliases associated with an existing main Visa Alias." }, { "info": { "name": "Retrieve a Visa Alias payment credentials", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/:aliasId/cards", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "Unique identifier of the Visa Alias." } ] }, "docs": "Use this endpoint to retrieve a list of payment credentials associated with a Visa Alias." }, { "info": { "name": "Create Visa Alias payment credential", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/:aliasId/cards", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "Unique identifier of the Visa Alias." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a payment credential associated with a Visa Alias." }, { "info": { "name": "Update alias status", "type": "http" }, "http": { "method": "PUT", "url": "/v3/digitalwallets/aliasdirectory/visa/aliases/:aliasId/status", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "Unique identifier of the Visa Alias." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the status of a Visa Alias." }, { "info": { "name": "Retrieve payment credential", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/aliasdirectory/visa/cards/:paymentCredentialId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "paymentCredentialId", "value": "", "type": "path", "description": "Unique identifier of an existing payment credential." } ] }, "docs": "Use this endpoint to retrieve an existing payment credential." }, { "info": { "name": "Update payment credential", "type": "http" }, "http": { "method": "PUT", "url": "/v3/digitalwallets/aliasdirectory/visa/cards/:paymentCredentialId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "paymentCredentialId", "value": "", "type": "path", "description": "Unique identifier of an existing payment credential." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update an existing payment credential." }, { "info": { "name": "Delete an existing payment credential", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/digitalwallets/aliasdirectory/visa/cards/:paymentCredentialId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "paymentCredentialId", "value": "1234567890", "type": "path", "description": "Unique identifier of an existing payment credential." } ] }, "docs": "Use this endpoint to delete an existing payment credential." }, { "info": { "name": "Create a report request", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/aliasdirectory/visa/reports", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new report request." }, { "info": { "name": "Retrieve report status by report ID", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/aliasdirectory/visa/reports/:reportId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "reportId", "value": "", "type": "path", "description": "Unique identifier of the report." } ] }, "docs": "Use this endpoint to retrieve the status of a report by its report ID." }, { "info": { "name": "Retrieve file by file ID and report ID", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/aliasdirectory/visa/reports/:reportId/file/:fileId", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "participant-id", "value": "123456789001" } ], "params": [ { "name": "reportId", "value": "", "type": "path", "description": "Unique identifier of the report." }, { "name": "fileId", "value": "", "type": "path", "description": "Unique identifier of the file." } ] }, "docs": "Use this endpoint to retrieve a file by its file ID and report ID." }, { "info": { "name": "Check eligibility for Click to Pay for Mastercard", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/clicktopay/mastercard/checkeligibility", "headers": [ { "name": "req-sys-id", "value": "" } ], "params": [ { "name": "bin_prefix", "value": "", "type": "query", "description": "Prefix of the bank identification number." }, { "name": "include_asset", "value": "", "type": "query", "description": "Returns a list of image assets for the Click to Pay logo if set to `true`." } ] }, "docs": "Use this endpoint to check if a provided BIN prefix is eligible for Click to Pay for Mastercard.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Enroll a card to Click to Pay for Mastercard", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/clicktopay/mastercard/enroll", "headers": [ { "name": "req-sys-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to enroll a card in Click to Pay for Mastercard.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Retrieve Click to Pay for Mastercard enrollment status", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/clicktopay/mastercard/status/:token", "headers": [ { "name": "req-sys-id", "value": "" } ], "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the Click to Pay request." } ] }, "docs": "Use this endpoint to return the status of a specific Click to Pay for Mastercard request.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Update card information for Click to Pay for Visa", "type": "http" }, "http": { "method": "PUT", "url": "/v3/digitalwallets/clicktopay/visa/cards", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" }, { "name": "external-consumer-id-owner-bid", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update card information for Click to Pay for Visa.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Delete card information for Click to Pay for Visa", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/digitalwallets/clicktopay/visa/cards/:card_token", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" }, { "name": "external-consumer-id-owner-bid", "value": "" } ], "params": [ { "name": "card_token", "value": "2345678901", "type": "path", "description": "Unique identifier of the cardholder." } ] }, "docs": "Use this endpoint to delete card information for Click to Pay for Visa.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Enroll a cardholder to Click to Pay for Visa", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/clicktopay/visa/enroll", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "external-consumer-id-owner-bid", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to enroll a new cardholder in Click to Pay for Visa.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Enroll a card to Click to Pay for Visa", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/clicktopay/visa/enrollcards", "headers": [ { "name": "req-sys-id", "value": "" }, { "name": "external-consumer-id-owner-bid", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to enroll a new card for an existing cardholder in Click to Pay for Visa.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Retrieve user data for Click to Pay for Visa", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/clicktopay/visa/getdata/:user_token", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" }, { "name": "external-consumer-id-owner-bid", "value": "" } ], "params": [ { "name": "user_token", "value": "1234567890", "type": "path", "description": "Unique identifier of the cardholder." } ] }, "docs": "Use this endpoint to get user data for Click to Pay for Visa.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Retrieve Click to Pay for Visa request status", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallets/clicktopay/visa/status/:requestTraceId", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" }, { "name": "external-consumer-id-owner-bid", "value": "" } ], "params": [ { "name": "requestTraceId", "value": "2b6f0cc904d137be2e1730235f5664094b83", "type": "path", "description": "Unique identifier of the Visa Click to Pay request." } ] }, "docs": "Use this endpoint to return the status of a Click to Pay for Visa request.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Update cardholder information for Click to Pay for Visa", "type": "http" }, "http": { "method": "PUT", "url": "/v3/digitalwallets/clicktopay/visa/users", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" }, { "name": "external-consumer-id-owner-bid", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update cardholder information for Click to Pay for Visa.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Delete cardholder information for Click to Pay for Visa", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/digitalwallets/clicktopay/visa/users", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" } ] }, "docs": "Use this endpoint to delete cardholder information for Click to Pay for Visa.\n\nFor more information about this ecommerce checkout solution, see <>." }, { "info": { "name": "Submit a post-tokenization authentication decision", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/postTokenizationAuthenticationDecision", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to submit a post-tokenization authentication decision from the customer to Marqeta in a secure card on file scenario.\nMarqeta validates the request, stores it, and forwards the authentication decision to Mastercard MDES in real time.\nMarqeta then returns the MDES response back to the customer synchronously.\nThis enables issuers to notify Mastercard Digital Enablement Service (MDES) of the cardholder's authentication outcome following tokenization, ensuring that the token reques" }, { "info": { "name": "Create request for Apple Wallet web push provisioning", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/wpp/applePayJWT", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to add a card to Apple Wallet via a web application." }, { "info": { "name": "Create request for Google Wallet web push provisioning", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/wpp/googlePayPushProvisioningNotification", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to add a card to Google Wallet via a web application.\n\nThis endpoint does not return a payload in response to a request.\nInstead, a successful call will return a response code only." }, { "info": { "name": "List digital wallet tokens", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallettokens", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of digital wallet token resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first digital wallet token resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." }, { "name": "start_date", "value": "", "type": "query", "description": "Date when the digital wallet token becomes active." }, { "name": "end_date", "value": "", "type": "query", "description": "Expiration date of the digital wallet token." }, { "name": "pan_reference_id", "value": "", "type": "query", "description": "Unique identifier of the digital wallet token primary account number (PAN) within the card network.\nThis value may vary, depending on the digital wallet.\nFor example, the `pan_reference_id` may be different in Apple Wallet and Google Wallet for the same digital wallet token." }, { "name": "token_reference_id", "value": "", "type": "query", "description": "Unique identifier of the digital wallet token within the card network.\nThe `token_reference_id` is unique at the card network level." }, { "name": "correlation_id", "value": "", "type": "query", "description": "Unique value representing a tokenization request (Mastercard only)." }, { "name": "token_type", "value": "", "type": "query", "description": "Comma-delimited list of digital wallet token types to display." }, { "name": "token_requestor_name", "value": "", "type": "query", "description": "Name of the token requestor within the card network.\n\n*NOTE:* The list of example values for this field is maintained by the card networks and is subject to change." }, { "name": "state", "value": "", "type": "query", "description": "Comma-delimited list of digital wallet token states to display." }, { "name": "embed", "value": "", "type": "query", "description": "An optional embedded user object." } ] }, "docs": "Use this endpoint to retrieve a list of digital wallet tokens." }, { "info": { "name": "List digital wallet tokens for card", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallettokens/card/:card_token", "params": [ { "name": "card_token", "value": "", "type": "path", "description": "Unique identifier of the card.\nUsed to minimize the need to exchange card details during subsequent calls, and also for troubleshooting." }, { "name": "count", "value": "", "type": "query", "description": "Number of digital wallet token resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first digital wallet token resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Use this endpoint to return an array of all digital wallet tokens for a particular card.\n\nThis endpoint supports <>." }, { "info": { "name": "Retrieve digital wallet token", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallettokens/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the digital wallet token (DWT)." } ] }, "docs": "Use this endpoint to retrieve a specific digital wallet token." }, { "info": { "name": "Retrieve digital wallet token PAN", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallettokens/:token/showtokenpan", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the digital wallet token (DWT)." } ] }, "docs": "Use this endpoint to retrieve a digital wallet token with the entire primary account number (PAN) displayed.\nThe PAN returned is of the digital wallet token and not of the card.\n(For security reasons, the PAN is not fully visible on the digital wallet token returned by `GET` `/digitalwallettokens/{token}`.)\n\n[WARNING]\nSending a request to this endpoint requires PCI DSS compliance.\nYou must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card da" }, { "info": { "name": "Create digital wallet token transition", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallettokentransitions", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to transition a digital wallet token from one state to another." }, { "info": { "name": "List transitions for digital wallet token", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallettokentransitions/digitalwallettoken/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the digital wallet token (DWT)." }, { "name": "count", "value": "", "type": "query", "description": "Number of digital wallet transitions to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "The sort order index of the first digital wallet token in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Use this endpoint to return an array of all transitions for a particular digital wallet token.\n\nThis endpoint supports <>, <>, and <>." }, { "info": { "name": "Retrieve digital wallet token transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/digitalwallettokentransitions/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the digital wallet token (DWT) transition." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." } ] }, "docs": "Use this endpoint to retrieve a specific digital wallet token transition.\n\nThis endpoint supports <>." } ] }, { "info": { "name": "web push provisioning", "type": "folder" }, "items": [ { "info": { "name": "API to query for the web push provisioning related parameters, such as: google piaid/integrator_id, apple partnerId, apple Card Template Identifier", "type": "http" }, "http": { "method": "POST", "url": "/v3/digitalwallets/wpp/parameters", "headers": [ { "name": "req-sys-id", "value": "123d837e-958a-4e9f-bc97-4843ec948123" } ], "body": { "type": "json", "data": "{}" } }, "docs": "API to query for the web push provisioning related parameters, such as: google piaid/integrator_id, apple partnerId, apple Card Template Identifier" } ] }, { "info": { "name": "direct deposits", "type": "folder" }, "items": [ { "info": { "name": "Lists all direct deposits", "type": "http" }, "http": { "method": "GET", "url": "/v3/directdeposits", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of direct deposits to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "reversed_after_grace_period", "value": "", "type": "query", "description": "Reversed after grace period" }, { "name": "user_token", "value": "", "type": "query", "description": "User token" }, { "name": "business_token", "value": "", "type": "query", "description": "Business token" }, { "name": "direct_deposit_state", "value": "", "type": "query", "description": "Direct deposit state" }, { "name": "start_settlement_date", "value": "", "type": "query", "description": "Start settlement date" }, { "name": "end_settlement_date", "value": "", "type": "query", "description": "End settlement date" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all direct deposits" }, { "info": { "name": "Returns an account and routing number which can be used for direct deposit", "type": "http" }, "http": { "method": "GET", "url": "/v3/directdeposits/accounts/:user_or_business_token", "params": [ { "name": "user_or_business_token", "value": "", "type": "path" } ] }, "docs": "Returns an account and routing number which can be used for direct deposit" }, { "info": { "name": "Updates a specific direct deposit account", "type": "http" }, "http": { "method": "PUT", "url": "/v3/directdeposits/accounts/:user_or_business_token", "params": [ { "name": "user_or_business_token", "value": "", "type": "path", "description": "User or business token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific direct deposit account" }, { "info": { "name": "Returns a list of direct deposit transitions", "type": "http" }, "http": { "method": "GET", "url": "/v3/directdeposits/transitions", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of direct deposit transitions to retrieve" }, { "name": "user_token", "value": "", "type": "query", "description": "User token" }, { "name": "business_token", "value": "", "type": "query", "description": "Business token" }, { "name": "direct_deposit_token", "value": "", "type": "query", "description": "Direct deposit token" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" }, { "name": "states", "value": "", "type": "query", "description": "Comma-delimited list of direct deposit states to display e.g. PENDING | REVERSED | APPLIED | REJECTED " } ] }, "docs": "Returns a list of direct deposit transitions" }, { "info": { "name": "Creates a direct deposit transition", "type": "http" }, "http": { "method": "POST", "url": "/v3/directdeposits/transitions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a direct deposit transition" }, { "info": { "name": "Returns a direct deposit transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/directdeposits/transitions/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Returns a direct deposit transition" }, { "info": { "name": "Returns a direct deposit entry", "type": "http" }, "http": { "method": "GET", "url": "/v3/directdeposits/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Returns a direct deposit entry" } ] }, { "info": { "name": "fee charges", "type": "folder" }, "items": [ { "info": { "name": "Creates a fee charge", "type": "http" }, "http": { "method": "POST", "url": "/v3/feecharges", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a fee charge" }, { "info": { "name": "Creates a realTime fee charge", "type": "http" }, "http": { "method": "POST", "url": "/v3/feecharges/realtime", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a realTime fee charge" }, { "info": { "name": "Returns a fee charge", "type": "http" }, "http": { "method": "GET", "url": "/v3/feecharges/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Returns a fee charge" } ] }, { "info": { "name": "fee refunds", "type": "folder" }, "items": [ { "info": { "name": "Creates a fee refund", "type": "http" }, "http": { "method": "POST", "url": "/v3/feerefunds", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a fee refund" } ] }, { "info": { "name": "funding sources", "type": "folder" }, "items": [ { "info": { "name": "Registers an ACH funding source", "type": "http" }, "http": { "method": "POST", "url": "/v3/fundingsources/ach", "body": { "type": "json", "data": "{}" } }, "docs": "Registers an ACH funding source" }, { "info": { "name": "Registers an ACH funding source through a partner", "type": "http" }, "http": { "method": "POST", "url": "/v3/fundingsources/ach/partner", "body": { "type": "json", "data": "{}" } }, "docs": "Registers an ACH funding source through a partner" }, { "info": { "name": "Retrieves a linked funding source balance from a partner", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/ach/partner/:funding_source_token/balance", "params": [ { "name": "funding_source_token", "value": "", "type": "path", "description": "Funding source token" } ] }, "docs": "Retrieves a linked funding source balance from a partner" }, { "info": { "name": "Returns a user ACH account", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/ach/:funding_source_token", "params": [ { "name": "funding_source_token", "value": "", "type": "path", "description": "Funding account token" } ] }, "docs": "Returns a user ACH account" }, { "info": { "name": "Verifies a bank account as a funding source", "type": "http" }, "http": { "method": "PUT", "url": "/v3/fundingsources/ach/:funding_source_token", "params": [ { "name": "funding_source_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verifies a bank account as a funding source" }, { "info": { "name": "Returns the dollar amounts used to verify the ACH account", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/ach/:funding_source_token/verificationamounts", "params": [ { "name": "funding_source_token", "value": "", "type": "path", "description": "Funding account token" } ] }, "docs": "Returns the dollar amounts used to verify the ACH account" }, { "info": { "name": "Creates an account holder address for a funding source", "type": "http" }, "http": { "method": "POST", "url": "/v3/fundingsources/addresses", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an account holder address for a funding source" }, { "info": { "name": "Lists all addresses for a business", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/addresses/business/:business_token", "params": [ { "name": "business_token", "value": "", "type": "path", "description": "Business token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Lists all addresses for a business" }, { "info": { "name": "Lists all addresses for a user", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/addresses/user/:user_token", "params": [ { "name": "user_token", "value": "", "type": "path", "description": "User token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Lists all addresses for a user" }, { "info": { "name": "Returns a user address for a funding source", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/addresses/:funding_source_address_token", "params": [ { "name": "funding_source_address_token", "value": "", "type": "path", "description": "Funding source address token" } ] }, "docs": "Returns a user address for a funding source" }, { "info": { "name": "Updates the account holder address for a funding source", "type": "http" }, "http": { "method": "PUT", "url": "/v3/fundingsources/addresses/:funding_source_address_token", "params": [ { "name": "funding_source_address_token", "value": "", "type": "path", "description": "Funding source address token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the account holder address for a funding source" }, { "info": { "name": "Lists all funding sources for a business", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/business/:business_token", "params": [ { "name": "business_token", "value": "", "type": "path", "description": "Business token" }, { "name": "type", "value": "", "type": "query", "description": "Type, such as a payment card or ACH" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Lists all funding sources for a business" }, { "info": { "name": "Registers a payment card funding source", "type": "http" }, "http": { "method": "POST", "url": "/v3/fundingsources/paymentcard", "body": { "type": "json", "data": "{}" } }, "docs": "Registers a payment card funding source" }, { "info": { "name": "Returns a specific payment card", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/paymentcard/:funding_source_token", "params": [ { "name": "funding_source_token", "value": "", "type": "path", "description": "Funding token" } ] }, "docs": "Returns a specific payment card" }, { "info": { "name": "Updates a specific payment card ", "type": "http" }, "http": { "method": "PUT", "url": "/v3/fundingsources/paymentcard/:funding_source_token", "params": [ { "name": "funding_source_token", "value": "", "type": "path", "description": "Funding account token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific payment card " }, { "info": { "name": "Creates a program funding source", "type": "http" }, "http": { "method": "POST", "url": "/v3/fundingsources/program", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a program funding source" }, { "info": { "name": "Returns a list of Program ACH funding sources", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/program/ach", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve. Count can be between 1 - 10 items." }, { "name": "start_index", "value": "", "type": "query", "description": "Indicates from what row to start returning data." }, { "name": "fields", "value": "", "type": "query", "description": "Comma delimited list of fields to return (e.g. field_1,field_2,..)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" }, { "name": "active", "value": "", "type": "query", "description": "Returns programs with this active state" } ] }, "docs": "Returns a list of Program ACH funding sources" }, { "info": { "name": "Registers an ACH funding source for a program", "type": "http" }, "http": { "method": "POST", "url": "/v3/fundingsources/program/ach", "body": { "type": "json", "data": "{}" } }, "docs": "Registers an ACH funding source for a program" }, { "info": { "name": "Returns a specific program funding source", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/program/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Program funding source token" } ] }, "docs": "Returns a specific program funding source" }, { "info": { "name": "Updates a specific program funding source", "type": "http" }, "http": { "method": "PUT", "url": "/v3/fundingsources/program/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Program funding source token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific program funding source" }, { "info": { "name": "Creates a gateway program funding source", "type": "http" }, "http": { "method": "POST", "url": "/v3/fundingsources/programgateway", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a gateway program funding source" }, { "info": { "name": "Updates a specific gateway program funding source Custom headers", "type": "http" }, "http": { "method": "PUT", "url": "/v3/fundingsources/programgateway/customheaders/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Gateway program funding source token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific gateway program funding source Custom headers" }, { "info": { "name": "Returns a gateway program funding source", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/programgateway/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Gateway program funding source token" } ] }, "docs": "Returns a gateway program funding source" }, { "info": { "name": "Updates a specific gateway program funding source", "type": "http" }, "http": { "method": "PUT", "url": "/v3/fundingsources/programgateway/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Gateway program funding source token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific gateway program funding source" }, { "info": { "name": "Lists all funding sources for a user", "type": "http" }, "http": { "method": "GET", "url": "/v3/fundingsources/user/:user_token", "params": [ { "name": "user_token", "value": "", "type": "path", "description": "User token" }, { "name": "type", "value": "", "type": "query", "description": "Type, such as a payment card or ACH" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Lists all funding sources for a user" }, { "info": { "name": "Configures a default funding source", "type": "http" }, "http": { "method": "PUT", "url": "/v3/fundingsources/:funding_source_token/default", "params": [ { "name": "funding_source_token", "value": "", "type": "path", "description": "Funding account" } ] }, "docs": "Configures a default funding source" } ] }, { "info": { "name": "gpa orders", "type": "folder" }, "items": [ { "info": { "name": "Funds a user's GPA account", "type": "http" }, "http": { "method": "POST", "url": "/v3/gpaorders", "body": { "type": "json", "data": "{}" } }, "docs": "Funds a user's GPA account" }, { "info": { "name": "Lists all GPA returns", "type": "http" }, "http": { "method": "GET", "url": "/v3/gpaorders/unloads", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of GPA unloads to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" }, { "name": "user_token", "value": "", "type": "query", "description": "User token" }, { "name": "business_token", "value": "", "type": "query", "description": "Business token" }, { "name": "original_order_token", "value": "", "type": "query", "description": "Original order token" } ] }, "docs": "Lists all GPA returns" }, { "info": { "name": "Returns a GPA order", "type": "http" }, "http": { "method": "POST", "url": "/v3/gpaorders/unloads", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a GPA order" }, { "info": { "name": "Returns a specific GPA return", "type": "http" }, "http": { "method": "GET", "url": "/v3/gpaorders/unloads/:unload_token", "params": [ { "name": "unload_token", "value": "", "type": "path", "description": "Unload token" } ] }, "docs": "Returns a specific GPA return" }, { "info": { "name": "Returns a GPA order", "type": "http" }, "http": { "method": "GET", "url": "/v3/gpaorders/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Returns a GPA order" } ] }, { "info": { "name": "Internal - BIN Pools", "type": "folder" }, "items": [ { "info": { "name": "Get all BIN pools", "type": "http" }, "http": { "method": "GET", "url": "/v3/internal/binpools" }, "docs": "Returns a list of all BIN pools" }, { "info": { "name": "Create BIN pool", "type": "http" }, "http": { "method": "POST", "url": "/v3/internal/binpools", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new BIN pool" }, { "info": { "name": "Get BIN pool by token", "type": "http" }, "http": { "method": "GET", "url": "/v3/internal/binpools/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Pool token" } ] }, "docs": "Returns details of a specific BIN pool" }, { "info": { "name": "Update BIN pool", "type": "http" }, "http": { "method": "PUT", "url": "/v3/internal/binpools/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Pool token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing BIN pool" }, { "info": { "name": "Delete BIN pool", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/internal/binpools/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Pool token" } ] }, "docs": "Soft deletes a BIN pool by setting active=false" } ] }, { "info": { "name": "kyc", "type": "folder" }, "items": [ { "info": { "name": "Performs a KYC", "type": "http" }, "http": { "method": "POST", "url": "/v3/kyc", "body": { "type": "json", "data": "{}" } }, "docs": "Performs a KYC" }, { "info": { "name": "Lists all KYC results for a business", "type": "http" }, "http": { "method": "GET", "url": "/v3/kyc/business/:business_token", "params": [ { "name": "business_token", "value": "", "type": "path", "description": "Business token" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all KYC results for a business" }, { "info": { "name": "Lists all KYC results for a user", "type": "http" }, "http": { "method": "GET", "url": "/v3/kyc/user/:user_token", "params": [ { "name": "user_token", "value": "", "type": "path", "description": "User token" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all KYC results for a user" }, { "info": { "name": "Returns a specific KYC result", "type": "http" }, "http": { "method": "GET", "url": "/v3/kyc/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "KYC token" } ] }, "docs": "Returns a specific KYC result" } ] }, { "info": { "name": "mcc groups", "type": "folder" }, "items": [ { "info": { "name": "Lists all MCC groups", "type": "http" }, "http": { "method": "GET", "url": "/v3/mccgroups", "params": [ { "name": "mcc", "value": "", "type": "query", "description": "MCC" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve. Count can be between 1 - 10 items." }, { "name": "start_index", "value": "", "type": "query", "description": "Indicates from what row to start returning data." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime." } ] }, "docs": "Lists all MCC groups" }, { "info": { "name": "Creates an MCC group", "type": "http" }, "http": { "method": "POST", "url": "/v3/mccgroups", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an MCC group" }, { "info": { "name": "Returns a specific MCC group", "type": "http" }, "http": { "method": "GET", "url": "/v3/mccgroups/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "MCC group token" } ] }, "docs": "Returns a specific MCC group" }, { "info": { "name": "Updates an MCC group", "type": "http" }, "http": { "method": "PUT", "url": "/v3/mccgroups/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an MCC group" } ] }, { "info": { "name": "merchantgroups", "type": "folder" }, "items": [ { "info": { "name": "Lists all Merchant Groups", "type": "http" }, "http": { "method": "GET", "url": "/v3/merchantgroups", "params": [ { "name": "mid", "value": "", "type": "query", "description": "mid" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve. Count can be between 1 - 10 items." }, { "name": "start_index", "value": "", "type": "query", "description": "Indicates from what row to start returning data." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime." } ] }, "docs": "Lists all Merchant Groups" }, { "info": { "name": "Creates a merchant group", "type": "http" }, "http": { "method": "POST", "url": "/v3/merchantgroups", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a merchant group" }, { "info": { "name": "Returns a Merchant Group", "type": "http" }, "http": { "method": "GET", "url": "/v3/merchantgroups/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Merchant Group token" } ] }, "docs": "Returns a Merchant Group" }, { "info": { "name": "Updates an Merchant Group", "type": "http" }, "http": { "method": "PUT", "url": "/v3/merchantgroups/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an Merchant Group" } ] }, { "info": { "name": "Migrations", "type": "folder" }, "items": [ { "info": { "name": "Get finalize status", "type": "http" }, "http": { "method": "GET", "url": "/v3/migrations/accounts/:account_token/finalize", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to get the finalize status.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ] }, "docs": "Called to retrieve the finalize status of a migrated account\n" }, { "info": { "name": "Get the current balance and available credit for a credit account", "type": "http" }, "http": { "method": "GET", "url": "/v3/migrations/accounts/:account_token/getaccountbalances", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to retrieve fees.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." } ] }, "docs": "Retrieve the current balance, available credit for a credit account." }, { "info": { "name": "Sync statement asset", "type": "http" }, "http": { "method": "POST", "url": "/v3/migrations/accounts/:account_token/statements/:statement_summary_token/files", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to sync a statement asset.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "statement_summary_token", "value": "", "type": "path", "description": "Unique identifier of the migrated statement summary for which you want to sync an asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sync a statement asset to a migrated statement summary." } ] }, { "info": { "name": "Payment Sources", "type": "folder" }, "items": [ { "info": { "name": "List payment sources", "type": "http" }, "http": { "method": "GET", "url": "/v3/paymentsources", "params": [ { "name": "account_token", "value": "", "type": "query", "description": "Unique identifier of the credit account associated with the payment source." }, { "name": "user_token", "value": "", "type": "query", "description": "Unique identifier of the user associated with the payment source." }, { "name": "business_token", "value": "", "type": "query", "description": "Unique identifier of the business associated with the payment source." }, { "name": "count", "value": "", "type": "query", "description": "Number of payment source resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." }, { "name": "statuses", "value": "", "type": "query", "description": "Array of statuses to use for filtering payment sources." } ] }, "docs": "Retrieve an array of payment sources.\n\nThis endpoint supports <>." }, { "info": { "name": "Create payment source", "type": "http" }, "http": { "method": "POST", "url": "/v3/paymentsources", "body": { "type": "json", "data": "{}" } }, "docs": "Create a payment source from which to make payments." }, { "info": { "name": "Retrieve payment source", "type": "http" }, "http": { "method": "GET", "url": "/v3/paymentsources/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the payment source to retrieve.\n\nSend a `GET` request to `/credit/paymentsources` to retrieve existing payment source tokens." } ] }, "docs": "Retrieve a payment source." }, { "info": { "name": "Update payment source", "type": "http" }, "http": { "method": "PUT", "url": "/v3/paymentsources/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the payment source to retrieve.\n\nSend a `GET` request to `/credit/paymentsources` to retrieve existing payment source tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update details of a payment source." } ] }, { "info": { "name": "peer transfers", "type": "folder" }, "items": [ { "info": { "name": "Performs a peer transfer from one user to another", "type": "http" }, "http": { "method": "POST", "url": "/v3/peertransfers", "body": { "type": "json", "data": "{}" } }, "docs": "Performs a peer transfer from one user to another" }, { "info": { "name": "Returns all peer transfers for a user", "type": "http" }, "http": { "method": "GET", "url": "/v3/peertransfers/user/:user_or_business_token", "params": [ { "name": "user_or_business_token", "value": "", "type": "path", "description": "User or business token" }, { "name": "count", "value": "", "type": "query", "description": "Number of transfers to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns all peer transfers for a user" }, { "info": { "name": "Returns received peer transfers for a user", "type": "http" }, "http": { "method": "GET", "url": "/v3/peertransfers/user/:user_or_business_token/recipient", "params": [ { "name": "user_or_business_token", "value": "", "type": "path", "description": "User or business token" }, { "name": "count", "value": "", "type": "query", "description": "Number of transfers to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns received peer transfers for a user" }, { "info": { "name": "Returns sent peer transfers for a user", "type": "http" }, "http": { "method": "GET", "url": "/v3/peertransfers/user/:user_or_business_token/sender", "params": [ { "name": "user_or_business_token", "value": "", "type": "path", "description": "User or business token" }, { "name": "count", "value": "", "type": "query", "description": "Number of transfers to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns sent peer transfers for a user" }, { "info": { "name": "Returns details of a previous transfer", "type": "http" }, "http": { "method": "GET", "url": "/v3/peertransfers/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Returns details of a previous transfer" } ] }, { "info": { "name": "ping", "type": "folder" }, "items": [ { "info": { "name": "Returns a heartbeat to the consumer", "type": "http" }, "http": { "method": "GET", "url": "/v3/ping" }, "docs": "Tests if the Marqeta server is available and responsive." }, { "info": { "name": "Echo test for sending payload to server", "type": "http" }, "http": { "method": "POST", "url": "/v3/ping", "body": { "type": "json", "data": "{}" } }, "docs": "Echo test for sending payload to server" } ] }, { "info": { "name": "PINs", "type": "folder" }, "items": [ { "info": { "name": "Create or update PIN", "type": "http" }, "http": { "method": "PUT", "url": "/v3/pins", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a personal identification number (PIN) for an existing card.\nAlthough cardholders might choose a four-, five-, or six-digit PIN if they set their PIN at an automated teller machine, they can only set a four-digit PIN using Marqeta's Set PIN widget or the create or update PIN endpoint (`PUT /pins`).\nCardholders can update their PIN through the API regardless of its length, but the new PIN value they choose must contain four digits.\n\nIf you want to manage a card's PIN, first cre" }, { "info": { "name": "Create PIN control token", "type": "http" }, "http": { "method": "POST", "url": "/v3/pins/controltoken", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a control token necessary when creating or updating a card's personal identification number (PIN).\n\nCreating, updating, or revealing a card's PIN is a two-step process.\nYou must first create the control token that is required to create the PIN, and then you create, update, or reveal the PIN itself.\n\nThe lifespan of the control token in a production environment is either five minutes or one hour from creation, depending on the token type.\nIf multiple tokens are requested for a single card" }, { "info": { "name": "Reveal PIN", "type": "http" }, "http": { "method": "POST", "url": "/v3/pins/reveal", "body": { "type": "json", "data": "{}" } }, "docs": "Reveals the personal identification number (PIN) of an existing, active card.\nBe aware that while a cardholder can only set a four-digit PIN using the Marqeta Set PIN widget or `PUT /pins` API, you may see a four-, five-, or six-digit PIN in cases where your cardholders have set a new PIN at an automated teller machine.\n\n[WARNING]\nOnly use this endpoint to access a PIN in order to reveal it to its cardholder.\nDo not use this endpoint for the purpose of storing a PIN at any location.\n\nSending a r" } ] }, { "info": { "name": "Policies", "type": "folder" }, "items": [ { "info": { "name": "List APR policies", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/aprs", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of APR policy resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `effectiveDate`, and not by the field names appearing in response bodies such as `effective_date`." } ] }, "docs": "Retrieve an array of existing APR policies.\n\nThis endpoint supports <>." }, { "info": { "name": "Create APR policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/aprs", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new annual percentage rate (APR) policy." }, { "info": { "name": "Retrieve APR policy", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/aprs/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the APR policy to retrieve.\n\nSend a `GET` request to `/policies/aprs` to retrieve existing APR policy tokens." } ] }, "docs": "Retrieve a specific annual percentage rate (APR) policy.\n\nThis endpoint supports <>." }, { "info": { "name": "Update APR policy", "type": "http" }, "http": { "method": "PUT", "url": "/v3/policies/aprs/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the APR policy to update.\n\nSend a `GET` request to `/policies/aprs` to retrieve existing APR policy tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific APR policy." }, { "info": { "name": "Clone APR policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/aprs/:token/clone", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the APR policy to clone.\n\nSend a `GET` request to `/policies/aprs` to retrieve existing APR policy tokens." } ] }, "docs": "Create a new annual percentage rate (APR) policy based on an existing APR policy." }, { "info": { "name": "List APR schedules", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/aprs/:token/schedule", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the APR policy on which to retrieve APR schedules.\n\nSend a `GET` request to `/policies/aprs` to retrieve existing product policy tokens." }, { "name": "count", "value": "", "type": "query", "description": "Number of APR schedule resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of the historic annual percentage rate (APR) schedules on a specific APR policy.\n\nThis endpoint supports <>." }, { "info": { "name": "List document policies", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/documents", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of document policy resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of existing document policies.\nA document policy consists of all the pre- and post-application disclosures and credit program documents known as assets and templates.\nAssets contain finalized values after a bundle is created; templates do not contain finalized values.\n\nThis endpoint supports <>." }, { "info": { "name": "Create document policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/documents", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates.\nAssets contain finalized values after a bundle is created; templates do not contain finalized values." }, { "info": { "name": "Retrieve document policy", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/documents/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the document policy to retrieve.\n\nSend a `GET` request to `/policies/documents` to retrieve existing document policy tokens." } ] }, "docs": "Retrieve a specific document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates.\nAssets contain finalized values after a bundle is created; templates do not contain finalized values." }, { "info": { "name": "Update document policy", "type": "http" }, "http": { "method": "PUT", "url": "/v3/policies/documents/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the document policy to update.\n\nSend a `GET` request to `/policies/documents` to retrieve existing document policy tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates.\nAssets contain finalized values after a bundle is created; templates do not contain finalized values." }, { "info": { "name": "Clone document policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/documents/:token/clone", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the document policy to clone.\n\nSend a `GET` request to `/policies/documents` to retrieve existing document policy tokens." } ] }, "docs": "Create a new document policy based on an existing document policy.\nA document policy consists of all the pre- and post-application disclosures and credit program documents known as assets and templates.\nAssets contain finalized values after a bundle is created; templates do not contain finalized values." }, { "info": { "name": "List fee policies", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/fees", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of fee policy resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of existing fee policies.\n\nThis endpoint supports <>." }, { "info": { "name": "Create fee policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/fees", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new fee policy." }, { "info": { "name": "Retrieve fee policy", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/fees/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the fee policy to retrieve.\n\nSend a `GET` request to `/policies/fee` to retrieve existing fee policy tokens." } ] }, "docs": "Retrieve a specific fee policy.\n\nThis endpoint supports <>." }, { "info": { "name": "Update fee policy", "type": "http" }, "http": { "method": "PUT", "url": "/v3/policies/fees/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the fee policy to retrieve.\n\nSend a `GET` request to `/policies/fee` to retrieve existing fee policy tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific fee policy." }, { "info": { "name": "Clone fee policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/fees/:token/clone", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the fee policy to clone.\n\nSend a `GET` request to `/policies/fee` to retrieve existing fee policy tokens." } ] }, "docs": "Create a new fee policy based on an existing fee policy." }, { "info": { "name": "List credit product policies", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/products", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of product policy resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of existing credit product policies.\n\nThis endpoint supports <>." }, { "info": { "name": "Create credit product policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/products", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new credit product policy." }, { "info": { "name": "Retrieve credit product policy", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/products/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the credit product policy to retrieve.\n\nSend a `GET` request to `/policies/products` to retrieve existing credit product policy tokens." } ] }, "docs": "Retrieve a specific credit product policy." }, { "info": { "name": "Update credit product policy", "type": "http" }, "http": { "method": "PUT", "url": "/v3/policies/products/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the credit product policy to retrieve.\n\nSend a `GET` request to `/policies/products` to retrieve existing credit product policy tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific credit product policy." }, { "info": { "name": "Add card product to credit product policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/products/:token/cardproducts", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the credit product policy.\n\nSend a `GET` request to `/policies/products` to retrieve existing credit product policy tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a card product to an existing credit product policy. This endpoint allows the caller to add a card product even if the bundle is ACTIVE." }, { "info": { "name": "Clone credit product policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/products/:token/clone", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the credit product policy to clone.\n\nSend a `GET` request to `/policies/products` to retrieve existing credit product policy tokens." } ] }, "docs": "Create a new credit product policy based on an existing credit product policy." }, { "info": { "name": "List reward policies", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/rewards", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of reward policy resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of reward policies.\n\nThis endpoint supports <>." }, { "info": { "name": "Create reward policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/rewards", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new reward policy." }, { "info": { "name": "Retrieve reward policy", "type": "http" }, "http": { "method": "GET", "url": "/v3/policies/rewards/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the reward policy to retrieve.\n\nSend a `GET` request to `/policies/rewards` to retrieve existing reward policy tokens." } ] }, "docs": "Retrieve a reward policy." }, { "info": { "name": "Update reward policy", "type": "http" }, "http": { "method": "PUT", "url": "/v3/policies/rewards/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the reward policy to update.\n\nSend a `GET` request to `/policies/rewards` to retrieve existing reward policy tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a reward policy." }, { "info": { "name": "Clone reward policy", "type": "http" }, "http": { "method": "POST", "url": "/v3/policies/rewards/:token/clone", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the reward policy to clone.\n\nSend a `GET` request to `/policies/rewards` to retrieve existing reward policy tokens." } ] }, "docs": "Create a new reward policy based on existing reward policy." } ] }, { "info": { "name": "Credit Products", "type": "folder" }, "items": [ { "info": { "name": "List credit products", "type": "http" }, "http": { "method": "GET", "url": "/v3/products", "params": [ { "name": "status", "value": "", "type": "query", "description": "An array of statuses by which to filter credit products." }, { "name": "count", "value": "", "type": "query", "description": "Number of credit product resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of credit products.\n\nThis endpoint supports <>." }, { "info": { "name": "Create credit product", "type": "http" }, "http": { "method": "POST", "url": "/v3/products", "body": { "type": "json", "data": "{}" } }, "docs": "Create a credit product." }, { "info": { "name": "Retrieve credit product", "type": "http" }, "http": { "method": "GET", "url": "/v3/products/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the credit product to retrieve.\n\nSend a `GET` request to `/credit/products` to retrieve existing credit product tokens." } ] }, "docs": "Retrieve a credit product." }, { "info": { "name": "Retrieve credit product lineage", "type": "http" }, "http": { "method": "GET", "url": "/v3/products/:token/lineage", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the credit product whose lineage you want to retrieve.\n\nSend a `GET` request to `/credit/products` to retrieve existing credit product tokens." }, { "name": "status", "value": "", "type": "query", "description": "An array of statuses by which to filter credit products." }, { "name": "count", "value": "", "type": "query", "description": "Number of credit product resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve the lineage of a credit product, which is an array of related credit products whose lineage can be traced back to the same original credit product.\n\nThis endpoint supports <>." } ] }, { "info": { "name": "Program Gateways", "type": "folder" }, "items": [ { "info": { "name": "List Program Gateways", "type": "http" }, "http": { "method": "GET", "url": "/v3/programgateways", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of Program Gateway resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order.\n\n*NOTE:*\nYou must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`." } ] }, "docs": "Retrieve an array of existing Credit Program Gateways.\n\nThis endpoint supports <>." }, { "info": { "name": "Create Program Gateway", "type": "http" }, "http": { "method": "POST", "url": "/v3/programgateways", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Credit Program Gateway.\n\nUse this endpoint to configure your Program Gateway to receive gateway requests from Marqeta's credit platform.\nYou can create multiple Program Gateways, but only one can be active per credit program.\n\n[NOTE]\nTo create a Program Gateway, you must have consumer or admin credentials." }, { "info": { "name": "Retrieve Program Gateway", "type": "http" }, "http": { "method": "GET", "url": "/v3/programgateways/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the Program Gateway to retrieve.\n\nSend a `GET` request to `/credit/programgateways` to retrieve existing Program Gateway tokens." } ] }, "docs": "Retrieve an existing Credit Program Gateway." }, { "info": { "name": "Update Program Gateway", "type": "http" }, "http": { "method": "PUT", "url": "/v3/programgateways/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the Program Gateway to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Credit Program Gateway.\n\nYou may want to update a Program Gateway if you are switching it to active or inactive, updating the URL, username, or password, and more." } ] }, { "info": { "name": "Program Reserve", "type": "folder" }, "items": [ { "info": { "name": "Retrieve reserve account balances", "type": "http" }, "http": { "method": "GET", "url": "/v3/programreserve/balances" }, "docs": "Use this endpoint to return balances for your program reserve account (sometimes referred to as a _program funding account_)." }, { "info": { "name": "List program reserve transactions", "type": "http" }, "http": { "method": "GET", "url": "/v3/programreserve/transactions", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Use this endpoint to return a list of credits and debits made to your program reserve account.\n\nThis endpoint supports <>." } ] }, { "info": { "name": "program reserve", "type": "folder" }, "items": [ { "info": { "name": "getProgramReserveDeposits", "type": "http" }, "http": { "method": "GET", "url": "/v3/programreserve/deposits", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of items to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] } }, { "info": { "name": "deposit", "type": "http" }, "http": { "method": "POST", "url": "/v3/programreserve/deposits", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "Program Transfers", "type": "folder" }, "items": [ { "info": { "name": "List program transfers", "type": "http" }, "http": { "method": "GET", "url": "/v3/programtransfers", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of program transfers to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." }, { "name": "user_token", "value": "", "type": "query", "description": "Unique identifier of the user account holder whose program transfers you want to retrieve.\n\nSend a `GET` request to `/users` to retrieve user tokens." }, { "name": "business_token", "value": "", "type": "query", "description": "Unique identifier of the business account holder whose program transfers you want to retrieve.\n\nSend a `GET` request to `/businesses` to retrieve business tokens." }, { "name": "type_token", "value": "", "type": "query", "description": "Unique identifier of the program transfer type to retrieve." } ] }, "docs": "Use this endpoint to list all program transfers.\n\nTo narrow your result set to program transfers of a particular type or that are associated with a particular account holder, include the appropriate parameters from the following URL Query Parameters table.\nThis endpoint also supports <>, <>, and <>." }, { "info": { "name": "Create program transfer", "type": "http" }, "http": { "method": "POST", "url": "/v3/programtransfers", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a program transfer.\nAdd the program transfer details to the body of the request in link:http://www.json.org/[JSON, window=\"_blank\"] format.\n\nInclude either `user_token` or `business_token` in the message body to specify the account holder whose general purpose account (GPA) will be debited by the program transfer.\nThe user or business must already exist.\n\n[NOTE]\nIf the GPA has insufficient funds to cover both the amount of the program transfer and all attached fees, t" }, { "info": { "name": "List program transfer types", "type": "http" }, "http": { "method": "GET", "url": "/v3/programtransfers/types", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of program transfer types to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Use this endpoint to list all program transfer types.\n\nThis endpoint supports <>, <>, and <>." }, { "info": { "name": "Create program transfer type", "type": "http" }, "http": { "method": "POST", "url": "/v3/programtransfers/types", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a program transfer type.\nAdd the program transfer details to the body of the request in link:http://www.json.org/[JSON, window=\"_blank\"] format.\n\nYou are required to pass in a `program_funding_source_token` to associate a program funding source with the program transfer type.\nYou must therefore create a program funding source before creating a program transfer type." }, { "info": { "name": "Retrieve program transfer type", "type": "http" }, "http": { "method": "GET", "url": "/v3/programtransfers/types/:type_token", "params": [ { "name": "type_token", "value": "", "type": "path", "description": "Unique identifier of the program transfer type." } ] }, "docs": "Use this endpoint to retrieve a specific program transfer.\nInclude the `type_token` path parameter to indicate the program transfer type to return." }, { "info": { "name": "Update program transfer type", "type": "http" }, "http": { "method": "PUT", "url": "/v3/programtransfers/types/:type_token", "params": [ { "name": "type_token", "value": "", "type": "path", "description": "Unique identifier of the program transfer type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update a program transfer type.\nInclude the `type_token` path parameter to indicate the program transfer type to update.\nAdd the modified detail parameters to the body of the request in link:http://www.json.org/[JSON, window=\"_blank\"] format.\nOnly values of parameters in the request are modified; all others are left unchanged." }, { "info": { "name": "Retrieve program transfer", "type": "http" }, "http": { "method": "GET", "url": "/v3/programtransfers/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the program transfer." } ] }, "docs": "Use this endpoint to retrieve a specific program transfer.\nInclude the program transfer `token` path parameter to specify the program transfer to retrieve." } ] }, { "info": { "name": "push to card", "type": "folder" }, "items": [ { "info": { "name": "Lists all push-to-card disbursements", "type": "http" }, "http": { "method": "GET", "url": "/v3/pushtocards/disburse", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of push-to-card disbursements to retrieve" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all push-to-card disbursements" }, { "info": { "name": "Initiates a push-to-card money disbursement", "type": "http" }, "http": { "method": "POST", "url": "/v3/pushtocards/disburse", "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a push-to-card money disbursement" }, { "info": { "name": "Returns a specific push-to-card disbursement", "type": "http" }, "http": { "method": "GET", "url": "/v3/pushtocards/disburse/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Push-to-card disbursement token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns a specific push-to-card disbursement" }, { "info": { "name": "Returns all push-to-card payment card details", "type": "http" }, "http": { "method": "GET", "url": "/v3/pushtocards/paymentcard", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of push-to-card payment cards to retrieve" }, { "name": "user_token", "value": "", "type": "query", "description": "User token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Returns all push-to-card payment card details" }, { "info": { "name": "Adds an external card to which funds will be pushed", "type": "http" }, "http": { "method": "POST", "url": "/v3/pushtocards/paymentcard", "body": { "type": "json", "data": "{}" } }, "docs": "Adds an external card to which funds will be pushed" }, { "info": { "name": "Returns a specific paymentcard object", "type": "http" }, "http": { "method": "GET", "url": "/v3/pushtocards/paymentcard/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Push-to-card token" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." } ] }, "docs": "Returns a specific paymentcard object" } ] }, { "info": { "name": "Real-Time Fee Groups", "type": "folder" }, "items": [ { "info": { "name": "List real-time fee groups", "type": "http" }, "http": { "method": "GET", "url": "/v3/realtimefeegroups", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of real-time fee groups to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "The sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\n\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Use this endpoint to list existing real-time fee groups.\n\nThis endpoint supports <> and <>." }, { "info": { "name": "Create real-time fee group", "type": "http" }, "http": { "method": "POST", "url": "/v3/realtimefeegroups", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a real-time fee group." }, { "info": { "name": "Retrieve real-time fee group", "type": "http" }, "http": { "method": "GET", "url": "/v3/realtimefeegroups/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the real-time fee group." } ] }, "docs": "Use this endpoint to retrieve a specific real-time fee group.\nInclude the real-time fee group `token` path parameter to specify the real-time fee group to return." }, { "info": { "name": "Update real-time fee group", "type": "http" }, "http": { "method": "PUT", "url": "/v3/realtimefeegroups/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the real-time fee group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update a real-time fee group.\nInclude the real-time fee group `token` path parameter to specify the real-time fee group to update." } ] }, { "info": { "name": "simulate", "type": "folder" }, "items": [ { "info": { "name": "Simulates an authorization", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/authorization", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates an authorization" }, { "info": { "name": "Simulates an authorization advice transaction", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/authorization/advice", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates an authorization advice transaction" }, { "info": { "name": "Simulates a clearing/settlement transaction", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/clearing", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a clearing/settlement transaction" }, { "info": { "name": "Simulates the creation of direct deposit", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/directdeposits", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates the creation of direct deposit" }, { "info": { "name": "Simulates a financial request (PIN debit) transaction with optional cash back", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/financial", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a financial request (PIN debit) transaction with optional cash back" }, { "info": { "name": "Simulates a financial advice transaction", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/financial/advice", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a financial advice transaction" }, { "info": { "name": "Simulates a balance inquiry", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/financial/balanceinquiry", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a balance inquiry" }, { "info": { "name": "Simulates an orignal credit transaction", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/financial/originalcredit", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates an orignal credit transaction" }, { "info": { "name": "Simulates an ATM withdrawal transaction", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/financial/withdrawal", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates an ATM withdrawal transaction" }, { "info": { "name": "Simulates a reversal transaction", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulate/reversal", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a reversal transaction" } ] }, { "info": { "name": "Refunds", "type": "folder" }, "items": [ { "info": { "name": "Simulate Refund Transition", "type": "http" }, "http": { "method": "POST", "url": "/v3/simulation/accounts/:account_token/refunds/:refund_token/transitions", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Unique identifier of the credit account for which you want to create a balance refund.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing credit account tokens." }, { "name": "refund_token", "value": "", "type": "path", "description": "Unique identifier of the refund to retrieve.\n\nSend a `GET` request to `/credit/accounts/{account_token}/refunds/{refund_token}` to retrieve existing refunds." } ], "body": { "type": "json", "data": "{}" } }, "docs": "api to simulate status transition of a refund." } ] }, { "info": { "name": "Credit Substatuses", "type": "folder" }, "items": [ { "info": { "name": "List substatuses", "type": "http" }, "http": { "method": "GET", "url": "/v3/substatuses", "params": [ { "name": "account_token", "value": "", "type": "query", "description": "Unique identifier of the account for which to retrieve substatuses.\n\nSend a `GET` request to `/credit/accounts` to retrieve existing account tokens." }, { "name": "user_token", "value": "", "type": "query", "description": "Unique identifier of the user for which to retrieve substatuses.\n\nSend a `GET` request to `/users` to retrieve existing user tokens." }, { "name": "is_active", "value": "", "type": "query", "description": "Denotes whether a substatus is active." }, { "name": "substatuses", "value": "", "type": "query", "description": "Comma-delimited list of substatus types to include.\nAllowable values:\n`HARDSHIP`, `FRAUD`, `MLA`, `SCRA`, `DECEASED`, `BANKRUPTCY`, `POWER_OF_ATTORNEY`, `BLOCKED`, `CEASE_AND_DESIST`, `OPT_OUT`" }, { "name": "count", "value": "", "type": "query", "description": "The number of resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Retrieve an array of substatuses.\nThis endpoint supports <>." }, { "info": { "name": "Create substatus", "type": "http" }, "http": { "method": "POST", "url": "/v3/substatuses", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new substatus for a credit account, user, or business." }, { "info": { "name": "Retrieve substatus", "type": "http" }, "http": { "method": "GET", "url": "/v3/substatuses/:substatus_token", "params": [ { "name": "substatus_token", "value": "", "type": "path", "description": "Unique identifier of the substatus to retrieve.\n\nSend a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens." } ] }, "docs": "Retrieve a user or account substatus." }, { "info": { "name": "Update substatus", "type": "http" }, "http": { "method": "PUT", "url": "/v3/substatuses/:substatus_token", "params": [ { "name": "substatus_token", "value": "", "type": "path", "description": "Unique identifier of the account substatus resource to retrieve.\n\nSend a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updating a substatus registers a new event that changes the substatus' state." } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "/v3/users", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of user resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "search_type", "value": "", "type": "query", "description": "Search type." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "To return an array of all of a program's users, send a `GET` request to the `/users` endpoint.\nThis endpoint supports <> and <>.\nTo narrow your result set to users that match certain criteria, see the <> endpoint.\n\nThe `business_token` field is conditionally returned in the response (it cannot be set through the API).\nYou can use this field in conjunction with the `parent_token` f" }, { "info": { "name": "Create user", "type": "http" }, "http": { "method": "POST", "url": "/v3/users", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint enables you to create a user.\nA new user's initial status depends on the <> of the program or associated <>.\n\n[cols=\"1,1,1,1\"]\n|===\n| KYC Required | Initial User Status | User Active on Creation | User Limitations\n\n| Always\n| `UNVERIFIED`\n| Optional\n| Cannot load funds; cannot activate cards.\n\n| Conditionally\n| `LIMITED`\n| Optional\n| Restricted by rules in `acco" }, { "info": { "name": "Update user password", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/changepassword", "body": { "type": "json", "data": "{}" } }, "docs": "To change a user password, send a `POST` request to the `/users/auth/changepassword` endpoint and include the `current_password` and `new_password` in link:http://www.json.org/[JSON, window=\"_blank\"] format in the body of the request.\nThis endpoint operates in the context of a currently logged-in user.\n\nA successful password change returns an empty response body with a response code of `204 No Content`." }, { "info": { "name": "Create client access token", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/clientaccesstoken", "body": { "type": "json", "data": "{}" } }, "docs": "Each time you want to display a virtual card's sensitive data (for example, when using `marqeta.js`), you must first request a new, single-use client access token from the Marqeta platform by sending a `POST` request to the `/users/auth/clientaccesstoken` endpoint.\nUnredeemed client access tokens expire after five minutes." }, { "info": { "name": "Retrieve client access token", "type": "http" }, "http": { "method": "GET", "url": "/v3/users/auth/clientaccesstoken/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Client access token." }, { "name": "application_token", "value": "", "type": "query", "description": "Unique identifier of the `application` object." } ] }, "docs": "To retrieve application and card information using a client access token, send a `GET` request to the `/users/auth/clientaccesstoken/{token}` endpoint." }, { "info": { "name": "Log in user", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/login", "body": { "type": "json", "data": "{}" } }, "docs": "To log in a user and return a user access token, send a `POST` request to the `/users/auth/login` endpoint and include the user details in link:http://www.json.org/[JSON, window=\"_blank\"] format in the body of the request.\n\n[TIP]\nTo check a user's credentials without logging out the user, call the `/users/auth/onetime` endpoint." }, { "info": { "name": "Log out user", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/logout" }, "docs": "To log out a user, send a `POST` request to the `/users/auth/logout` endpoint.\n\nA successful logout returns an empty response body with a response code of `204 No Content`." }, { "info": { "name": "Create single-use token", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/onetime", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint returns a single-use access token.\nThis type of token authorizes a single request to access API endpoints and data associated with a particular user.\nA single-use access token differs from a user access token (as returned by `POST` `/users/auth/login`) only in the number of times it can be used.\n\nTo return a single-use access token, send a `POST` request to the `/users/auth/onetime` endpoint.\nProvide one of these sets of input data:\n\n* *Case #1* – Application token and user access " }, { "info": { "name": "Request user password reset token", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/resetpassword", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to generate a password reset token for a user.\nSend a `POST` request to the `/users/auth/resetpassword` endpoint and include the user's email address in link:http://www.json.org/[JSON, window=\"_blank\"] format in the body of the request.\nThis request generates and sends an email message containing the `user_token` and `password_reset_token` to the user's email address.\nYou must customize the email message with a link that passes the `user_token` and `password_reset_token` to a w" }, { "info": { "name": "Reset user password", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/resetpassword/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Password reset token generated using the `POST /users/auth/resetpassword` operation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To reset the user's password, send a `POST` request to the `/users/auth/resetpassword/{token}` endpoint that includes a password reset token generated using the `POST /users/auth/resetpassword` operation.\nInclude the `user_token` and `new_password` in link:http://www.json.org/[JSON, window=\"_blank\"] format in the body of the request.\nInclude the `password_reset_token` as a path parameter.\n\nA successful password reset returns an empty response body with a response code of `204 No Content`." }, { "info": { "name": "Request email verification token", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/verifyemail" }, "docs": "Send a `POST` request to the `/users/auth/verifyemail` endpoint to request an email verification token.\nNo input parameters are required because this operation is performed in the context of an authenticated user.\n\nThis initial request generates and sends an email message containing the email verification token to the cardholder's email address.\nThis email message must include a link that passes the email verification token to a web page where a subsequent request verifies the email address.\n\nA " }, { "info": { "name": "Verify email address", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/auth/verifyemail/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Email verification token generated using the `POST /users/auth/verifyemail` operation." } ] }, "docs": "To verify a user's email address, send a `POST` request to the `/users/auth/verifyemail/{email_verification_token}` endpoint that includes an `email_verification_token` generated using the `POST /users/auth/verifyemail` operation.\nInclude the `email_verification_token` as a path parameter.\n\nA successful email verification returns an empty response body with a response code of `204 No Content`." }, { "info": { "name": "Search users", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/lookup", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of user resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "search_type", "value": "", "type": "query", "description": "Search type." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To search for one or more users, send a `POST` request to the `/users/lookup` endpoint.\nInclude in the message body any parameters by which you want to query.\nThis endpoint supports <> and <>." }, { "info": { "name": "List user child accounts", "type": "http" }, "http": { "method": "GET", "url": "/v3/users/:parent_token/children", "params": [ { "name": "count", "value": "", "type": "query", "description": "Number of user resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "parent_token", "value": "", "type": "path", "description": "Unique identifier of the parent account holder." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "To retrieve users who are children of a parent user or business, send a `GET` request to the `/users/{parent_token}/children` endpoint.\nInclude the parent's user or business token as a URL path parameter.\n\nThe `business_token` field is conditionally returned in the response (it cannot be set through the API).\nYou can use this field in conjunction with the `parent_token` field to determine whether the user has a parent or grandparent that is a business:\n\n[cols=\"1,1,1\"]\n|===\n| parent_token | busin" }, { "info": { "name": "Retrieve user", "type": "http" }, "http": { "method": "GET", "url": "/v3/users/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the user resource." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." } ] }, "docs": "To retrieve a specific user, send a `GET` request to the `/users/{token}` endpoint.\nInclude the user `token` path parameter to specify the user to return.\n\nThe `business_token` field is conditionally returned in the response (it cannot be set through the API).\nYou can use this field in conjunction with the `parent_token` field to determine whether the user has a parent or grandparent that is a business:\n\n[cols=\"1,1,1\"]\n|===\n| parent_token | business_token | Description\n\n| Not populated\n| Not pop" }, { "info": { "name": "Update user", "type": "http" }, "http": { "method": "PUT", "url": "/v3/users/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the user resource you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update a specific user resource, send a `PUT` request to the `/users/{token}` endpoint.\nInclude the user `token` path parameter to specify the user to update.\n\nTo unlink a child user account from a parent account, pass a null value to the `parent_token` field of the child user resource." }, { "info": { "name": "Retrieve user identification number", "type": "http" }, "http": { "method": "GET", "url": "/v3/users/:token/ssn", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the user resource." }, { "name": "full_ssn", "value": "", "type": "query", "description": "To return the full identification number, set to `true`.\nTo return only the last four digits, set to `false`.\n\nIf the identifications array contains only the last four digits of the identification number, the `/users/{token}/ssn` endpoint will return only the last four digits, regardless of the `full_ssn` parameter." } ] }, "docs": "To retrieve the government-issued identification number for a user, send a `GET` request to the `/users/{token}/ssn` endpoint.\nInclude the `token` path parameter to specify the user whose identification number (SSN, ITIN, TIN, NIN, SIN) you wish to return.\nYou can indicate whether to return the full number or the last four digits only." } ] }, { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "Lists all users who match a phone number", "type": "http" }, "http": { "method": "GET", "url": "/v3/users/phonenumber/:phone_number", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number" }, { "name": "count", "value": "", "type": "query", "description": "Number of users to retrieve" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists all users who match a phone number" }, { "info": { "name": "Lists cardholder notes", "type": "http" }, "http": { "method": "GET", "url": "/v3/users/:token/notes", "params": [ { "name": "token", "value": "", "type": "path", "description": "User token" }, { "name": "start_index", "value": "", "type": "query", "description": "Start index" }, { "name": "count", "value": "", "type": "query", "description": "Number of notes to retrieve" }, { "name": "created_by", "value": "", "type": "query", "description": "Created by" }, { "name": "created_by_user_role", "value": "", "type": "query", "description": "Comma-delimited list of created by user roles" }, { "name": "include_private", "value": "", "type": "query", "description": "Include private notes and private fields in note response" }, { "name": "search_type", "value": "", "type": "query", "description": "Search type" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Lists cardholder notes" }, { "info": { "name": "Creates a note for the cardholder", "type": "http" }, "http": { "method": "POST", "url": "/v3/users/:token/notes", "params": [ { "name": "token", "value": "", "type": "path", "description": "User token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a note for the cardholder" }, { "info": { "name": "Updates a specific note for a cardholder", "type": "http" }, "http": { "method": "PUT", "url": "/v3/users/:token/notes/:notes_token", "params": [ { "name": "token", "value": "", "type": "path", "description": "User token" }, { "name": "notes_token", "value": "", "type": "path", "description": "Notes token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific note for a cardholder" } ] }, { "info": { "name": "User Transitions", "type": "folder" }, "items": [ { "info": { "name": "Create user transition", "type": "http" }, "http": { "method": "POST", "url": "/v3/usertransitions", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint enables you to change a user's status, depending on your role and the previous status change.\nBy changing a user's status, you can control the user's capabilities and the setting of the `user.active` field.\nDo not set the value of the `user.active` field directly.\n\n[cols=\"2a,4a,3a\"]\n|===\n| The user.status Field | Description | User Limitations\n\n| `UNVERIFIED`\n| Initial status of a new user belonging to an account holder group where KYC is always required.\n\n*Allowable Transitions:* " }, { "info": { "name": "List transitions for user", "type": "http" }, "http": { "method": "GET", "url": "/v3/usertransitions/user/:user_token", "params": [ { "name": "user_token", "value": "", "type": "path", "description": "Unique identifier of the user resource." }, { "name": "count", "value": "", "type": "query", "description": "Number of user transitions to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "List all transitions for a given user." }, { "info": { "name": "Retrieve user transition", "type": "http" }, "http": { "method": "GET", "url": "/v3/usertransitions/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the user transition you want to retrieve." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." } ] }, "docs": "Retrieve a user transition." } ] }, { "info": { "name": "Velocity Controls", "type": "folder" }, "items": [ { "info": { "name": "List velocity controls", "type": "http" }, "http": { "method": "GET", "url": "/v3/velocitycontrols", "params": [ { "name": "card_product", "value": "", "type": "query", "description": "Unique identifier of the card product.\nEnter the string `null` to retrieve velocity controls that are not associated with any card product." }, { "name": "user", "value": "", "type": "query", "description": "Unique identifier of the user.\nEnter the string `null` to retrieve velocity controls that are not associated with any user." }, { "name": "count", "value": "", "type": "query", "description": "Number of velocity control resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Retrieves a list of all the velocity controls associated with a specific user or card product, or lists all the velocity controls defined for your program.\n\nInclude either a `user` or a `card_product` query parameter to indicate the user or card product whose associated velocity controls you want to retrieve (do not include both).\n\nTo list all velocity controls for your program, omit the `user` and `card_product` query parameters from your request.\n\nThis endpoint supports <> a" }, { "info": { "name": "Returns a specific velocity control", "type": "http" }, "http": { "method": "GET", "url": "/v3/velocitycontrols/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the velocity control resource." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." } ] }, "docs": "Retrieves a specific velocity control." }, { "info": { "name": "Update velocity control", "type": "http" }, "http": { "method": "PUT", "url": "/v3/velocitycontrols/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the velocity control resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific velocity control." } ] }, { "info": { "name": "velocity controls", "type": "folder" }, "items": [ { "info": { "name": "Retrieve velocity control available balances for an account token", "type": "http" }, "http": { "method": "GET", "url": "/v3/velocitycontrols/account/:account_token/available", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Account token" } ] }, "docs": "Retrieve velocity control available balances for an account token" }, { "info": { "name": "Sets a specific velocity control to inactive to soft delete it", "type": "http" }, "http": { "method": "DELETE", "url": "/v3/velocitycontrols/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Velocity control token" } ] }, "docs": "Sets a specific velocity control to inactive to soft delete it" } ] }, { "info": { "name": "Velocity Controls Card Group Balance", "type": "folder" }, "items": [ { "info": { "name": "List Velocity Controls Card Group Balances", "type": "http" }, "http": { "method": "GET", "url": "/v3/velocitycontrols/cardgroup/:card_group_token/available", "params": [ { "name": "card_group_token", "value": "", "type": "path", "description": "Unique identifier of the card group for which to retrieve balances." } ] }, "docs": "Get a list of all Velocity Controls Card Group Balances in the program" } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "List webhooks", "type": "http" }, "http": { "method": "GET", "url": "/v3/webhooks", "params": [ { "name": "active", "value": "", "type": "query", "description": "Set to `true` to return only active webhook configurations, otherwise all webhook configurations will be returned." }, { "name": "count", "value": "", "type": "query", "description": "Number of resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Returns an array of all webhooks.\n\nThis endpoint supports <>, <>, and <>.\n\n[NOTE]\nAs shown in the example, `config.secret`, `config.basic_auth_username`, and `config.basic_auth_password` are masked in responses to this and all other requests.\nTo ensure you can access these values as needed, update them on your endpoint, store them securely, and then <>." }, { "info": { "name": "Update webhook", "type": "http" }, "http": { "method": "PUT", "url": "/v3/webhooks/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the webhook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a webhook.\n\nYou can also use this endpoint to disable webhooks you no longer want to receive—there is no `DELETE` method available to remove unneeded webhooks.\nTo disable a webhook, use this endpoint to set its `active` field to `false`.\n\n[NOTE]\nAs shown in the example, `config.secret`, `config.basic_auth_username`, and `config.basic_auth_password` are masked in responses to this and all other requests.\nTo access these values later, store them securely before making the request.\nWhen mod" }, { "info": { "name": "Ping webhook", "type": "http" }, "http": { "method": "POST", "url": "/v3/webhooks/:token/ping", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the webhook." } ] }, "docs": "Pings your webhook endpoint.\n\nSend a ping request to your webhook endpoint to validate credentials and connectivity.\nYour webhook endpoint must be configured to respond.\n\n=== Configuring your webhook endpoint\n\nWhen the Marqeta platform receives the ping request, it sends a `POST` request containing the following body to the URL of your webhook endpoint:\n\n[#ping-webhook-sample]\n[source,json]\n----\n{\n \"pings\": [\n {\n \"token\": \"marqeta\",\n \"payload\": \"healthcheck\"\n }\n ]\n}\n----\n\nTo in" }, { "info": { "name": "Resend event notification", "type": "http" }, "http": { "method": "POST", "url": "/v3/webhooks/:token/:event_type/:event_token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the webhook." }, { "name": "event_type", "value": "", "type": "path", "description": "Specifies the type of event you want to resend." }, { "name": "event_token", "value": "", "type": "path", "description": "Unique identifier of the event for which you want to resend a notification." } ] }, "docs": "Resends an event notification to your webhook endpoint.\n\nAlthough you send this request as a `POST`, all parameters are passed in the URL and the body is empty.\nThe event notification is resent to your webhook endpoint and is also returned in the response to this request." } ] } ], "bundled": true }