{ "info": { "name": "Bezel API (proposal) 0.1", "description": "Generated from the OpenAPI specification. Set the `baseUrl` and `bearerToken` collection variables before sending requests. Bruno and Insomnia can import this file too (or the OpenAPI spec directly).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.tst.au.apgpay.dev", "type": "string" }, { "key": "bearerToken", "value": "", "type": "string" } ], "item": [ { "name": "Card issuer", "item": [ { "name": "Get card", "request": { "method": "GET", "description": "Return one digital card.\n\nOperation ID: getCard", "url": { "raw": "{{baseUrl}}/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "cards", ":cardId" ], "variable": [ { "key": "cardId", "value": "", "description": "(string)" } ] } } }, { "name": "List cards", "request": { "method": "GET", "description": "Return a page of digital cards. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/cards` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryCards", "url": { "raw": "{{baseUrl}}/cards", "host": [ "{{baseUrl}}" ], "path": [ "cards" ] } } }, { "name": "Create cards", "request": { "method": "POST", "description": "Issue a digital card against a loan. The network is selected by the body's `type`.\n\nOperation ID: createCards", "url": { "raw": "{{baseUrl}}/cards", "host": [ "{{baseUrl}}" ], "path": [ "cards" ] } } }, { "name": "Update card", "request": { "method": "PATCH", "description": "Update a digital card's mutable attributes.\n\nOperation ID: updateCard", "url": { "raw": "{{baseUrl}}/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "cards", ":cardId" ], "variable": [ { "key": "cardId", "value": "", "description": "(string)" } ] } } }, { "name": "Get issuer transaction", "request": { "method": "GET", "description": "Return one issuer transaction.\n\nOperation ID: getIssuerTransaction", "url": { "raw": "{{baseUrl}}/issuer-transactions/:issuerTransactionId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transactions", ":issuerTransactionId" ], "variable": [ { "key": "issuerTransactionId", "value": "", "description": "(string)" } ] } } }, { "name": "List issuer transactions", "request": { "method": "GET", "description": "Return a page of issuer transactions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/issuer-transactions` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryIssuerTransactions", "url": { "raw": "{{baseUrl}}/issuer-transactions", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transactions" ] } } }, { "name": "Update issuer transaction", "request": { "method": "PATCH", "description": "Capture, void, dispute, refund or adjust an issuer transaction, or append metadata to it.\n\nOperation ID: updateIssuerTransaction", "url": { "raw": "{{baseUrl}}/issuer-transactions/:issuerTransactionId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transactions", ":issuerTransactionId" ], "variable": [ { "key": "issuerTransactionId", "value": "", "description": "(string)" } ] } } }, { "name": "Update issuer transactions", "request": { "method": "PATCH", "description": "Change one issuer transaction, named by a selector rather than by its identifier. The selector must match exactly one.\n\nOperation ID: updateIssuerTransactions", "url": { "raw": "{{baseUrl}}/issuer-transactions", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transactions" ] } } }, { "name": "Get issuer transaction dispute", "request": { "method": "GET", "description": "Return one dispute of this transaction. A dispute that does not belong to this issuerTransaction is a 404, not a redirect.\n\nOperation ID: getIssuerTransactionDispute", "url": { "raw": "{{baseUrl}}/issuer-transactions/:issuerTransactionId/disputes/:disputeId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transactions", ":issuerTransactionId", "disputes", ":disputeId" ], "variable": [ { "key": "issuerTransactionId", "value": "", "description": "(string)" }, { "key": "disputeId", "value": "", "description": "(string)" } ] } } }, { "name": "Get issuer transaction refund", "request": { "method": "GET", "description": "Return one refund of this transaction. A refund that does not belong to this issuerTransaction is a 404, not a redirect.\n\nOperation ID: getIssuerTransactionRefund", "url": { "raw": "{{baseUrl}}/issuer-transactions/:issuerTransactionId/refunds/:refundId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transactions", ":issuerTransactionId", "refunds", ":refundId" ], "variable": [ { "key": "issuerTransactionId", "value": "", "description": "(string)" }, { "key": "refundId", "value": "", "description": "(string)" } ] } } }, { "name": "List issuer transaction disputes", "request": { "method": "GET", "description": "Return a page of the disputes raised against this transaction.\n\nOperation ID: queryIssuerTransactionDisputes", "url": { "raw": "{{baseUrl}}/issuer-transactions/:issuerTransactionId/disputes", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transactions", ":issuerTransactionId", "disputes" ], "variable": [ { "key": "issuerTransactionId", "value": "", "description": "(string)" } ] } } }, { "name": "List issuer transaction refunds", "request": { "method": "GET", "description": "Return a page of the refunds issued against this transaction. This is the only address an issuing refund has.\n\nOperation ID: queryIssuerTransactionRefunds", "url": { "raw": "{{baseUrl}}/issuer-transactions/:issuerTransactionId/refunds", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transactions", ":issuerTransactionId", "refunds" ], "variable": [ { "key": "issuerTransactionId", "value": "", "description": "(string)" } ] } } }, { "name": "Get issuer refund", "request": { "method": "GET", "description": "Return one refund of an issued-card transaction.\n\nOperation ID: getIssuerRefund", "url": { "raw": "{{baseUrl}}/issuer-refunds/:issuerRefundId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-refunds", ":issuerRefundId" ], "variable": [ { "key": "issuerRefundId", "value": "", "description": "(string)" } ] } } }, { "name": "Create issuer refunds", "request": { "method": "POST", "description": "Refund a captured issuer transaction, naming it by selector rather than by identifier.\n\nOperation ID: createIssuerRefunds", "url": { "raw": "{{baseUrl}}/issuer-refunds", "host": [ "{{baseUrl}}" ], "path": [ "issuer-refunds" ] } } }, { "name": "Update issuer refund", "request": { "method": "PATCH", "description": "Append free-form data to a refund. Merged with what is there, the refund's own record is the platform's, not yours.\n\nOperation ID: updateIssuerRefund", "url": { "raw": "{{baseUrl}}/issuer-refunds/:issuerRefundId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-refunds", ":issuerRefundId" ], "variable": [ { "key": "issuerRefundId", "value": "", "description": "(string)" } ] } } }, { "name": "Get issuer dispute", "request": { "method": "GET", "description": "Return one dispute against an issued-card transaction.\n\nOperation ID: getIssuerDispute", "url": { "raw": "{{baseUrl}}/issuer-disputes/:issuerDisputeId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-disputes", ":issuerDisputeId" ], "variable": [ { "key": "issuerDisputeId", "value": "", "description": "(string)" } ] } } }, { "name": "Create issuer disputes", "request": { "method": "POST", "description": "Raise a dispute against an issuer transaction, naming it by selector rather than by identifier.\n\nOperation ID: createIssuerDisputes", "url": { "raw": "{{baseUrl}}/issuer-disputes", "host": [ "{{baseUrl}}" ], "path": [ "issuer-disputes" ] } } }, { "name": "Get issuer transaction exception", "request": { "method": "GET", "description": "Return one exception, including any suggested resolution.\n\nOperation ID: getIssuerTransactionException", "url": { "raw": "{{baseUrl}}/issuer-transaction-exceptions/:issuerTransactionExceptionId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transaction-exceptions", ":issuerTransactionExceptionId" ], "variable": [ { "key": "issuerTransactionExceptionId", "value": "", "description": "(string)" } ] } } }, { "name": "List issuer transaction exceptions", "request": { "method": "GET", "description": "Return a page of exceptions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/issuer-transaction-exceptions` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryIssuerTransactionExceptions", "url": { "raw": "{{baseUrl}}/issuer-transaction-exceptions", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transaction-exceptions" ] } } }, { "name": "Update issuer transaction exception", "request": { "method": "PATCH", "description": "Resolve an exception or add a note to it. Which resolutions are accepted depends on the kind, see `ExceptResolution`.\n\nOperation ID: updateIssuerTransactionException", "url": { "raw": "{{baseUrl}}/issuer-transaction-exceptions/:issuerTransactionExceptionId", "host": [ "{{baseUrl}}" ], "path": [ "issuer-transaction-exceptions", ":issuerTransactionExceptionId" ], "variable": [ { "key": "issuerTransactionExceptionId", "value": "", "description": "(string)" } ] } } } ] }, { "name": "Identity", "item": [ { "name": "List contact verifications", "request": { "method": "GET", "description": "Read the verification state of a phone number, an email address, or both. At least one is required: the platform looks a record up by its key and cannot page them all.\n\nOperation ID: queryContactVerifications", "url": { "raw": "{{baseUrl}}/contact-verifications", "host": [ "{{baseUrl}}" ], "path": [ "contact-verifications" ] } } }, { "name": "Update contact verifications", "request": { "method": "PATCH", "description": "Reset the verification held against one contact detail: clears the failed attempts and issues a new code.\n\nOperation ID: updateContactVerifications", "url": { "raw": "{{baseUrl}}/contact-verifications", "host": [ "{{baseUrl}}" ], "path": [ "contact-verifications" ] } } }, { "name": "Create customer API keys", "request": { "method": "POST", "description": "Issue an API key to a customer. The key is on the response and nowhere else, ever.\n\nOperation ID: createCustomerApiKeys", "url": { "raw": "{{baseUrl}}/customer-api-keys", "host": [ "{{baseUrl}}" ], "path": [ "customer-api-keys" ] } } }, { "name": "Create KYC identifications", "request": { "method": "POST", "description": "Put a person through an identity check. Which person is decided by the credential you present.\n\nOperation ID: createKycIdentifications", "url": { "raw": "{{baseUrl}}/kyc-identifications", "host": [ "{{baseUrl}}" ], "path": [ "kyc-identifications" ] } } }, { "name": "Get user", "request": { "method": "GET", "description": "Return one user.\n\nOperation ID: getUser", "url": { "raw": "{{baseUrl}}/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(string)" } ] } } }, { "name": "List users", "request": { "method": "GET", "description": "Return a page of users. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/users` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryUsers", "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] } } }, { "name": "Create users", "request": { "method": "POST", "description": "Create a user.\n\nOperation ID: createUsers", "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] } } }, { "name": "Update user", "request": { "method": "PATCH", "description": "Change a user's name, identifiers, permissions or status.\n\nOperation ID: updateUser", "url": { "raw": "{{baseUrl}}/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(string)" } ] } } }, { "name": "Get role", "request": { "method": "GET", "description": "Return one role, with its grants resolved.\n\nOperation ID: getRole", "url": { "raw": "{{baseUrl}}/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "(string)" } ] } } }, { "name": "List roles", "request": { "method": "GET", "description": "Return a page of roles. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/roles` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryRoles", "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ] } } }, { "name": "Create roles", "request": { "method": "POST", "description": "Define a role, carrying its own grants or grouping other roles. Selected by the body's `type`.\n\nOperation ID: createRoles", "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ] } } }, { "name": "Update role", "request": { "method": "PATCH", "description": "Change a role's name, or replace what it grants.\n\nOperation ID: updateRole", "url": { "raw": "{{baseUrl}}/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "(string)" } ] } } }, { "name": "Get OIDC provider", "request": { "method": "GET", "description": "Return one OIDC provider. The client secret is never included.\n\nOperation ID: getOidcProvider", "url": { "raw": "{{baseUrl}}/oidc-providers/:oidcProviderId", "host": [ "{{baseUrl}}" ], "path": [ "oidc-providers", ":oidcProviderId" ], "variable": [ { "key": "oidcProviderId", "value": "", "description": "(string)" } ] } } }, { "name": "List OIDC providers", "request": { "method": "GET", "description": "Return a page of OIDC providers. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search.\n\nOperation ID: queryOidcProviders", "url": { "raw": "{{baseUrl}}/oidc-providers", "host": [ "{{baseUrl}}" ], "path": [ "oidc-providers" ] } } }, { "name": "Create OIDC providers", "request": { "method": "POST", "description": "Register a provider.\n\nOperation ID: createOidcProviders", "url": { "raw": "{{baseUrl}}/oidc-providers", "host": [ "{{baseUrl}}" ], "path": [ "oidc-providers" ] } } }, { "name": "Update OIDC provider", "request": { "method": "PATCH", "description": "Update a provider's mutable attributes.\n\nOperation ID: updateOidcProvider", "url": { "raw": "{{baseUrl}}/oidc-providers/:oidcProviderId", "host": [ "{{baseUrl}}" ], "path": [ "oidc-providers", ":oidcProviderId" ], "variable": [ { "key": "oidcProviderId", "value": "", "description": "(string)" } ] } } }, { "name": "List sessions", "request": { "method": "GET", "description": "Return the session you are holding, and what it can do. A page of one, the platform stores no sessions, so there are no others to list.\n\nOperation ID: querySessions", "url": { "raw": "{{baseUrl}}/sessions", "host": [ "{{baseUrl}}" ], "path": [ "sessions" ] } } }, { "name": "Create sessions", "request": { "method": "POST", "description": "Start or complete a sign-in. The response says which step you are on. The credential is optional, see below.\n\nOperation ID: createSessions", "url": { "raw": "{{baseUrl}}/sessions", "host": [ "{{baseUrl}}" ], "path": [ "sessions" ] } } }, { "name": "Update sessions", "request": { "method": "PATCH", "description": "Act in a different domain, which needs your session's bearer, or trade a refresh token for a new bearer, which needs no credential. See below.\n\nOperation ID: updateSessions", "url": { "raw": "{{baseUrl}}/sessions", "host": [ "{{baseUrl}}" ], "path": [ "sessions" ] } } }, { "name": "Create auth tokens", "request": { "method": "POST", "description": "Mint an auth token, ask what one says about itself, or exchange a customer's for a bearer. The credential is optional, see below.\n\nOperation ID: createAuthTokens", "url": { "raw": "{{baseUrl}}/auth-tokens", "host": [ "{{baseUrl}}" ], "path": [ "auth-tokens" ] } } }, { "name": "Get API key", "request": { "method": "GET", "description": "Return one service token. The secret is never included.\n\nOperation ID: getApiKey", "url": { "raw": "{{baseUrl}}/api-keys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "api-keys", ":apiKeyId" ], "variable": [ { "key": "apiKeyId", "value": "", "description": "(string)" } ] } } }, { "name": "List API keys", "request": { "method": "GET", "description": "Return a page of service tokens. `tokenType` is required, and so is the party it belongs to, there is no cross-party token read: `merchantId` for the two merchant types, `marketplaceId` for a marketplace key, `enterpriseId` for an enterprise key.\n\nOperation ID: queryApiKeys", "url": { "raw": "{{baseUrl}}/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "api-keys" ] } } }, { "name": "Create API keys", "request": { "method": "POST", "description": "Issue a token. The secret is on the response and nowhere else, ever.\n\nOperation ID: createApiKeys", "url": { "raw": "{{baseUrl}}/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "api-keys" ] } } }, { "name": "Update API key", "request": { "method": "PATCH", "description": "Change a token's description, expiry, status or permissions. One change per call, the arm says which.\n\nOperation ID: updateApiKey", "url": { "raw": "{{baseUrl}}/api-keys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "api-keys", ":apiKeyId" ], "variable": [ { "key": "apiKeyId", "value": "", "description": "(string)" } ] } } }, { "name": "Get auth type", "request": { "method": "GET", "description": "Return one authentication-type mapping.\n\nOperation ID: getAuthType", "url": { "raw": "{{baseUrl}}/auth-types/:authTypeId", "host": [ "{{baseUrl}}" ], "path": [ "auth-types", ":authTypeId" ], "variable": [ { "key": "authTypeId", "value": "", "description": "(string)" } ] } } }, { "name": "List auth types", "request": { "method": "GET", "description": "Return a page of authentication-type mappings. Supply `domainKey` to read exactly one, `page` or `cursor` to paginate, and `q` to search.\n\nOperation ID: queryAuthTypes", "url": { "raw": "{{baseUrl}}/auth-types", "host": [ "{{baseUrl}}" ], "path": [ "auth-types" ] } } }, { "name": "Create auth types", "request": { "method": "POST", "description": "Map a login-capable permission domain to the authentication type its users use.\n\nOperation ID: createAuthTypes", "url": { "raw": "{{baseUrl}}/auth-types", "host": [ "{{baseUrl}}" ], "path": [ "auth-types" ] } } }, { "name": "Update auth type", "request": { "method": "PATCH", "description": "Change how a permission domain's users sign in.\n\nOperation ID: updateAuthType", "url": { "raw": "{{baseUrl}}/auth-types/:authTypeId", "host": [ "{{baseUrl}}" ], "path": [ "auth-types", ":authTypeId" ], "variable": [ { "key": "authTypeId", "value": "", "description": "(string)" } ] } } }, { "name": "OIDC sso launch", "request": { "method": "POST", "description": "Just-in-time SSO launch. Submit as a top-level form POST; the answer sets a first-party session cookie and redirects the browser to `target`. Form-encoded and cookie-setting because it is a browser navigation, not a fetch.\n\nOperation ID: oidcSsoLaunch", "url": { "raw": "{{baseUrl}}/oidc/.extension/sso/launch", "host": [ "{{baseUrl}}" ], "path": [ "oidc", ".extension", "sso", "launch" ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded", "description": "", "disabled": false } ], "body": { "mode": "raw", "raw": "{\n \"bearerToken\": \"string\",\n \"target\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "OIDC discovery", "request": { "method": "GET", "description": "OpenID Connect discovery document advertising this provider's endpoints and capabilities.\n\nOperation ID: oidcDiscovery", "url": { "raw": "{{baseUrl}}/oidc/.well-known/openid-configuration", "host": [ "{{baseUrl}}" ], "path": [ "oidc", ".well-known", "openid-configuration" ] } } }, { "name": "OIDC authorise", "request": { "method": "GET", "description": "Begin an authorisation-code flow with PKCE. Answers with a redirect carrying the code.\n\nOperation ID: oidcAuthorise", "url": { "raw": "{{baseUrl}}/oidc/oauth2/authorise", "host": [ "{{baseUrl}}" ], "path": [ "oidc", "oauth2", "authorise" ] } } }, { "name": "OIDC jwks", "request": { "method": "GET", "description": "Public keys relying parties use to verify id_token signatures. Published with an overlap during rotation.\n\nOperation ID: oidcJwks", "url": { "raw": "{{baseUrl}}/oidc/oauth2/jwks", "host": [ "{{baseUrl}}" ], "path": [ "oidc", "oauth2", "jwks" ] } } }, { "name": "OIDC token", "request": { "method": "POST", "description": "Exchange an authorisation code for tokens. Form-encoded per OpenID Connect Core 1.0.\n\nOperation ID: oidcToken", "url": { "raw": "{{baseUrl}}/oidc/oauth2/token", "host": [ "{{baseUrl}}" ], "path": [ "oidc", "oauth2", "token" ] } } }, { "name": "OIDC user info", "request": { "method": "GET", "description": "The claims a relying party reads with an access token. Claim names are the standard's.\n\nOperation ID: oidcUserInfo", "url": { "raw": "{{baseUrl}}/oidc/oauth2/userinfo", "host": [ "{{baseUrl}}" ], "path": [ "oidc", "oauth2", "userinfo" ] } } } ] }, { "name": "Customers", "item": [ { "name": "Get customer", "request": { "method": "GET", "description": "Return one customer.\n\nOperation ID: getCustomer", "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "", "description": "(string)" } ] } } }, { "name": "List customers", "request": { "method": "GET", "description": "Return a page of customers. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/customers` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryCustomers", "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "key": "limit", "value": "", "description": "integer (int32). Maximum results per page. Default to 20, must be between 1 and 2000.", "disabled": true }, { "key": "page", "value": "", "description": "integer (int32). Page number of results to show (starting at page 1).", "disabled": true }, { "key": "sort", "value": "", "description": "string. Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.", "disabled": true }, { "key": "createdAfter", "value": "", "description": "string (date-time). Return customers that were created at or after this timestamp", "disabled": true }, { "key": "createdBefore", "value": "", "description": "string (date-time). Return customers that were created at or before this timestamp", "disabled": true }, { "key": "emailAddress", "value": "", "description": "array of string. Filter by email address", "disabled": true }, { "key": "customerId", "value": "", "description": "array of string. Filter by customer system identifier", "disabled": true }, { "key": "merchantId", "value": "", "description": "array of string. Filter by merchant system identifier", "disabled": true }, { "key": "name", "value": "", "description": "string. Filter by first name, last name or organisation name", "disabled": true } ] } } }, { "name": "Create customers", "request": { "method": "POST", "description": "Create a customer, a consumer or an organisation, or refresh one already held under the same details. Selected by the body's `type`. A customer signing itself up before it is verified is held to `MerchantCustomers_UpsertMinimal` instead.\n\nOperation ID: createCustomers", "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false }, { "key": "Merchant-Id", "value": "", "description": "Perform operation in the context of the given merchant. Usually not required, specify only if acting on behalf of a merchant not implied by the credentials specified in the `Authorization` header.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"UpsertConsumerCustomer\": {\n \"emailAddress\": \"lucy.diamond@star.com\",\n \"phoneNumber\": \"+61401234567\",\n \"referenceCustomerId\": \"CUST-48822821\",\n \"givenName\": \"string\",\n \"middleName\": \"string\",\n \"familyName\": \"string\",\n \"isVerified\": true,\n \"metadata\": {}\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update customer", "request": { "method": "PATCH", "description": "Update a customer's mutable attributes.\n\nOperation ID: updateCustomer", "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "", "description": "(string)" } ] } } }, { "name": "Create organisation prospects", "request": { "method": "POST", "description": "Check a business, or accept one of its owners and create the customer. The token decides which step you are on, and it is the credential for both: neither asks for a permission.\n\nOperation ID: createOrganisationProspects", "url": { "raw": "{{baseUrl}}/organisation-prospects", "host": [ "{{baseUrl}}" ], "path": [ "organisation-prospects" ] } } }, { "name": "Get delegate", "request": { "method": "GET", "description": "Return one delegate.\n\nOperation ID: getDelegate", "url": { "raw": "{{baseUrl}}/delegates/:delegateId", "host": [ "{{baseUrl}}" ], "path": [ "delegates", ":delegateId" ], "variable": [ { "key": "delegateId", "value": "", "description": "(string)" } ] } } }, { "name": "List delegates", "request": { "method": "GET", "description": "Return a page of the delegates the credentials reach, narrowed by `customerId`, `merchantId` or `delegateId`. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search.\n\nOperation ID: queryDelegates", "url": { "raw": "{{baseUrl}}/delegates", "host": [ "{{baseUrl}}" ], "path": [ "delegates" ] } } }, { "name": "Create delegates", "request": { "method": "POST", "description": "Add a delegate, ask a customer's delegates to approve a new one, or approve one by its emailed link. Selected by the body's `type`.\n\nOperation ID: createDelegates", "url": { "raw": "{{baseUrl}}/delegates", "host": [ "{{baseUrl}}" ], "path": [ "delegates" ] } } }, { "name": "Update delegate", "request": { "method": "PATCH", "description": "Change a delegate's contact details, link it to or unlink it from a customer, or change what it is to one. Selected by the body's `type`.\n\nOperation ID: updateDelegate", "url": { "raw": "{{baseUrl}}/delegates/:delegateId", "host": [ "{{baseUrl}}" ], "path": [ "delegates", ":delegateId" ], "variable": [ { "key": "delegateId", "value": "", "description": "(string)" } ] } } } ] }, { "name": "Marketplaces", "item": [ { "name": "Get marketplace", "request": { "method": "GET", "description": "Return one marketplace, with its bank-transfer details and source rules.\n\nOperation ID: getMarketplace", "url": { "raw": "{{baseUrl}}/marketplaces/:marketplaceId", "host": [ "{{baseUrl}}" ], "path": [ "marketplaces", ":marketplaceId" ], "variable": [ { "key": "marketplaceId", "value": "", "description": "(string)" } ] } } }, { "name": "List marketplaces", "request": { "method": "GET", "description": "Return a page of marketplaces, the platform's read. Narrow it by `enterpriseId` and `status`, any of those given, or leave some out with `enterpriseIdNot` and `statusNot`. `GET /filter-catalogues/marketplaces` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryMarketplaces", "url": { "raw": "{{baseUrl}}/marketplaces", "host": [ "{{baseUrl}}" ], "path": [ "marketplaces" ] } } }, { "name": "Create marketplaces", "request": { "method": "POST", "description": "Create a marketplace. The response carries its first API key, once, and nowhere else.\n\nOperation ID: createMarketplaces", "url": { "raw": "{{baseUrl}}/marketplaces", "host": [ "{{baseUrl}}" ], "path": [ "marketplaces" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false } ], "body": { "mode": "raw", "raw": "{\n \"enterpriseId\": \"ent_rcWHf7HafVDuwcez\",\n \"slug\": \"mybusiness\",\n \"businessName\": \"string\",\n \"website\": \"string\",\n \"companyEmail\": \"lucy.diamond@star.com\",\n \"companyPhone\": \"+61401234567\",\n \"zendeskUserGroupId\": 100,\n \"enableMerchantDashboardAccess\": true,\n \"shortenerBaseUri\": \"string\",\n \"enableMarketplaceCustomerUsers\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update marketplace", "request": { "method": "PATCH", "description": "Set up bank transfers, replace the source rules, or set who collects sub-merchant invoice fees. One change per call.\n\nOperation ID: updateMarketplace", "url": { "raw": "{{baseUrl}}/marketplaces/:marketplaceId", "host": [ "{{baseUrl}}" ], "path": [ "marketplaces", ":marketplaceId" ], "variable": [ { "key": "marketplaceId", "value": "", "description": "(string)" } ] } } }, { "name": "Get marketplace country setting", "request": { "method": "GET", "description": "Return the marketplace's profile and sub-merchant template for one tax country. Sections you may not read are absent.\n\nOperation ID: getMarketplaceCountrySetting", "url": { "raw": "{{baseUrl}}/marketplaces/:marketplaceId/country-settings", "host": [ "{{baseUrl}}" ], "path": [ "marketplaces", ":marketplaceId", "country-settings" ], "variable": [ { "key": "marketplaceId", "value": "", "description": "(string)" } ] } } }, { "name": "Get marketplace setting", "request": { "method": "GET", "description": "Return the defaults sub-merchants inherit, and the tax countries this marketplace can create them in. The defaults are absent where you may not read them, which is the same answer as having none.\n\nOperation ID: getMarketplaceSetting", "url": { "raw": "{{baseUrl}}/marketplaces/:marketplaceId/settings", "host": [ "{{baseUrl}}" ], "path": [ "marketplaces", ":marketplaceId", "settings" ], "variable": [ { "key": "marketplaceId", "value": "", "description": "(string)" } ] } } }, { "name": "Get marketplace fee structure", "request": { "method": "GET", "description": "Return one fee structure, with the rates on it and whether it is earning.\n\nOperation ID: getMarketplaceFeeStructure", "url": { "raw": "{{baseUrl}}/marketplace-fee-structures/:marketplaceFeeStructureId", "host": [ "{{baseUrl}}" ], "path": [ "marketplace-fee-structures", ":marketplaceFeeStructureId" ], "variable": [ { "key": "marketplaceFeeStructureId", "value": "", "description": "(string)" } ] } } }, { "name": "Create marketplace fee structures", "request": { "method": "POST", "description": "Add a fee structure to a marketplace, for one sub-merchant or for all of them.\n\nOperation ID: createMarketplaceFeeStructures", "url": { "raw": "{{baseUrl}}/marketplace-fee-structures", "host": [ "{{baseUrl}}" ], "path": [ "marketplace-fee-structures" ] } } }, { "name": "Update marketplace fee structure", "request": { "method": "PATCH", "description": "Replace the rates, change who it covers, or stop earning on it. One change per call.\n\nOperation ID: updateMarketplaceFeeStructure", "url": { "raw": "{{baseUrl}}/marketplace-fee-structures/:marketplaceFeeStructureId", "host": [ "{{baseUrl}}" ], "path": [ "marketplace-fee-structures", ":marketplaceFeeStructureId" ], "variable": [ { "key": "marketplaceFeeStructureId", "value": "", "description": "(string)" } ] } } } ] }, { "name": "Merchants", "item": [ { "name": "Get merchant", "request": { "method": "GET", "description": "Return one merchant.\n\nOperation ID: getMerchant", "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "key": "merchantId", "value": "", "description": "(string)" } ] } } }, { "name": "List merchants", "request": { "method": "GET", "description": "Return a page of merchants. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. With `q` the merchants page by `page` only: `startingAfter` and `endingBefore` are refused with 400, and so are several `marketplaceId` or `enterpriseId` values or either left out. `GET /filter-catalogues/merchants` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryMerchants", "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ], "query": [ { "key": "limit", "value": "", "description": "integer (int32). Maximum results per page. Default to 20, must be between 1 and 2000.", "disabled": true }, { "key": "page", "value": "", "description": "integer (int32). Page number of results to show (starting at page 1).", "disabled": true }, { "key": "sort", "value": "", "description": "string. Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.", "disabled": true }, { "key": "businessName", "value": "", "description": "string. Filter by business name", "disabled": true }, { "key": "isActivated", "value": "", "description": "boolean. Filter by whether the business is activated", "disabled": true }, { "key": "payoutStatus", "value": "", "description": "MerchantPayoutStatus. Filter by whether payouts are enabled for this merchant", "disabled": true }, { "key": "marketplaceId", "value": "", "description": "string. Filter by marketplace", "disabled": true }, { "key": "referenceMerchantId", "value": "", "description": "array of string. Filter by reference merchant id", "disabled": true } ] } } }, { "name": "Create merchants", "request": { "method": "POST", "description": "Onboard a merchant into a marketplace, as a seller or as a supplier. Selected by the body's `type`.\n\nOperation ID: createMerchants", "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false }, { "key": "Marketplace-Id", "value": "", "description": "Perform operation in the context of the given marketplace. Usually not required, specify only if acting on behalf of a marketplace not implied by the credentials specified in the `Authorization` header.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"CreateServiceProviderSubmerchant\": {\n \"referenceMerchantId\": \"string\",\n \"contactEmailAddress\": \"lucy.diamond@star.com\",\n \"businessName\": \"string\",\n \"taxCountry\": \"AU\",\n \"businessType\": \"company\",\n \"companyType\": \"Private\",\n \"industry\": \"AcRefrigerationRepair\",\n \"taxId\": \"string\",\n \"contactPerson\": {},\n \"phoneNumber\": \"+61401234567\",\n \"address\": {},\n \"bankName\": \"string\",\n \"bankAccountName\": \"string\",\n \"bankAccountNumber\": \"string\",\n \"bankCountry\": \"string\",\n \"bankCurrency\": \"AUD\",\n \"bankRoutingNumber\": \"string\",\n \"bankReferenceAccountId\": \"string\",\n \"metadata\": {},\n \"requesterId\": \"string\",\n \"payoutDefaultStatementDescriptor\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update merchant", "request": { "method": "PATCH", "description": "Update a merchant's attributes, one group at a time. Selected by the body's `type`. A field left out keeps its value, and `null` removes one the merchant can be without (D36). Every update reads the merchant first, under `Merchants_Query`.\n\nOperation ID: updateMerchant", "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "key": "merchantId", "value": "", "description": "(string)" } ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false } ], "body": { "mode": "raw", "raw": "{\n \"AddMerchantBankAccount\": {\n \"accountName\": \"string\",\n \"bankName\": \"string\",\n \"currency\": \"AUD\",\n \"setAsPrimary\": true,\n \"referenceAccountId\": \"string\",\n \"requesterId\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update merchants", "request": { "method": "PATCH", "description": "Advance every merchant with outstanding gateway onboarding. Test environments only, a 400 in production.\n\nOperation ID: updateMerchants", "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] } } }, { "name": "Act on merchant", "request": { "method": "POST", "description": "Do something to a merchant whose effect goes beyond its fields: check and activate it, submit it for review, onboard it at the gateway, suspend it or turn its checkout off or on, or change its Apple Pay domains. Selected by the body's `type`. Every action reads the merchant first, under `Merchants_Query`, and answers with the merchant as it now stands.\n\nOperation ID: actOnMerchant", "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "key": "merchantId", "value": "", "description": "(string)" } ] } } }, { "name": "Get merchant apple pay registration", "request": { "method": "GET", "description": "Return the merchant's Apple Pay web registration, or say that there is none.\n\nOperation ID: getMerchantApplePayRegistration", "url": { "raw": "{{baseUrl}}/merchants/:merchantId/apple-pay-registrations", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "apple-pay-registrations" ], "variable": [ { "key": "merchantId", "value": "", "description": "(string)" } ] } } }, { "name": "Get beneficial owner", "request": { "method": "GET", "description": "Read one owner, in full. The merchant is named by `merchantId` or the `Merchant-Id` header, the platform resolves an owner within its merchant.\n\nOperation ID: getBeneficialOwner", "url": { "raw": "{{baseUrl}}/beneficial-owners/:beneficialOwnerId", "host": [ "{{baseUrl}}" ], "path": [ "beneficial-owners", ":beneficialOwnerId" ], "variable": [ { "key": "beneficialOwnerId", "value": "", "description": "(string)" } ] } } }, { "name": "List beneficial owners", "request": { "method": "GET", "description": "Return a merchant's beneficial owners. The merchant is named by `merchantId` or the `Merchant-Id` header, and the whole set comes back in one page.\n\nOperation ID: queryBeneficialOwners", "url": { "raw": "{{baseUrl}}/beneficial-owners", "host": [ "{{baseUrl}}" ], "path": [ "beneficial-owners" ] } } }, { "name": "Create beneficial owners", "request": { "method": "POST", "description": "Add a beneficial owner to a merchant. The platform verifies them; the response says how far it got.\n\nOperation ID: createBeneficialOwners", "url": { "raw": "{{baseUrl}}/beneficial-owners", "host": [ "{{baseUrl}}" ], "path": [ "beneficial-owners" ] } } }, { "name": "Replace beneficial owner", "request": { "method": "PUT", "description": "Replace everything known about an owner. Whole, not partial, and it names the merchant, because the platform needs one.\n\nOperation ID: replaceBeneficialOwner", "url": { "raw": "{{baseUrl}}/beneficial-owners/:beneficialOwnerId", "host": [ "{{baseUrl}}" ], "path": [ "beneficial-owners", ":beneficialOwnerId" ], "variable": [ { "key": "beneficialOwnerId", "value": "", "description": "(string)" } ] } } }, { "name": "Delete beneficial owner", "request": { "method": "DELETE", "description": "Remove an owner. Check `deletable` first, the last owner of a verified merchant cannot be removed.\n\nOperation ID: deleteBeneficialOwner", "url": { "raw": "{{baseUrl}}/beneficial-owners/:beneficialOwnerId", "host": [ "{{baseUrl}}" ], "path": [ "beneficial-owners", ":beneficialOwnerId" ], "variable": [ { "key": "beneficialOwnerId", "value": "", "description": "(string)" } ] } } }, { "name": "Get file", "request": { "method": "GET", "description": "Read one document's details. The merchant is named by `merchantId` or the `Merchant-Id` header, the platform resolves a file within its merchant. Not the bytes.\n\nOperation ID: getFile", "url": { "raw": "{{baseUrl}}/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileId" ], "variable": [ { "key": "fileId", "value": "", "description": "(string)" } ] } } }, { "name": "List files", "request": { "method": "GET", "description": "Return a merchant's KYB documents. The merchant is named by `merchantId` or the `Merchant-Id` header, and the whole set comes back in one page, there are never many. `GET /filter-catalogues/files` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with a different `merchantId`, filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryFiles", "url": { "raw": "{{baseUrl}}/files", "host": [ "{{baseUrl}}" ], "path": [ "files" ] } } }, { "name": "Create files", "request": { "method": "POST", "description": "Upload a KYB document for a merchant. JPEG, PNG or PDF, up to 10MB.\n\nOperation ID: createFiles", "url": { "raw": "{{baseUrl}}/files", "host": [ "{{baseUrl}}" ], "path": [ "files" ] } } }, { "name": "List balances", "request": { "method": "GET", "description": "Return a merchant's balances, the platform's ledger position, and what each connected gateway holds. The merchant is named by `merchantId` or the `Merchant-Id` header.\n\nOperation ID: queryBalances", "url": { "raw": "{{baseUrl}}/balances", "host": [ "{{baseUrl}}" ], "path": [ "balances" ] } } }, { "name": "List external accounts", "request": { "method": "GET", "description": "Return a merchant's external accounts. The merchant is named by `merchantId` or the `Merchant-Id` header. There are never many, so the whole set comes back in one page.\n\nOperation ID: queryExternalAccounts", "url": { "raw": "{{baseUrl}}/external-accounts", "host": [ "{{baseUrl}}" ], "path": [ "external-accounts" ] } } }, { "name": "Create external accounts", "request": { "method": "POST", "description": "Add a bank account the merchant can be paid out to.\n\nOperation ID: createExternalAccounts", "url": { "raw": "{{baseUrl}}/external-accounts", "host": [ "{{baseUrl}}" ], "path": [ "external-accounts" ] } } }, { "name": "Update external account", "request": { "method": "PATCH", "description": "Make an account primary for its currency, ask the bank to verify it, or remove it. Every arm names the merchant, because the platform cannot resolve one from the account.\n\nOperation ID: updateExternalAccount", "url": { "raw": "{{baseUrl}}/external-accounts/:externalAccountId", "host": [ "{{baseUrl}}" ], "path": [ "external-accounts", ":externalAccountId" ], "variable": [ { "key": "externalAccountId", "value": "", "description": "(string)" } ] } } }, { "name": "List travel uploads", "request": { "method": "GET", "description": "Return a page of a merchant's uploads, newest first unless `sort` says otherwise. Name the merchant with `merchantId` or the `Merchant-Id` header. Query with `fileName` to find out whether a file has already been uploaded.\n\nOperation ID: queryTravelUploads", "url": { "raw": "{{baseUrl}}/travel-uploads", "host": [ "{{baseUrl}}" ], "path": [ "travel-uploads" ] } } }, { "name": "Create travel uploads", "request": { "method": "POST", "description": "Record that a file is being uploaded. Answers with the upload, in status `Uploading`.\n\nOperation ID: createTravelUploads", "url": { "raw": "{{baseUrl}}/travel-uploads", "host": [ "{{baseUrl}}" ], "path": [ "travel-uploads" ] } } }, { "name": "Update travel upload", "request": { "method": "PATCH", "description": "Settle an upload as `Uploaded` or `Failed`.\n\nOperation ID: updateTravelUpload", "url": { "raw": "{{baseUrl}}/travel-uploads/:travelUploadId", "host": [ "{{baseUrl}}" ], "path": [ "travel-uploads", ":travelUploadId" ], "variable": [ { "key": "travelUploadId", "value": "", "description": "(string)" } ] } } }, { "name": "List travel batches", "request": { "method": "GET", "description": "Return a page of the batches across a merchant's travel files, the newest file first unless `sort` says otherwise. Name whose batches with `merchantId`, `ownerMerchantId` or `travelFileId`, or the `Merchant-Id` header.\n\nOperation ID: queryTravelBatches", "url": { "raw": "{{baseUrl}}/travel-batches", "host": [ "{{baseUrl}}" ], "path": [ "travel-batches" ] } } }, { "name": "Get travel file", "request": { "method": "GET", "description": "Return one travel file.\n\nOperation ID: getTravelFile", "url": { "raw": "{{baseUrl}}/travel-files/:travelFileId", "host": [ "{{baseUrl}}" ], "path": [ "travel-files", ":travelFileId" ], "variable": [ { "key": "travelFileId", "value": "", "description": "(string)" } ] } } }, { "name": "List travel files", "request": { "method": "GET", "description": "Return a page of a merchant's travel files, newest first unless `sort` says otherwise. Name the merchant with `merchantId` or the `Merchant-Id` header.\n\nOperation ID: queryTravelFiles", "url": { "raw": "{{baseUrl}}/travel-files", "host": [ "{{baseUrl}}" ], "path": [ "travel-files" ] } } }, { "name": "Get travel file batch", "request": { "method": "GET", "description": "Return one batch of this file. A batch that does not belong to this travelFile is a 404, not a redirect.\n\nOperation ID: getTravelFileBatch", "url": { "raw": "{{baseUrl}}/travel-files/:travelFileId/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "travel-files", ":travelFileId", "batches", ":batchId" ], "variable": [ { "key": "travelFileId", "value": "", "description": "(string)" }, { "key": "batchId", "value": "", "description": "(string)" } ] } } }, { "name": "Get travel file missing dbi workbook", "request": { "method": "GET", "description": "Return the workbook of the entries of this file whose data-based invoicing check failed, as the file itself: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`.\n`Content-Disposition` names the file; the name is stated here too, because generated clients drop headers.\n\nThe entries are those whose data-based invoicing check failed in the last 14 days. `layout` is `Merchant`, the portal's columns,\nauthorised at the merchant the entries belong to, or `Admin`, the back office's, which shows other merchants' details and is\nplatform staff's. None to export is a `404`. The card is never a filter.\n\nOperation ID: getTravelFileMissingDbiWorkbook", "url": { "raw": "{{baseUrl}}/travel-files/:travelFileId/missing-dbi-workbooks/:layout", "host": [ "{{baseUrl}}" ], "path": [ "travel-files", ":travelFileId", "missing-dbi-workbooks", ":layout" ], "variable": [ { "key": "travelFileId", "value": "", "description": "(string)" }, { "key": "layout", "value": "", "description": "(string)" } ] } } }, { "name": "List travel file batches", "request": { "method": "GET", "description": "Return the batches of this file, in file order. A file has few, so they page by `page` only.\n\nOperation ID: queryTravelFileBatches", "url": { "raw": "{{baseUrl}}/travel-files/:travelFileId/batches", "host": [ "{{baseUrl}}" ], "path": [ "travel-files", ":travelFileId", "batches" ], "variable": [ { "key": "travelFileId", "value": "", "description": "(string)" } ] } } }, { "name": "List travel file errors", "request": { "method": "GET", "description": "Return the records of this file that failed their checks, each with the codes it raised. The line a record failed on is never published.\n\nOperation ID: queryTravelFileErrors", "url": { "raw": "{{baseUrl}}/travel-files/:travelFileId/errors", "host": [ "{{baseUrl}}" ], "path": [ "travel-files", ":travelFileId", "errors" ], "variable": [ { "key": "travelFileId", "value": "", "description": "(string)" } ] } } }, { "name": "Get travel entry", "request": { "method": "GET", "description": "Return one travel entry, with its service lines.\n\nOperation ID: getTravelEntry", "url": { "raw": "{{baseUrl}}/travel-entries/:travelEntryId", "host": [ "{{baseUrl}}" ], "path": [ "travel-entries", ":travelEntryId" ], "variable": [ { "key": "travelEntryId", "value": "", "description": "(string)" } ] } } }, { "name": "List travel entries", "request": { "method": "GET", "description": "Return a page of travel entries, newest first unless `sort` says otherwise. Name the owner with `merchantId` or the `Merchant-Id` header, or the merchant their files were uploaded for with `uploadedForMerchantId`; naming neither is a 400. To check that entries belong to a merchant before changing them, query them and read `ownerMerchantId`. Entries a later file replaced are left out unless `includeSuperseded` is true. Text filters match any entry that contains the text, and case matters.\n\nOperation ID: queryTravelEntries", "url": { "raw": "{{baseUrl}}/travel-entries", "host": [ "{{baseUrl}}" ], "path": [ "travel-entries" ] } } }, { "name": "Update travel entry", "request": { "method": "PATCH", "description": "Correct the entry, match it to its payment now, set how much of it has been refunded, say which purchase a refund refunds, or record by hand how it matched. The last three are staff's.\n\nOperation ID: updateTravelEntry", "url": { "raw": "{{baseUrl}}/travel-entries/:travelEntryId", "host": [ "{{baseUrl}}" ], "path": [ "travel-entries", ":travelEntryId" ], "variable": [ { "key": "travelEntryId", "value": "", "description": "(string)" } ] } } }, { "name": "List travel entry errors", "request": { "method": "GET", "description": "Return the records that failed on this entry, each with the codes it raised.\n\nOperation ID: queryTravelEntryErrors", "url": { "raw": "{{baseUrl}}/travel-entries/:travelEntryId/errors", "host": [ "{{baseUrl}}" ], "path": [ "travel-entries", ":travelEntryId", "errors" ], "variable": [ { "key": "travelEntryId", "value": "", "description": "(string)" } ] } } }, { "name": "List travel entry refund candidates", "request": { "method": "GET", "description": "Return the purchases this refund may be a refund of, oldest first, for the staff who relink it with `TvlentUpdateRelinkOriginal`. They are found on the refund's own card, which is never published, and are the owner's matched purchases of the refund's kind of file and processing page with at least the refund's amount still unrefunded. `matchOn` adds the references they must share with it. Only a refund has candidates.\n\nOperation ID: queryTravelEntryRefundCandidates", "url": { "raw": "{{baseUrl}}/travel-entries/:travelEntryId/refund-candidates", "host": [ "{{baseUrl}}" ], "path": [ "travel-entries", ":travelEntryId", "refund-candidates" ], "variable": [ { "key": "travelEntryId", "value": "", "description": "(string)" } ] } } }, { "name": "Get merchant travel setting", "request": { "method": "GET", "description": "Return a merchant's travel settings.\n\nOperation ID: getMerchantTravelSetting", "url": { "raw": "{{baseUrl}}/merchant-travel-settings/:merchantTravelSettingId", "host": [ "{{baseUrl}}" ], "path": [ "merchant-travel-settings", ":merchantTravelSettingId" ], "variable": [ { "key": "merchantTravelSettingId", "value": "", "description": "(string)" } ] } } }, { "name": "Update merchant travel setting", "request": { "method": "PATCH", "description": "Replace what the merchant may change on its travel settings.\n\nOperation ID: updateMerchantTravelSetting", "url": { "raw": "{{baseUrl}}/merchant-travel-settings/:merchantTravelSettingId", "host": [ "{{baseUrl}}" ], "path": [ "merchant-travel-settings", ":merchantTravelSettingId" ], "variable": [ { "key": "merchantTravelSettingId", "value": "", "description": "(string)" } ] } } }, { "name": "Get merchant travel setting missing dbi workbook", "request": { "method": "GET", "description": "Return the workbook of the entries of this merchant whose data-based invoicing check failed, read at the merchant's own settings, as the file itself: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`.\n`Content-Disposition` names the file; the name is stated here too, because generated clients drop headers.\n\nThe entries are those whose data-based invoicing check failed in the last 14 days. `layout` is `Merchant`, the portal's columns,\nauthorised at the merchant the entries belong to, or `Admin`, the back office's, which shows other merchants' details and is\nplatform staff's. None to export is a `404`. The card is never a filter.\n\nOperation ID: getMerchantTravelSettingMissingDbiWorkbook", "url": { "raw": "{{baseUrl}}/merchant-travel-settings/:merchantTravelSettingId/missing-dbi-workbooks/:layout", "host": [ "{{baseUrl}}" ], "path": [ "merchant-travel-settings", ":merchantTravelSettingId", "missing-dbi-workbooks", ":layout" ], "variable": [ { "key": "merchantTravelSettingId", "value": "", "description": "(string)" }, { "key": "layout", "value": "", "description": "(string)" } ] } } }, { "name": "Get merchant statement password", "request": { "method": "GET", "description": "Reveal the merchant's statement password. Audited: the read is recorded with who made it.\n\nOperation ID: getMerchantStatementPassword", "url": { "raw": "{{baseUrl}}/merchant-statement-passwords/:merchantStatementPasswordId", "host": [ "{{baseUrl}}" ], "path": [ "merchant-statement-passwords", ":merchantStatementPasswordId" ], "variable": [ { "key": "merchantStatementPasswordId", "value": "", "description": "(string)" } ] } } }, { "name": "Update merchant statement password", "request": { "method": "PATCH", "description": "Replace the merchant's statement password with a newly generated one. Audited. The answer does not carry the new password: read it, which is audited as a reveal.\n\nOperation ID: updateMerchantStatementPassword", "url": { "raw": "{{baseUrl}}/merchant-statement-passwords/:merchantStatementPasswordId", "host": [ "{{baseUrl}}" ], "path": [ "merchant-statement-passwords", ":merchantStatementPasswordId" ], "variable": [ { "key": "merchantStatementPasswordId", "value": "", "description": "(string)" } ] } } }, { "name": "List travel dbi corrections", "request": { "method": "GET", "description": "Return the corrections staged for a merchant's entries and not yet applied. Name the merchant with `merchantId` or the `Merchant-Id` header. A merchant has few, so they page by `page` only.\n\nOperation ID: queryTravelDbiCorrections", "url": { "raw": "{{baseUrl}}/travel-dbi-corrections", "host": [ "{{baseUrl}}" ], "path": [ "travel-dbi-corrections" ] } } }, { "name": "Create travel dbi corrections", "request": { "method": "POST", "description": "Correct the references of one or more entries and apply them. Answers with what was staged, refused and skipped, and what applying did.\n\nOperation ID: createTravelDbiCorrections", "url": { "raw": "{{baseUrl}}/travel-dbi-corrections", "host": [ "{{baseUrl}}" ], "path": [ "travel-dbi-corrections" ] } } } ] }, { "name": "Payment sources", "item": [ { "name": "Get source", "request": { "method": "GET", "description": "Return one payment source.\n\nOperation ID: getSource", "url": { "raw": "{{baseUrl}}/sources/:sourceId", "host": [ "{{baseUrl}}" ], "path": [ "sources", ":sourceId" ], "variable": [ { "key": "sourceId", "value": "", "description": "(string)" } ] } } }, { "name": "List sources", "request": { "method": "GET", "description": "Return a page of payment sources. Name whose sources: `customerId` or `customerDelegateId` is required, a source belongs to a payer and the platform does not page them across payers. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/sources` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.\n\nOperation ID: querySources", "url": { "raw": "{{baseUrl}}/sources", "host": [ "{{baseUrl}}" ], "path": [ "sources" ], "query": [ { "key": "limit", "value": "", "description": "integer (int32). Maximum results per page. Default to 20, must be between 1 and 2000.", "disabled": true }, { "key": "page", "value": "", "description": "integer (int32). Page number of results to show (starting at page 1).", "disabled": true }, { "key": "sort", "value": "", "description": "string. Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.", "disabled": true }, { "key": "customerId", "value": "", "description": "string. Filter by merchant customer system identifier.", "disabled": true }, { "key": "customerDelegateId", "value": "", "description": "string. Filter by customer delegate system identifier.", "disabled": true }, { "key": "usageScope", "value": "", "description": "PaymentSourceUsageScope. Filter by usage scope", "disabled": true } ] } } }, { "name": "Create sources", "request": { "method": "POST", "description": "Store a payment source. What kind is selected by the body's `type`. A card, bank account or PayTo agreement stored with `scope` `Billing` is the merchant's billing source, and needs `MerchantFinancials_Update` as the billing commands do.\n\nOperation ID: createSources", "url": { "raw": "{{baseUrl}}/sources", "host": [ "{{baseUrl}}" ], "path": [ "sources" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false }, { "key": "Customer-Id", "value": "", "description": "Perform operation in the context of the given merchant customer. Usually not required, specify only if acting on behalf of a merchant customer not implied by the credentials specified in the `Authorization` header.", "disabled": true }, { "key": "Merchant-Id", "value": "", "description": "Perform operation in the context of the given merchant. Usually not required, specify only if acting on behalf of a merchant not implied by the credentials specified in the `Authorization` header.", "disabled": true }, { "key": "Customer-Delegate-User-Id", "value": "", "description": "Perform operation in the context of the given organisation customer. Usually not required, specify only if acting on behalf of a organisation customer not implied by the credentials specified in the `Authorization` header.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"CreateConsumerCardSource\": {\n \"number\": \"string\",\n \"cvc\": \"string\",\n \"expiryDate\": {}\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update source", "request": { "method": "PATCH", "description": "Replace a card's verification code, or lift a block the platform placed on it. Selected by the body's `type`.\n\nOperation ID: updateSource", "url": { "raw": "{{baseUrl}}/sources/:sourceId", "host": [ "{{baseUrl}}" ], "path": [ "sources", ":sourceId" ], "variable": [ { "key": "sourceId", "value": "", "description": "(string)" } ] } } }, { "name": "Delete source", "request": { "method": "DELETE", "description": "Remove a stored payment source.\n\nOperation ID: deleteSource", "url": { "raw": "{{baseUrl}}/sources/:sourceId", "host": [ "{{baseUrl}}" ], "path": [ "sources", ":sourceId" ], "variable": [ { "key": "sourceId", "value": "", "description": "(string)" } ] } } }, { "name": "List blocked cards", "request": { "method": "GET", "description": "Return the card-block audit, newest first. One card can appear several times, a row is an event, not a card.\n\nOperation ID: queryBlockedCards", "url": { "raw": "{{baseUrl}}/blocked-cards", "host": [ "{{baseUrl}}" ], "path": [ "blocked-cards" ] } } }, { "name": "Update blocked card", "request": { "method": "PATCH", "description": "Lift the block on a card. Answers with the `Removed` event it appended, not the row you addressed.\n\nOperation ID: updateBlockedCard", "url": { "raw": "{{baseUrl}}/blocked-cards/:blockedCardId", "host": [ "{{baseUrl}}" ], "path": [ "blocked-cards", ":blockedCardId" ], "variable": [ { "key": "blockedCardId", "value": "", "description": "(string)" } ] } } }, { "name": "Get source verification", "request": { "method": "GET", "description": "Return one source verification.\n\nOperation ID: getSourceVerification", "url": { "raw": "{{baseUrl}}/source-verifications/:sourceVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "source-verifications", ":sourceVerificationId" ], "variable": [ { "key": "sourceVerificationId", "value": "", "description": "(string)" } ] } } }, { "name": "List source verifications", "request": { "method": "GET", "description": "Return the source verification of one transaction, as a page of at most one. `transactionId` is required.\n\nOperation ID: querySourceVerifications", "url": { "raw": "{{baseUrl}}/source-verifications", "host": [ "{{baseUrl}}" ], "path": [ "source-verifications" ] } } }, { "name": "Create source verifications", "request": { "method": "POST", "description": "Run a verification against a transaction's source.\n\nOperation ID: createSourceVerifications", "url": { "raw": "{{baseUrl}}/source-verifications", "host": [ "{{baseUrl}}" ], "path": [ "source-verifications" ] } } }, { "name": "Update source verification", "request": { "method": "PATCH", "description": "Override a verification's outcome, pass it, fail it, or reset it to run again.\n\nOperation ID: updateSourceVerification", "url": { "raw": "{{baseUrl}}/source-verifications/:sourceVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "source-verifications", ":sourceVerificationId" ], "variable": [ { "key": "sourceVerificationId", "value": "", "description": "(string)" } ] } } }, { "name": "Get pay to agreement", "request": { "method": "GET", "description": "Return an agreement's status. The identifier is the token you were given. It is sealed to its merchant, so the merchant is named by `merchantId` or the `Merchant-Id` header.\n\nOperation ID: getPayToAgreement", "url": { "raw": "{{baseUrl}}/pay-to-agreements/:payToAgreementId", "host": [ "{{baseUrl}}" ], "path": [ "pay-to-agreements", ":payToAgreementId" ], "variable": [ { "key": "payToAgreementId", "value": "", "description": "(string)" } ] } } }, { "name": "Create pay to agreements", "request": { "method": "POST", "description": "Ask a payer for a standing authority. The response carries the token, it is the only handle you get.\n\nOperation ID: createPayToAgreements", "url": { "raw": "{{baseUrl}}/pay-to-agreements", "host": [ "{{baseUrl}}" ], "path": [ "pay-to-agreements" ] } } }, { "name": "Create pay to aliases", "request": { "method": "POST", "description": "Resolve a PayID to the account name behind it. Nothing is stored, the answer is the lookup.\n\nOperation ID: createPayToAliases", "url": { "raw": "{{baseUrl}}/pay-to-aliases", "host": [ "{{baseUrl}}" ], "path": [ "pay-to-aliases" ] } } } ] }, { "name": "Transactions", "item": [ { "name": "Get transaction", "request": { "method": "GET", "description": "Return one transaction.\n\nOperation ID: getTransaction", "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "", "description": "(string)" } ] } } }, { "name": "List transactions", "request": { "method": "GET", "description": "Return a page of transactions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/transactions` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryTransactions", "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "key": "limit", "value": "", "description": "integer (int32). Maximum results per page. Default to 20, must be between 1 and 2000.", "disabled": true }, { "key": "page", "value": "", "description": "integer (int32). Page number of results to show (starting at page 1).", "disabled": true }, { "key": "sort", "value": "", "description": "string. Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.", "disabled": true }, { "key": "createdAfter", "value": "", "description": "string (date-time). Return transactions that were created at or after this timestamp in ISO-8601 format", "disabled": true }, { "key": "createdBefore", "value": "", "description": "string (date-time). Return transactions that were created at or before this timestamp in ISO-8601 format", "disabled": true }, { "key": "amount", "value": "", "description": "integer (int64). Amount of the transaction", "disabled": true }, { "key": "referenceTransactionId", "value": "", "description": "array of string. Filter by reference transaction identifier", "disabled": true }, { "key": "merchantId", "value": "", "description": "array of string. Filter by merchant identifier", "disabled": true }, { "key": "customerId", "value": "", "description": "array of string. Filter by customer identifier", "disabled": true }, { "key": "parentAcquiringTransactionId", "value": "", "description": "array of string. Filter by the transaction's parent aquiring transaction identifier", "disabled": true }, { "key": "parentIssuerTransactionId", "value": "", "description": "array of string. Filter by the transaction's parent issuer transaction identifier", "disabled": true }, { "key": "status", "value": "", "description": "TransactionStatus. Filter by the status of the transaction", "disabled": true } ] } } }, { "name": "Create transactions", "request": { "method": "POST", "description": "Take a payment. How the money is taken was decided when the payment token was created.\n\nOperation ID: createTransactions", "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false }, { "key": "Merchant-Id", "value": "", "description": "Perform operation in the context of the given merchant. Usually not required, specify only if acting on behalf of a merchant not implied by the credentials specified in the `Authorization` header.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ConfirmTransaction3DSComplete\": {\n \"orderId\": \"ordr_TnGzKCAzWWBORoxy\",\n \"paymentTokenId\": \"ptkn_6V356spkqmZ0dkUU\",\n \"threeDSResponse\": {},\n \"authoriseOnly\": true\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update transaction", "request": { "method": "PATCH", "description": "Capture or cancel an authorisation. Selected by the body's `type`.\n\nOperation ID: updateTransaction", "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "", "description": "(string)" } ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false }, { "key": "Merchant-Id", "value": "", "description": "Perform operation in the context of the given merchant. Usually not required, specify only if acting on behalf of a merchant not implied by the credentials specified in the `Authorization` header.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"CancelAuthorisation\": {}\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get transaction dispute", "request": { "method": "GET", "description": "Return one dispute of this transaction. A dispute that does not belong to this transaction is a 404, not a redirect.\n\nOperation ID: getTransactionDispute", "url": { "raw": "{{baseUrl}}/transactions/:transactionId/disputes/:disputeId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "disputes", ":disputeId" ], "variable": [ { "key": "transactionId", "value": "", "description": "(string)" }, { "key": "disputeId", "value": "", "description": "(string)" } ] } } }, { "name": "Get transaction refund", "request": { "method": "GET", "description": "Return one refund of this transaction. A refund that does not belong to this transaction is a 404, not a redirect.\n\nOperation ID: getTransactionRefund", "url": { "raw": "{{baseUrl}}/transactions/:transactionId/refunds/:refundId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "refunds", ":refundId" ], "variable": [ { "key": "transactionId", "value": "", "description": "(string)" }, { "key": "refundId", "value": "", "description": "(string)" } ] } } }, { "name": "List transaction disputes", "request": { "method": "GET", "description": "Return a page of the disputes raised against this transaction. A transaction's disputes are few and read as one list, so they page by `page` only: `startingAfter` and `endingBefore` are refused with 400, with or without `q`.\n\nOperation ID: queryTransactionDisputes", "url": { "raw": "{{baseUrl}}/transactions/:transactionId/disputes", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "disputes" ], "variable": [ { "key": "transactionId", "value": "", "description": "(string)" } ] } } }, { "name": "List transaction refunds", "request": { "method": "GET", "description": "Return a page of the refunds issued against this transaction. With `status`, the refunds of those statuses are paged by `page` only: `startingAfter` and `endingBefore` are refused with 400.\n\nOperation ID: queryTransactionRefunds", "url": { "raw": "{{baseUrl}}/transactions/:transactionId/refunds", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "refunds" ], "variable": [ { "key": "transactionId", "value": "", "description": "(string)" } ] } } }, { "name": "Get refund", "request": { "method": "GET", "description": "Return one refund.\n\nOperation ID: getRefund", "url": { "raw": "{{baseUrl}}/refunds/:refundId", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId" ], "variable": [ { "key": "refundId", "value": "", "description": "(string)" } ] } } }, { "name": "List refunds", "request": { "method": "GET", "description": "Return a page of refunds, one entry per refund: `limit` and `totalCount` count refunds, not the transactions they refund. Supply `page` for offset pagination or `startingAfter` for cursor pagination. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/refunds` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.\n\nOperation ID: queryRefunds", "url": { "raw": "{{baseUrl}}/refunds", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ] } } }, { "name": "Create refunds", "request": { "method": "POST", "description": "Refund part or all of a transaction, acquiring or issuing.\n\nOperation ID: createRefunds", "url": { "raw": "{{baseUrl}}/refunds", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ] } } }, { "name": "Get dispute", "request": { "method": "GET", "description": "Return one dispute.\n\nOperation ID: getDispute", "url": { "raw": "{{baseUrl}}/disputes/:disputeId", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":disputeId" ], "variable": [ { "key": "disputeId", "value": "", "description": "(string)" } ] } } }, { "name": "List disputes", "request": { "method": "GET", "description": "Return a page of disputes. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/disputes` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.\n\nOperation ID: queryDisputes", "url": { "raw": "{{baseUrl}}/disputes", "host": [ "{{baseUrl}}" ], "path": [ "disputes" ] } } }, { "name": "Update dispute", "request": { "method": "PATCH", "description": "Record an outcome the scheme decided out of band, submit evidence, or move the case on.\n\nOperation ID: updateDispute", "url": { "raw": "{{baseUrl}}/disputes/:disputeId", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":disputeId" ], "variable": [ { "key": "disputeId", "value": "", "description": "(string)" } ] } } }, { "name": "Get transfer", "request": { "method": "GET", "description": "Return the transfer record for a transaction: every movement out of it, and how much is left to move. The identifier is the transaction's.\n\nOperation ID: getTransfer", "url": { "raw": "{{baseUrl}}/transfers/:transferId", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":transferId" ], "variable": [ { "key": "transferId", "value": "", "description": "(string)" } ] } } }, { "name": "Create transfers", "request": { "method": "POST", "description": "Move part of a transaction's funds to another merchant.\n\nOperation ID: createTransfers", "url": { "raw": "{{baseUrl}}/transfers", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ] } } }, { "name": "Update transfer", "request": { "method": "PATCH", "description": "Claw back part of what was transferred to one merchant. Identify the record by its transaction.\n\nOperation ID: updateTransfer", "url": { "raw": "{{baseUrl}}/transfers/:transferId", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":transferId" ], "variable": [ { "key": "transferId", "value": "", "description": "(string)" } ] } } } ] }, { "name": "Filters", "item": [ { "name": "Get filter catalogue", "request": { "method": "GET", "description": "Return one list's filter catalogue for this caller, by the list's collection name, such as `transactions` or `loans`, read with that list's own authority. A list the caller cannot read answers 404.\n\nOperation ID: getFilterCatalogue", "url": { "raw": "{{baseUrl}}/filter-catalogues/:filterCatalogueId", "host": [ "{{baseUrl}}" ], "path": [ "filter-catalogues", ":filterCatalogueId" ], "variable": [ { "key": "filterCatalogueId", "value": "", "description": "(string)" } ] } } }, { "name": "List filter catalogues", "request": { "method": "GET", "description": "Return every filter catalogue this caller may read, one per list. Each is read with its list's own authority, as `x-required-action` lists them, and a list the caller cannot read is not listed.\n\nOperation ID: queryFilterCatalogues", "url": { "raw": "{{baseUrl}}/filter-catalogues", "host": [ "{{baseUrl}}" ], "path": [ "filter-catalogues" ] } } }, { "name": "List filter catalogue filter values", "request": { "method": "GET", "description": "Find the values one filter can take for this caller, a page at a time, scoped exactly as the list is. `q` is the search text, at least the filter's `minimumSearch` long. A `Referenced` filter's values are found by the referenced collection's search, run under the list's authority, and each is answered with its id and label only. Pass `nextStartingAfter` back as `startingAfter` for the next page; a cursor continues only the walk that issued it, the same `filter` and `q`, and is refused with 400 otherwise. The walk is forward only, so `endingBefore` and `page` are refused with 400. A `Listed` filter's values are in the catalogue and an `Entered` one's are typed, so both are refused with 400.\n\nOperation ID: queryFilterCatalogueFilterValues", "url": { "raw": "{{baseUrl}}/filter-catalogues/:filterCatalogueId/filter-values", "host": [ "{{baseUrl}}" ], "path": [ "filter-catalogues", ":filterCatalogueId", "filter-values" ], "variable": [ { "key": "filterCatalogueId", "value": "", "description": "(string)" } ] } } } ] }, { "name": "Orders", "item": [ { "name": "Get order", "request": { "method": "GET", "description": "Return one order.\n\nOperation ID: getOrder", "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "(string)" } ] } } }, { "name": "List orders", "request": { "method": "GET", "description": "Return a page of orders. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/orders` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.\n\nOperation ID: queryOrders", "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ], "query": [ { "key": "limit", "value": "", "description": "integer (int32). Maximum results per page. Default to 20, must be between 1 and 2000.", "disabled": true }, { "key": "page", "value": "", "description": "integer (int32). Page number of results to show (starting at page 1).", "disabled": true }, { "key": "sort", "value": "", "description": "string. Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.", "disabled": true }, { "key": "orderId", "value": "", "description": "array of string. Filter by merchant order id", "disabled": true }, { "key": "merchantId", "value": "", "description": "array of string. Filter by merchant identifier", "disabled": true }, { "key": "orderType", "value": "", "description": "array of OrderType1. Filter by order type", "disabled": true }, { "key": "referenceOrderId", "value": "", "description": "array of string. Filter by reference order id", "disabled": true }, { "key": "orderStatus", "value": "", "description": "array of OrderStatus. Filter by order status", "disabled": true } ] } } }, { "name": "Create orders", "request": { "method": "POST", "description": "Create an order, optionally with a payment link. Selected by the body's `type`.\n\nOperation ID: createOrders", "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false }, { "key": "Merchant-Id", "value": "", "description": "Perform operation in the context of the given merchant. Usually not required, specify only if acting on behalf of a merchant not implied by the credentials specified in the `Authorization` header.", "disabled": true }, { "key": "Customer-Id", "value": "", "description": "Perform operation in the context of the given merchant customer. Usually not required, specify only if acting on behalf of a merchant customer not implied by the credentials specified in the `Authorization` header.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"CreateOnlineOrder\": {\n \"referenceOrderId\": \"ORD-12411\",\n \"amount\": {},\n \"customerEmailAddress\": \"lucy.diamond@star.com\",\n \"customerPhoneNumber\": \"string\",\n \"description\": \"string\",\n \"items\": [],\n \"discountAmount\": 100,\n \"shipping\": {},\n \"billing\": {},\n \"metadata\": {},\n \"settlementConfiguration\": \"default\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update order", "request": { "method": "PATCH", "description": "Update an order's own details, cancel it, reissue its payment link or send it. Selected by the body's `type`.\n\nOperation ID: updateOrder", "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "(string)" } ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false } ], "body": { "mode": "raw", "raw": "{\n \"UpdateReferenceOrderId\": {\n \"referenceOrderId\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Loans", "item": [ { "name": "Get loan", "request": { "method": "GET", "description": "Return one loan.\n\nOperation ID: getLoan", "url": { "raw": "{{baseUrl}}/loans/:loanId", "host": [ "{{baseUrl}}" ], "path": [ "loans", ":loanId" ], "variable": [ { "key": "loanId", "value": "", "description": "(string)" } ] } } }, { "name": "List loans", "request": { "method": "GET", "description": "Return a page of loans. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/loans` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryLoans", "url": { "raw": "{{baseUrl}}/loans", "host": [ "{{baseUrl}}" ], "path": [ "loans" ], "query": [ { "key": "limit", "value": "", "description": "integer (int32). Maximum results per page. Default to 20, must be between 1 and 2000.", "disabled": true }, { "key": "page", "value": "", "description": "integer (int32). Page number of results to show (starting at page 1).", "disabled": true }, { "key": "sort", "value": "", "description": "string. Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.", "disabled": true }, { "key": "loanId", "value": "", "description": "array of string. Filter by loan system identifiers.", "disabled": true }, { "key": "referenceLoanId", "value": "", "description": "array of string. Filter by reference loan id.", "disabled": true }, { "key": "loanProductType", "value": "", "description": "array of LoanProductProductType. Filter by loan product type.", "disabled": true }, { "key": "merchantId", "value": "", "description": "string. Filter by merchant identifier", "disabled": true }, { "key": "customerId", "value": "", "description": "array of string. Filter by customer identifier", "disabled": true }, { "key": "currency", "value": "", "description": "string. Filter by currency", "disabled": true }, { "key": "status", "value": "", "description": "array of LoanStatus. Filter by loan status", "disabled": true }, { "key": "createdFromInclusive", "value": "", "description": "string (date-time), required. Return loans that were created at or after this timestamp in ISO-8601 format", "disabled": false }, { "key": "createdToExclusive", "value": "", "description": "string (date-time). Return loans that were created before this timestamp in ISO-8601 format", "disabled": true } ] } } }, { "name": "Create loans", "request": { "method": "POST", "description": "Apply for a loan, or accept an offer. Selected by the body's `type`. Applying answers with an offer; accepting it answers with the loan.\n\nOperation ID: createLoans", "url": { "raw": "{{baseUrl}}/loans", "host": [ "{{baseUrl}}" ], "path": [ "loans" ] } } }, { "name": "Update loan", "request": { "method": "PATCH", "description": "Update a loan's mutable attributes, including its status and its limit, or replace or clear its statement settings. Answers with the loan, and with the statement settings where the patch changed them.\n\nOperation ID: updateLoan", "url": { "raw": "{{baseUrl}}/loans/:loanId", "host": [ "{{baseUrl}}" ], "path": [ "loans", ":loanId" ], "variable": [ { "key": "loanId", "value": "", "description": "(string)" } ] } } }, { "name": "Get loan statement setting", "request": { "method": "GET", "description": "Return how this loan's statement documents are produced and delivered. `LoanStatementSettingsNotConfigured` means none are set: the loan's statements get CSV and PDF and nothing is mailed. The transfer secret is never returned; `secretSet` says whether one is stored. Settings imported from APG read back as stored and may fail validation when sent back: `,`-joined or malformed addresses are refused until corrected. Needs `Loans_Update`, as changing them does, with `LoanUpdateStatementSettings` or `LoanUpdateClearStatementSettings` on the loan's `PATCH`.\n\nOperation ID: getLoanStatementSetting", "url": { "raw": "{{baseUrl}}/loans/:loanId/statement-settings", "host": [ "{{baseUrl}}" ], "path": [ "loans", ":loanId", "statement-settings" ], "variable": [ { "key": "loanId", "value": "", "description": "(string)" } ] } } }, { "name": "Get loan facility", "request": { "method": "GET", "description": "Return one loan facility.\n\nOperation ID: getLoanFacility", "url": { "raw": "{{baseUrl}}/loan-facilities/:loanFacilityId", "host": [ "{{baseUrl}}" ], "path": [ "loan-facilities", ":loanFacilityId" ], "variable": [ { "key": "loanFacilityId", "value": "", "description": "(string)" } ] } } }, { "name": "List loan facilities", "request": { "method": "GET", "description": "Return a page of loan facilities. The read is scoped to one enterprise and infers it from the credential, an enterprise API key names one. A credential that does not, such as a platform-admin JWT, must send the enterprise in an `Enterprise-Id` header. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/loan-facilities` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryLoanFacilities", "url": { "raw": "{{baseUrl}}/loan-facilities", "host": [ "{{baseUrl}}" ], "path": [ "loan-facilities" ] } } }, { "name": "Create loan facilities", "request": { "method": "POST", "description": "Create a loan facility.\n\nOperation ID: createLoanFacilities", "url": { "raw": "{{baseUrl}}/loan-facilities", "host": [ "{{baseUrl}}" ], "path": [ "loan-facilities" ] } } }, { "name": "Update loan facility", "request": { "method": "PATCH", "description": "Add funds to a facility, change the business it lends on behalf of, or set where its statements ask to be paid and the mark they are drawn with. The business profile is merged over what is stored.\n\nOperation ID: updateLoanFacility", "url": { "raw": "{{baseUrl}}/loan-facilities/:loanFacilityId", "host": [ "{{baseUrl}}" ], "path": [ "loan-facilities", ":loanFacilityId" ], "variable": [ { "key": "loanFacilityId", "value": "", "description": "(string)" } ] } } }, { "name": "Get loan statement", "request": { "method": "GET", "description": "Return one loan statement, with its entries.\n\nOperation ID: getLoanStatement", "url": { "raw": "{{baseUrl}}/loan-statements/:loanStatementId", "host": [ "{{baseUrl}}" ], "path": [ "loan-statements", ":loanStatementId" ], "variable": [ { "key": "loanStatementId", "value": "", "description": "(string)" } ] } } }, { "name": "List loan statements", "request": { "method": "GET", "description": "Return a page of loan statements. Without `q`, a query with no `loanId`, `referenceStatementId` or date bound reads the statements created in the last 90 days, and an upper bound alone reads the 90 days ending there. A `q` search covers all of the borrower's statements, as far as the caller's delegate loan access allows, so an old statement is found by its reference. `GET /filter-catalogues/loan-statements` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryLoanStatements", "url": { "raw": "{{baseUrl}}/loan-statements", "host": [ "{{baseUrl}}" ], "path": [ "loan-statements" ] } } }, { "name": "Create loan statements", "request": { "method": "POST", "description": "Cut a statement for a loan's current period, or recreate historic ones. Selected by the body's `type`.\n\nOperation ID: createLoanStatements", "url": { "raw": "{{baseUrl}}/loan-statements", "host": [ "{{baseUrl}}" ], "path": [ "loan-statements" ] } } }, { "name": "Update loan statement", "request": { "method": "PATCH", "description": "Issue a statement, move its billing date, credit a payment, recompute its totals, cancel a late fee, cancel the loan's latest statement, or generate, regenerate and e-mail its documents.\n\nOperation ID: updateLoanStatement", "url": { "raw": "{{baseUrl}}/loan-statements/:loanStatementId", "host": [ "{{baseUrl}}" ], "path": [ "loan-statements", ":loanStatementId" ], "variable": [ { "key": "loanStatementId", "value": "", "description": "(string)" } ] } } }, { "name": "Get loan statement document", "request": { "method": "GET", "description": "Return one of the statement's documents as the file itself, under its own media type: `text/csv` for `Csv`,\n`application/pdf` for `Pdf`, `application/xml` for `Xml`. `Content-Disposition` names the file; the name is stated\nhere too, because generated clients drop headers.\n\nWith `useLimepayGeneration=true` the file is the one the platform stored, named\n`{ediNumber}_{referenceStatementId}_{yyyyMMdd_HHmmss}.{documentId}[.V{schemaVersion}].{csv|pdf|xml}`, the time in UTC.\nA format not produced for this statement yet, or XML for a loan whose settings do not enable it, is a `400`.\n\nWith `false`, the file is relayed unchanged from APG's gateway under APG's own name. APG not finding the\nstatement is a `404`; any other refusal from APG is a `500`.\n\nOmitted, the environment decides: dev, tst and stg answer as `true` does, production as `false` does.\n\nSend an `Accept` naming the format, or none. One naming none of the three, `application/json` for one, is a `406`\nwith an empty body; one naming another of the three still gets the format in the path. Any other query parameter\nis a `400`.\n\nOperation ID: getLoanStatementDocument", "url": { "raw": "{{baseUrl}}/loan-statements/:loanStatementId/documents/:format", "host": [ "{{baseUrl}}" ], "path": [ "loan-statements", ":loanStatementId", "documents", ":format" ], "variable": [ { "key": "loanStatementId", "value": "", "description": "(string)" }, { "key": "format", "value": "", "description": "(string)" } ] } } }, { "name": "List loan statement documents", "request": { "method": "GET", "description": "Return the documents made for the statement, each with where it got to: its format, its status, its mail and its ready notice. A statement has few, so they page by `page` only.\n\nOperation ID: queryLoanStatementDocuments", "url": { "raw": "{{baseUrl}}/loan-statements/:loanStatementId/documents", "host": [ "{{baseUrl}}" ], "path": [ "loan-statements", ":loanStatementId", "documents" ], "variable": [ { "key": "loanStatementId", "value": "", "description": "(string)" } ] } } }, { "name": "Get loan transaction", "request": { "method": "GET", "description": "Return one loan transaction.\n\nOperation ID: getLoanTransaction", "url": { "raw": "{{baseUrl}}/loan-transactions/:loanTransactionId", "host": [ "{{baseUrl}}" ], "path": [ "loan-transactions", ":loanTransactionId" ], "variable": [ { "key": "loanTransactionId", "value": "", "description": "(string)" } ] } } }, { "name": "List loan transactions", "request": { "method": "GET", "description": "Return a page of loan transactions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/loan-transactions` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryLoanTransactions", "url": { "raw": "{{baseUrl}}/loan-transactions", "host": [ "{{baseUrl}}" ], "path": [ "loan-transactions" ] } } }, { "name": "Create loan transactions", "request": { "method": "POST", "description": "Post a fee or an adjustment to a loan. Answers with the movement, or with the loan's balances where the entry was a standalone fee.\n\nOperation ID: createLoanTransactions", "url": { "raw": "{{baseUrl}}/loan-transactions", "host": [ "{{baseUrl}}" ], "path": [ "loan-transactions" ] } } }, { "name": "Update loan transaction", "request": { "method": "PATCH", "description": "Publish an authorised movement to the balance, or cancel it.\n\nOperation ID: updateLoanTransaction", "url": { "raw": "{{baseUrl}}/loan-transactions/:loanTransactionId", "host": [ "{{baseUrl}}" ], "path": [ "loan-transactions", ":loanTransactionId" ], "variable": [ { "key": "loanTransactionId", "value": "", "description": "(string)" } ] } } }, { "name": "Get loan product", "request": { "method": "GET", "description": "Return one loan product.\n\nOperation ID: getLoanProduct", "url": { "raw": "{{baseUrl}}/loan-products/:loanProductId", "host": [ "{{baseUrl}}" ], "path": [ "loan-products", ":loanProductId" ], "variable": [ { "key": "loanProductId", "value": "", "description": "(string)" } ] } } }, { "name": "List loan products", "request": { "method": "GET", "description": "Return a page of loan products. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/loan-products` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryLoanProducts", "url": { "raw": "{{baseUrl}}/loan-products", "host": [ "{{baseUrl}}" ], "path": [ "loan-products" ] } } }, { "name": "Create loan products", "request": { "method": "POST", "description": "Create a loan product against a facility.\n\nOperation ID: createLoanProducts", "url": { "raw": "{{baseUrl}}/loan-products", "host": [ "{{baseUrl}}" ], "path": [ "loan-products" ] } } }, { "name": "Update loan product", "request": { "method": "PATCH", "description": "Change a product's limits or its late-payment grace days. Nothing else about a product can be changed.\n\nOperation ID: updateLoanProduct", "url": { "raw": "{{baseUrl}}/loan-products/:loanProductId", "host": [ "{{baseUrl}}" ], "path": [ "loan-products", ":loanProductId" ], "variable": [ { "key": "loanProductId", "value": "", "description": "(string)" } ] } } }, { "name": "Get loan agreement", "request": { "method": "GET", "description": "Return one loan agreement.\n\nOperation ID: getLoanAgreement", "url": { "raw": "{{baseUrl}}/loan-agreements/:loanAgreementId", "host": [ "{{baseUrl}}" ], "path": [ "loan-agreements", ":loanAgreementId" ], "variable": [ { "key": "loanAgreementId", "value": "", "description": "(string)" } ] } } }, { "name": "List loan agreements", "request": { "method": "GET", "description": "Return a page of loan agreements. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/loan-agreements` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryLoanAgreements", "url": { "raw": "{{baseUrl}}/loan-agreements", "host": [ "{{baseUrl}}" ], "path": [ "loan-agreements" ] } } }, { "name": "Create loan agreements", "request": { "method": "POST", "description": "Create a loan agreement against a facility.\n\nOperation ID: createLoanAgreements", "url": { "raw": "{{baseUrl}}/loan-agreements", "host": [ "{{baseUrl}}" ], "path": [ "loan-agreements" ] } } }, { "name": "Update loan agreement", "request": { "method": "PATCH", "description": "Change what may be outstanding on an agreement. An agreement cannot be renamed.\n\nOperation ID: updateLoanAgreement", "url": { "raw": "{{baseUrl}}/loan-agreements/:loanAgreementId", "host": [ "{{baseUrl}}" ], "path": [ "loan-agreements", ":loanAgreementId" ], "variable": [ { "key": "loanAgreementId", "value": "", "description": "(string)" } ] } } }, { "name": "List statement receipts", "request": { "method": "GET", "description": "Return the receipts recorded against a statement, oldest first. A statement has few, so they page by `page` only.\n\nOperation ID: queryStatementReceipts", "url": { "raw": "{{baseUrl}}/statement-receipts", "host": [ "{{baseUrl}}" ], "path": [ "statement-receipts" ] } } }, { "name": "Create statement receipts", "request": { "method": "POST", "description": "Record a payment received against a statement and apply it. A `requestReference` already recorded answers with what it holds.\n\nOperation ID: createStatementReceipts", "url": { "raw": "{{baseUrl}}/statement-receipts", "host": [ "{{baseUrl}}" ], "path": [ "statement-receipts" ] } } }, { "name": "Get statement receipt batch", "request": { "method": "GET", "description": "Return one batch with its receipts.\n\nOperation ID: getStatementReceiptBatch", "url": { "raw": "{{baseUrl}}/statement-receipt-batches/:statementReceiptBatchId", "host": [ "{{baseUrl}}" ], "path": [ "statement-receipt-batches", ":statementReceiptBatchId" ], "variable": [ { "key": "statementReceiptBatchId", "value": "", "description": "(string)" } ] } } }, { "name": "List statement receipt batches", "request": { "method": "GET", "description": "Return a page of batches, newest first unless `sort` says otherwise. Staff only: a batch can span any merchant's statements.\n\nOperation ID: queryStatementReceiptBatches", "url": { "raw": "{{baseUrl}}/statement-receipt-batches", "host": [ "{{baseUrl}}" ], "path": [ "statement-receipt-batches" ] } } }, { "name": "Update statement receipt batch", "request": { "method": "PATCH", "description": "Settle a batch the bank has accepted: its receipts are marked received and each is applied to its statement.\n\nOperation ID: updateStatementReceiptBatch", "url": { "raw": "{{baseUrl}}/statement-receipt-batches/:statementReceiptBatchId", "host": [ "{{baseUrl}}" ], "path": [ "statement-receipt-batches", ":statementReceiptBatchId" ], "variable": [ { "key": "statementReceiptBatchId", "value": "", "description": "(string)" } ] } } }, { "name": "List daily card file runs", "request": { "method": "GET", "description": "Return a customer's daily card file runs for a day, withdrawn ones included. A day has few, so they page by `page` only.\n\nOperation ID: queryDailyCardFileRuns", "url": { "raw": "{{baseUrl}}/daily-card-file-runs", "host": [ "{{baseUrl}}" ], "path": [ "daily-card-file-runs" ] } } }, { "name": "Get daily card file run file", "request": { "method": "GET", "description": "Return the file generated for the run, as the file itself: `application/xml`. `Content-Disposition` names the file; the name\nis stated here too, because generated clients drop headers. A run whose file has not been generated yet is a `404`.\n\nOperation ID: getDailyCardFileRunFile", "url": { "raw": "{{baseUrl}}/daily-card-file-runs/:dailyCardFileRunId/files/:format", "host": [ "{{baseUrl}}" ], "path": [ "daily-card-file-runs", ":dailyCardFileRunId", "files", ":format" ], "variable": [ { "key": "dailyCardFileRunId", "value": "", "description": "(string)" }, { "key": "format", "value": "", "description": "(string)" } ] } } }, { "name": "List loan statement lines", "request": { "method": "GET", "description": "Return the lines of loan statements that a search names. Platform staff only. Lines page by `page`.\n\nOperation ID: queryLoanStatementLines", "url": { "raw": "{{baseUrl}}/loan-statement-lines", "host": [ "{{baseUrl}}" ], "path": [ "loan-statement-lines" ] } } }, { "name": "Get statement dbi batch", "request": { "method": "GET", "description": "Return what is staged for the statement, an empty batch when nothing is.\n\nOperation ID: getStatementDbiBatch", "url": { "raw": "{{baseUrl}}/statement-dbi-batches/:statementDbiBatchId", "host": [ "{{baseUrl}}" ], "path": [ "statement-dbi-batches", ":statementDbiBatchId" ], "variable": [ { "key": "statementDbiBatchId", "value": "", "description": "(string)" } ] } } }, { "name": "Replace statement dbi batch", "request": { "method": "PUT", "description": "Stage the references of the statement's transactions, replacing anything already staged.\n\nOperation ID: replaceStatementDbiBatch", "url": { "raw": "{{baseUrl}}/statement-dbi-batches/:statementDbiBatchId", "host": [ "{{baseUrl}}" ], "path": [ "statement-dbi-batches", ":statementDbiBatchId" ], "variable": [ { "key": "statementDbiBatchId", "value": "", "description": "(string)" } ] } } }, { "name": "Update statement dbi batch", "request": { "method": "PATCH", "description": "Add references to what is staged, or apply the batch and have the statement's documents made again.\n\nOperation ID: updateStatementDbiBatch", "url": { "raw": "{{baseUrl}}/statement-dbi-batches/:statementDbiBatchId", "host": [ "{{baseUrl}}" ], "path": [ "statement-dbi-batches", ":statementDbiBatchId" ], "variable": [ { "key": "statementDbiBatchId", "value": "", "description": "(string)" } ] } } } ] }, { "name": "Payouts", "item": [ { "name": "Get payout", "request": { "method": "GET", "description": "Return one payout, with what it is made of.\n\nOperation ID: getPayout", "url": { "raw": "{{baseUrl}}/payouts/:payoutId", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":payoutId" ], "variable": [ { "key": "payoutId", "value": "", "description": "(string)" } ] } } }, { "name": "List payouts", "request": { "method": "GET", "description": "Return a page of payouts. Filter by `reference` to answer a question about a bank statement line. `composition` is not populated on a page. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/payouts` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.\n\nOperation ID: queryPayouts", "url": { "raw": "{{baseUrl}}/payouts", "host": [ "{{baseUrl}}" ], "path": [ "payouts" ] } } }, { "name": "Create payouts", "request": { "method": "POST", "description": "Raise a payout by hand, for the credential's own merchant.\n\nOperation ID: createPayouts", "url": { "raw": "{{baseUrl}}/payouts", "host": [ "{{baseUrl}}" ], "path": [ "payouts" ] } } }, { "name": "Update payout", "request": { "method": "PATCH", "description": "Record an out-of-band settlement, reverse a payout, release a suspended one, push one through a disbursement run, or make its statement again or mail it again.\n\nOperation ID: updatePayout", "url": { "raw": "{{baseUrl}}/payouts/:payoutId", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":payoutId" ], "variable": [ { "key": "payoutId", "value": "", "description": "(string)" } ] } } }, { "name": "Get payout document", "request": { "method": "GET", "description": "Return the payout's statement as the file itself, under its own media type: `text/csv` for `Csv`, `application/pdf` for `Pdf`,\n`application/xml` for `Xml`. `Content-Disposition` names the file; the name is stated here too, because generated clients drop headers.\nA statement not made yet is a `404`.\n\nOperation ID: getPayoutDocument", "url": { "raw": "{{baseUrl}}/payouts/:payoutId/documents/:format", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":payoutId", "documents", ":format" ], "variable": [ { "key": "payoutId", "value": "", "description": "(string)" }, { "key": "format", "value": "", "description": "(string)" } ] } } }, { "name": "List payout documents", "request": { "method": "GET", "description": "Return the documents made for the payout's statement, each with where it got to: its format, its status and its mail. A payout has few, so they page by `page` only.\n\nOperation ID: queryPayoutDocuments", "url": { "raw": "{{baseUrl}}/payouts/:payoutId/documents", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":payoutId", "documents" ], "variable": [ { "key": "payoutId", "value": "", "description": "(string)" } ] } } } ] }, { "name": "FX rates", "item": [ { "name": "Get FX rate set", "request": { "method": "GET", "description": "Return one rate set with its current rates.\n\nOperation ID: getFxRateSet", "url": { "raw": "{{baseUrl}}/fx-rate-sets/:fxRateSetId", "host": [ "{{baseUrl}}" ], "path": [ "fx-rate-sets", ":fxRateSetId" ], "variable": [ { "key": "fxRateSetId", "value": "", "description": "(string)" } ] } } }, { "name": "Create FX rate sets", "request": { "method": "POST", "description": "Create a rate set with an initial set of rates. The response carries the identifier you address it by.\n\nOperation ID: createFxRateSets", "url": { "raw": "{{baseUrl}}/fx-rate-sets", "host": [ "{{baseUrl}}" ], "path": [ "fx-rate-sets" ] } } }, { "name": "Update FX rate set", "request": { "method": "PATCH", "description": "Load new rates. `replaceOldRates` decides whether they replace the set's rates or merge into them, there is no safe default.\n\nOperation ID: updateFxRateSet", "url": { "raw": "{{baseUrl}}/fx-rate-sets/:fxRateSetId", "host": [ "{{baseUrl}}" ], "path": [ "fx-rate-sets", ":fxRateSetId" ], "variable": [ { "key": "fxRateSetId", "value": "", "description": "(string)" } ] } } }, { "name": "Get FX rate set rate", "request": { "method": "GET", "description": "Price one currency pair from this set. A pair the set does not quote directly is crossed through its `crossCurrency`, and the legs come back with it.\n\nOperation ID: getFxRateSetRate", "url": { "raw": "{{baseUrl}}/fx-rate-sets/:fxRateSetId/rates", "host": [ "{{baseUrl}}" ], "path": [ "fx-rate-sets", ":fxRateSetId", "rates" ], "variable": [ { "key": "fxRateSetId", "value": "", "description": "(string)" } ] } } }, { "name": "Create FX conversions", "request": { "method": "POST", "description": "Convert an amount at an enterprise's rates. The answer is the conversion, nothing is stored.\n\nOperation ID: createFxConversions", "url": { "raw": "{{baseUrl}}/fx-conversions", "host": [ "{{baseUrl}}" ], "path": [ "fx-conversions" ] } } } ] }, { "name": "Webhooks", "item": [ { "name": "Get webhook", "request": { "method": "GET", "description": "Return one webhook subscription. The signing secret is never included.\n\nOperation ID: getWebhook", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "", "description": "(string)" } ] } } }, { "name": "List webhooks", "request": { "method": "GET", "description": "Return a page of webhook subscriptions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. A caller held to no merchant or marketplace, and not entitled to every subscription, reads only those its `merchantId` or `marketplaceId` names. `GET /filter-catalogues/webhooks` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryWebhooks", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "query": [ { "key": "limit", "value": "", "description": "integer (int32). Maximum results per page. Default to 20, must be between 1 and 2000.", "disabled": true }, { "key": "page", "value": "", "description": "integer (int32). Page number of results to show (starting at page 1).", "disabled": true }, { "key": "sort", "value": "", "description": "string. Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.", "disabled": true }, { "key": "merchantId", "value": "", "description": "array of string. Only include webhook merchant subscriptions for this given list of sub-merchants. Only relevant for marketplace users interested in merchant level subscriptions.", "disabled": true }, { "key": "marketplaceId", "value": "", "description": "string. Only include webhook marketplace subscriptions for the given marketplaceId. Only relevant for admin users interested in marketplace level subscriptions.", "disabled": true }, { "key": "status", "value": "", "description": "WebhookSubscriptionState. Filter by subscription status", "disabled": true } ] } } }, { "name": "Create webhooks", "request": { "method": "POST", "description": "Subscribe an endpoint to platform events.\n\nOperation ID: createWebhooks", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false }, { "key": "Merchant-Id", "value": "", "description": "Perform operation in the context of the given merchant. Usually not required, specify only if acting on behalf of a merchant not implied by the credentials specified in the `Authorization` header.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"CreateWebhookMarketplaceSubscription\": {\n \"url\": \"https://api.myservice.io/events\",\n \"events\": [],\n \"description\": \"string\",\n \"metadata\": {}\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update webhook", "request": { "method": "PATCH", "description": "Update a subscription's url, event types, description or status, or rotate its signing secret. Fields you omit are left unchanged.\n\nOperation ID: updateWebhook", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "", "description": "(string)" } ] } } }, { "name": "Get webhook delivery", "request": { "method": "GET", "description": "Return one delivery, with its attempts and what your endpoint last answered. A delivery that does not belong to this webhook is a 404, not a redirect.\n\nOperation ID: getWebhookDelivery", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId" ], "variable": [ { "key": "webhookId", "value": "", "description": "(string)" }, { "key": "deliveryId", "value": "", "description": "(string)" } ] } } }, { "name": "List webhook deliveries", "request": { "method": "GET", "description": "Return a page of this subscription's deliveries, newest first. Filter by `status` to find the ones that did not arrive, and by `event` to follow one event type. Each entry carries the attempt count and the last HTTP status your endpoint answered with.\n\nOperation ID: queryWebhookDeliveries", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "variable": [ { "key": "webhookId", "value": "", "description": "(string)" } ] } } }, { "name": "Update webhook delivery", "request": { "method": "PATCH", "description": "Act on one delivery. Today the only action is to send it again. A delivery that does not belong to this webhook is a 404, not a redirect.\n\nOperation ID: updateWebhookDelivery", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId" ], "variable": [ { "key": "webhookId", "value": "", "description": "(string)" }, { "key": "deliveryId", "value": "", "description": "(string)" } ] } } } ] }, { "name": "Payment tokens", "item": [ { "name": "Get payment token", "request": { "method": "GET", "description": "Return one payment token.\n\nOperation ID: getPaymentToken", "url": { "raw": "{{baseUrl}}/payment-tokens/:paymentTokenId", "host": [ "{{baseUrl}}" ], "path": [ "payment-tokens", ":paymentTokenId" ], "variable": [ { "key": "paymentTokenId", "value": "", "description": "(string)" } ] } } }, { "name": "Create payment tokens", "request": { "method": "POST", "description": "Issue a payment token. The payment method is selected by the body's `type`.\n\nOperation ID: createPaymentTokens", "url": { "raw": "{{baseUrl}}/payment-tokens", "host": [ "{{baseUrl}}" ], "path": [ "payment-tokens" ] } } }, { "name": "Create surcharge quotes", "request": { "method": "POST", "description": "Ask what a payment would cost. The way you identify the method is selected by the body's `type`.\n\nOperation ID: createSurchargeQuotes", "url": { "raw": "{{baseUrl}}/surcharge-quotes", "host": [ "{{baseUrl}}" ], "path": [ "surcharge-quotes" ] } } } ] }, { "name": "Reference data", "item": [ { "name": "Create reference entries", "request": { "method": "POST", "description": "Look a bank branch up, list the industries, or load a register. A lookup needs `MerchantFinancials_Query`, a load `ReferenceData_Create`, and the industries no permission beyond the credential.\n\nOperation ID: createReferenceEntries", "url": { "raw": "{{baseUrl}}/reference-entries", "host": [ "{{baseUrl}}" ], "path": [ "reference-entries" ] } } }, { "name": "Get bin group", "request": { "method": "GET", "description": "Read one BIN group with its ranges.\n\nOperation ID: getBinGroup", "url": { "raw": "{{baseUrl}}/bin-groups/:binGroupId", "host": [ "{{baseUrl}}" ], "path": [ "bin-groups", ":binGroupId" ], "variable": [ { "key": "binGroupId", "value": "", "description": "(string)" } ] } } }, { "name": "Create bin groups", "request": { "method": "POST", "description": "Create a BIN group. The platform assigns the identifier; a replace is the only way to change one afterwards.\n\nOperation ID: createBinGroups", "url": { "raw": "{{baseUrl}}/bin-groups", "host": [ "{{baseUrl}}" ], "path": [ "bin-groups" ] } } }, { "name": "Replace bin group", "request": { "method": "PUT", "description": "Replace a group's title and ranges. Whole, not partial, and it keeps the group's creation date, which a create cannot.\n\nOperation ID: replaceBinGroup", "url": { "raw": "{{baseUrl}}/bin-groups/:binGroupId", "host": [ "{{baseUrl}}" ], "path": [ "bin-groups", ":binGroupId" ], "variable": [ { "key": "binGroupId", "value": "", "description": "(string)" } ] } } }, { "name": "Create ABN lookups", "request": { "method": "POST", "description": "Ask the register about an ABN. The answer is the lookup, nothing is stored, so keep it.\n\nOperation ID: createAbnLookups", "url": { "raw": "{{baseUrl}}/abn-lookups", "host": [ "{{baseUrl}}" ], "path": [ "abn-lookups" ] } } }, { "name": "Get rule area", "request": { "method": "GET", "description": "Return one rule area by its domain, with its templates, fields, actions and list kinds.\n\nOperation ID: getRuleArea", "url": { "raw": "{{baseUrl}}/rule-areas/:ruleAreaId", "host": [ "{{baseUrl}}" ], "path": [ "rule-areas", ":ruleAreaId" ], "variable": [ { "key": "ruleAreaId", "value": "", "description": "(string)" } ] } } }, { "name": "List rule areas", "request": { "method": "GET", "description": "Return every rule area the platform has registered, each with what it offers.\n\nOperation ID: queryRuleAreas", "url": { "raw": "{{baseUrl}}/rule-areas", "host": [ "{{baseUrl}}" ], "path": [ "rule-areas" ] } } }, { "name": "Get rule policy", "request": { "method": "GET", "description": "Return one rule policy as its current version holds it, with its rule.\n\nOperation ID: getRulePolicy", "url": { "raw": "{{baseUrl}}/rule-policies/:rulePolicyId", "host": [ "{{baseUrl}}" ], "path": [ "rule-policies", ":rulePolicyId" ], "variable": [ { "key": "rulePolicyId", "value": "", "description": "(string)" } ] } } }, { "name": "List rule policies", "request": { "method": "GET", "description": "Return a page of the policies the caller may see in one area, newest change first, optionally only one owner's and only those in one state. Walk the pages with `page`, or pass `nextStartingAfter` back as `startingAfter`.\n\nOperation ID: queryRulePolicies", "url": { "raw": "{{baseUrl}}/rule-policies", "host": [ "{{baseUrl}}" ], "path": [ "rule-policies" ] } } }, { "name": "Create rule policies", "request": { "method": "POST", "description": "Make a rule policy as a draft at version 1. The rule is checked against its template and its owner's lists, and refused with every reason if it fails.\n\nOperation ID: createRulePolicies", "url": { "raw": "{{baseUrl}}/rule-policies", "host": [ "{{baseUrl}}" ], "path": [ "rule-policies" ] } } }, { "name": "Update rule policy", "request": { "method": "PATCH", "description": "Make the next version of a policy, or take a step of the maker and checker flow: submit, approve or reject a version, pause, resume or retire the rule.\n\nOperation ID: updateRulePolicy", "url": { "raw": "{{baseUrl}}/rule-policies/:rulePolicyId", "host": [ "{{baseUrl}}" ], "path": [ "rule-policies", ":rulePolicyId" ], "variable": [ { "key": "rulePolicyId", "value": "", "description": "(string)" } ] } } }, { "name": "Get rule policy version", "request": { "method": "GET", "description": "Return one version of a policy with the rule it held. A version that does not belong to this rulePolicy is a 404, not a redirect.\n\nOperation ID: getRulePolicyVersion", "url": { "raw": "{{baseUrl}}/rule-policies/:rulePolicyId/versions/:versionId", "host": [ "{{baseUrl}}" ], "path": [ "rule-policies", ":rulePolicyId", "versions", ":versionId" ], "variable": [ { "key": "rulePolicyId", "value": "", "description": "(string)" }, { "key": "versionId", "value": "", "description": "(string)" } ] } } }, { "name": "List rule policy versions", "request": { "method": "GET", "description": "Return a page of the versions of a policy, oldest first, each with its rule, what it changed, why, by whom and when.\n\nOperation ID: queryRulePolicyVersions", "url": { "raw": "{{baseUrl}}/rule-policies/:rulePolicyId/versions", "host": [ "{{baseUrl}}" ], "path": [ "rule-policies", ":rulePolicyId", "versions" ], "variable": [ { "key": "rulePolicyId", "value": "", "description": "(string)" } ] } } }, { "name": "Get named list", "request": { "method": "GET", "description": "Return one named list as its current version holds it, without its entries.\n\nOperation ID: getNamedList", "url": { "raw": "{{baseUrl}}/named-lists/:namedListId", "host": [ "{{baseUrl}}" ], "path": [ "named-lists", ":namedListId" ], "variable": [ { "key": "namedListId", "value": "", "description": "(string)" } ] } } }, { "name": "List named lists", "request": { "method": "GET", "description": "Return a page of the named lists the caller may see in one area, newest change first, optionally only one owner's.\n\nOperation ID: queryNamedLists", "url": { "raw": "{{baseUrl}}/named-lists", "host": [ "{{baseUrl}}" ], "path": [ "named-lists" ] } } }, { "name": "Create named lists", "request": { "method": "POST", "description": "Make a named list holding the entries given, as version 1. Every entry is checked against the list's kind, and refused with every reason if it fails.\n\nOperation ID: createNamedLists", "url": { "raw": "{{baseUrl}}/named-lists", "host": [ "{{baseUrl}}" ], "path": [ "named-lists" ] } } }, { "name": "Update named list", "request": { "method": "PATCH", "description": "Add entries to a list and take entries from it, as its next version. An edit that changes nothing writes no version.\n\nOperation ID: updateNamedList", "url": { "raw": "{{baseUrl}}/named-lists/:namedListId", "host": [ "{{baseUrl}}" ], "path": [ "named-lists", ":namedListId" ], "variable": [ { "key": "namedListId", "value": "", "description": "(string)" } ] } } }, { "name": "List named list entries", "request": { "method": "GET", "description": "Return the entries a list held at a version, the current one where none is named, in the order of their values. A version the list never had is a 404.\n\nOperation ID: queryNamedListEntries", "url": { "raw": "{{baseUrl}}/named-lists/:namedListId/entries", "host": [ "{{baseUrl}}" ], "path": [ "named-lists", ":namedListId", "entries" ], "variable": [ { "key": "namedListId", "value": "", "description": "(string)" } ] } } }, { "name": "List named list versions", "request": { "method": "GET", "description": "Return every version of a list, oldest first, with the entries each added and removed, why, by whom and when.\n\nOperation ID: queryNamedListVersions", "url": { "raw": "{{baseUrl}}/named-lists/:namedListId/versions", "host": [ "{{baseUrl}}" ], "path": [ "named-lists", ":namedListId", "versions" ], "variable": [ { "key": "namedListId", "value": "", "description": "(string)" } ] } } }, { "name": "List rule decisions", "request": { "method": "GET", "description": "Return a page of the decisions made for one target in one area, latest first, each with the fields it read and what each rule did.\n\nOperation ID: queryRuleDecisions", "url": { "raw": "{{baseUrl}}/rule-decisions", "host": [ "{{baseUrl}}" ], "path": [ "rule-decisions" ] } } }, { "name": "List apg numbers", "request": { "method": "GET", "description": "Return the identifiers of the records that APG numbers name, or the APG numbers that records hold, for one `kind`. A number or record that has no counterpart is left out.\n\nOperation ID: queryApgNumbers", "url": { "raw": "{{baseUrl}}/apg-numbers", "host": [ "{{baseUrl}}" ], "path": [ "apg-numbers" ] } } } ] }, { "name": "Ledgers and journals", "item": [ { "name": "Update ledger", "request": { "method": "PATCH", "description": "Recount a ledger from a point in time, optionally from a stated opening balance.\n\nOperation ID: updateLedger", "url": { "raw": "{{baseUrl}}/ledgers/:ledgerId", "host": [ "{{baseUrl}}" ], "path": [ "ledgers", ":ledgerId" ], "variable": [ { "key": "ledgerId", "value": "", "description": "(string)" } ] } } }, { "name": "Update ledgers", "request": { "method": "PATCH", "description": "Clear the ledgers of a set of merchants or loans, or adjust or correct one loan's balance. A clearance answers with what was cleared, an empty list clears every owner of that kind; an adjustment or correction answers with the loan's ledger.\n\nOperation ID: updateLedgers", "url": { "raw": "{{baseUrl}}/ledgers", "host": [ "{{baseUrl}}" ], "path": [ "ledgers" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false } ], "body": { "mode": "raw", "raw": "{\n \"ClearLoanSystemLedgers\": {\n \"loanIds\": [\n \"loan_Ryu_FJI-Lnzv2FKY\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get journal", "request": { "method": "GET", "description": "Return one journal: its five-part identity, and the ledger it clears into.\n\nOperation ID: getJournal", "url": { "raw": "{{baseUrl}}/journals/:journalId", "host": [ "{{baseUrl}}" ], "path": [ "journals", ":journalId" ], "variable": [ { "key": "journalId", "value": "", "description": "(string)" } ] } } }, { "name": "List journals", "request": { "method": "GET", "description": "Return a page of journals. A journal is identified by five things together, so the filters narrow rather than name one.\n\nOperation ID: queryJournals", "url": { "raw": "{{baseUrl}}/journals", "host": [ "{{baseUrl}}" ], "path": [ "journals" ] } } }, { "name": "Update journal", "request": { "method": "PATCH", "description": "Link a journal to the ledger it clears into, and record when it last cleared.\n\nOperation ID: updateJournal", "url": { "raw": "{{baseUrl}}/journals/:journalId", "host": [ "{{baseUrl}}" ], "path": [ "journals", ":journalId" ], "variable": [ { "key": "journalId", "value": "", "description": "(string)" } ] } } }, { "name": "Update journals", "request": { "method": "PATCH", "description": "Open or clear the journals of a set of merchants. Answers with what was done, an empty `merchantIds` acts on every merchant.\n\nOperation ID: updateJournals", "url": { "raw": "{{baseUrl}}/journals", "host": [ "{{baseUrl}}" ], "path": [ "journals" ] } } }, { "name": "List journal entries", "request": { "method": "GET", "description": "Return a page of journal entries. Narrow by journal, owner, category, clearance system and currency, and by date. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/journal-entries` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryJournalEntries", "url": { "raw": "{{baseUrl}}/journal-entries", "host": [ "{{baseUrl}}" ], "path": [ "journal-entries" ] } } }, { "name": "Create journal entries", "request": { "method": "POST", "description": "Top up a merchant's book. Writes a balanced pair of entries and answers with the date the funds clear.\n\nOperation ID: createJournalEntries", "url": { "raw": "{{baseUrl}}/journal-entries", "host": [ "{{baseUrl}}" ], "path": [ "journal-entries" ] } } } ] }, { "name": "Enterprises", "item": [ { "name": "Get enterprise", "request": { "method": "GET", "description": "Return one enterprise.\n\nOperation ID: getEnterprise", "url": { "raw": "{{baseUrl}}/enterprises/:enterpriseId", "host": [ "{{baseUrl}}" ], "path": [ "enterprises", ":enterpriseId" ], "variable": [ { "key": "enterpriseId", "value": "", "description": "(string)" } ] } } }, { "name": "List enterprises", "request": { "method": "GET", "description": "Return a page of enterprises. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/enterprises` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryEnterprises", "url": { "raw": "{{baseUrl}}/enterprises", "host": [ "{{baseUrl}}" ], "path": [ "enterprises" ], "query": [ { "key": "limit", "value": "", "description": "integer (int32). Maximum results per page. Default to 20, must be between 1 and 2000.", "disabled": true }, { "key": "page", "value": "", "description": "integer (int32). Page number of results to show (starting at page 1).", "disabled": true }, { "key": "sort", "value": "", "description": "string. Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.", "disabled": true }, { "key": "businessName", "value": "", "description": "array of string. Filter by business name", "disabled": true }, { "key": "readableIdentifier", "value": "", "description": "array of string. Filter by readable identifier", "disabled": true }, { "key": "createdFromInclusive", "value": "", "description": "string (date-time). Return enterprises that were created at or after this timestamp in ISO-8601 format", "disabled": true }, { "key": "createdToExclusive", "value": "", "description": "string (date-time). Return enterprises that were created before this timestamp in ISO-8601 format", "disabled": true } ] } } }, { "name": "Create enterprises", "request": { "method": "POST", "description": "Create an enterprise. The response carries its API key, once.\n\nOperation ID: createEnterprises", "url": { "raw": "{{baseUrl}}/enterprises", "host": [ "{{baseUrl}}" ], "path": [ "enterprises" ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false } ], "body": { "mode": "raw", "raw": "{\n \"slug\": \"mybusiness\",\n \"businessName\": \"string\",\n \"website\": \"string\",\n \"companyEmail\": \"lucy.diamond@star.com\",\n \"companyPhone\": \"+61401234567\",\n \"publicEncryptionKey\": [\n {\n \"name\": \"string\",\n \"key\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update enterprise", "request": { "method": "PATCH", "description": "Add or replace a public encryption key for the enterprise, give or replace its registration, set its branding, or set the hosts it serves. One operation per request. An enterprise's own credential may do all but the last for its own enterprise; claiming hosts is the platform's alone.\n\nOperation ID: updateEnterprise", "url": { "raw": "{{baseUrl}}/enterprises/:enterpriseId", "host": [ "{{baseUrl}}" ], "path": [ "enterprises", ":enterpriseId" ], "variable": [ { "key": "enterpriseId", "value": "", "description": "(string)" } ] }, "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "disabled": false } ], "body": { "mode": "raw", "raw": "{\n \"SetupPublicEncryptionKey\": {\n \"publicEncryptionKey\": {}\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Parties", "item": [ { "name": "Get organisation", "request": { "method": "GET", "description": "Return one organisation in the caller's scope.\n\nOperation ID: getOrganisation", "url": { "raw": "{{baseUrl}}/organisations/:organisationId", "host": [ "{{baseUrl}}" ], "path": [ "organisations", ":organisationId" ], "variable": [ { "key": "organisationId", "value": "", "description": "(string)" } ] } } }, { "name": "List organisations", "request": { "method": "GET", "description": "Return a page of the organisations in the caller's scope, newest first unless `sort` says otherwise. Supply `page` for offset pagination or `startingAfter` for cursor pagination. A cursor continues only the walk that issued it: sent with different filters or `sort`, it is refused with 400.\n\nOperation ID: queryOrganisations", "url": { "raw": "{{baseUrl}}/organisations", "host": [ "{{baseUrl}}" ], "path": [ "organisations" ] } } }, { "name": "Update organisation", "request": { "method": "PATCH", "description": "Replace the organisation's contact. It is replaced whole, so a field left out is cleared.\n\nOperation ID: updateOrganisation", "url": { "raw": "{{baseUrl}}/organisations/:organisationId", "host": [ "{{baseUrl}}" ], "path": [ "organisations", ":organisationId" ], "variable": [ { "key": "organisationId", "value": "", "description": "(string)" } ] } } }, { "name": "Get person", "request": { "method": "GET", "description": "Return one person in the caller's scope.\n\nOperation ID: getPerson", "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "key": "personId", "value": "", "description": "(string)" } ] } } }, { "name": "List persons", "request": { "method": "GET", "description": "Return a page of the persons in the caller's scope, newest first unless `sort` says otherwise. Supply `page` for offset pagination or `startingAfter` for cursor pagination. A cursor continues only the walk that issued it: sent with different filters or `sort`, it is refused with 400.\n\nOperation ID: queryPersons", "url": { "raw": "{{baseUrl}}/persons", "host": [ "{{baseUrl}}" ], "path": [ "persons" ] } } }, { "name": "Get supplier", "request": { "method": "GET", "description": "Return one supplier in the caller's scope.\n\nOperation ID: getSupplier", "url": { "raw": "{{baseUrl}}/suppliers/:supplierId", "host": [ "{{baseUrl}}" ], "path": [ "suppliers", ":supplierId" ], "variable": [ { "key": "supplierId", "value": "", "description": "(string)" } ] } } }, { "name": "List suppliers", "request": { "method": "GET", "description": "Return a page of the suppliers in the caller's scope, newest first unless `sort` says otherwise. Supply `page` for offset pagination or `startingAfter` for cursor pagination.\n\nOperation ID: querySuppliers", "url": { "raw": "{{baseUrl}}/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "suppliers" ] } } } ] }, { "name": "Operations", "item": [ { "name": "Get queue", "request": { "method": "GET", "description": "Return one queue by name, with what each consumer group on it is doing.\n\nOperation ID: getQueue", "url": { "raw": "{{baseUrl}}/queues/:queueId", "host": [ "{{baseUrl}}" ], "path": [ "queues", ":queueId" ], "variable": [ { "key": "queueId", "value": "", "description": "(string)" } ] } } }, { "name": "List queues", "request": { "method": "GET", "description": "Return every queue the platform drains, with what each consumer group on it is doing.\n\nOperation ID: queryQueues", "url": { "raw": "{{baseUrl}}/queues", "host": [ "{{baseUrl}}" ], "path": [ "queues" ] } } }, { "name": "Update queue", "request": { "method": "PATCH", "description": "Replay up to 100 of this queue's dead letters at once, each published again unchanged. Answers with the outcome for every id, `Replayed`, `NotFound` or `Failed`, and the queue as it reads afterwards. One that fails does not stop the rest.\n\nOperation ID: updateQueue", "url": { "raw": "{{baseUrl}}/queues/:queueId", "host": [ "{{baseUrl}}" ], "path": [ "queues", ":queueId" ], "variable": [ { "key": "queueId", "value": "", "description": "(string)" } ] } } }, { "name": "Get queue dead letter", "request": { "method": "GET", "description": "Return one dead letter, with the message exactly as it was published. A deadLetter that does not belong to this queue is a 404, not a redirect.\n\nOperation ID: getQueueDeadLetter", "url": { "raw": "{{baseUrl}}/queues/:queueId/dead-letters/:deadLetterId", "host": [ "{{baseUrl}}" ], "path": [ "queues", ":queueId", "dead-letters", ":deadLetterId" ], "variable": [ { "key": "queueId", "value": "", "description": "(string)" }, { "key": "deadLetterId", "value": "", "description": "(string)" } ] } } }, { "name": "List queue dead letters", "request": { "method": "GET", "description": "Return the messages this queue's consumers could not handle, newest first.\n\nOperation ID: queryQueueDeadLetters", "url": { "raw": "{{baseUrl}}/queues/:queueId/dead-letters", "host": [ "{{baseUrl}}" ], "path": [ "queues", ":queueId", "dead-letters" ], "variable": [ { "key": "queueId", "value": "", "description": "(string)" } ] } } }, { "name": "Update queue dead letter", "request": { "method": "PATCH", "description": "Act on one dead letter. `QueueDlqReplay` publishes the message again, unchanged. A deadLetter that does not belong to this queue is a 404, not a redirect.\n\nOperation ID: updateQueueDeadLetter", "url": { "raw": "{{baseUrl}}/queues/:queueId/dead-letters/:deadLetterId", "host": [ "{{baseUrl}}" ], "path": [ "queues", ":queueId", "dead-letters", ":deadLetterId" ], "variable": [ { "key": "queueId", "value": "", "description": "(string)" }, { "key": "deadLetterId", "value": "", "description": "(string)" } ] } } }, { "name": "Get feature flag", "request": { "method": "GET", "description": "Return one flag by name, with who it is on for.\n\nOperation ID: getFeatureFlag", "url": { "raw": "{{baseUrl}}/feature-flags/:featureFlagId", "host": [ "{{baseUrl}}" ], "path": [ "feature-flags", ":featureFlagId" ], "variable": [ { "key": "featureFlagId", "value": "", "description": "(string)" } ] } } }, { "name": "List feature flags", "request": { "method": "GET", "description": "Return every flag the platform declares, with who each is on for.\n\nOperation ID: queryFeatureFlags", "url": { "raw": "{{baseUrl}}/feature-flags", "host": [ "{{baseUrl}}" ], "path": [ "feature-flags" ] } } }, { "name": "Update feature flag", "request": { "method": "PATCH", "description": "Change who a flag is on for: set its mode, or add to or take from its tenants or its people. Answers with the flag as it now is.\n\nOperation ID: updateFeatureFlag", "url": { "raw": "{{baseUrl}}/feature-flags/:featureFlagId", "host": [ "{{baseUrl}}" ], "path": [ "feature-flags", ":featureFlagId" ], "variable": [ { "key": "featureFlagId", "value": "", "description": "(string)" } ] } } }, { "name": "Update export job", "request": { "method": "PATCH", "description": "Cancel one export job, or put one that failed on the platform's side back in the queue. Answers the job as it now is.\n\nOperation ID: updateExportJob", "url": { "raw": "{{baseUrl}}/export-jobs/:exportJobId", "host": [ "{{baseUrl}}" ], "path": [ "export-jobs", ":exportJobId" ], "variable": [ { "key": "exportJobId", "value": "", "description": "(string)" } ] } } }, { "name": "Update export jobs", "request": { "method": "PATCH", "description": "Cancel every queued or running export job of one tenant, or put back in the queue every job that failed on the platform's side since a time. Answers the jobs changed and those left as they were.\n\nOperation ID: updateExportJobs", "url": { "raw": "{{baseUrl}}/export-jobs", "host": [ "{{baseUrl}}" ], "path": [ "export-jobs" ] } } } ] }, { "name": "Reporting", "item": [ { "name": "Get report dataset", "request": { "method": "GET", "description": "Return one dataset: its dimensions, measures and time grains. The caller may keep the answer for five minutes.\n\nOperation ID: getReportDataset", "url": { "raw": "{{baseUrl}}/report-datasets/:reportDatasetId", "host": [ "{{baseUrl}}" ], "path": [ "report-datasets", ":reportDatasetId" ], "variable": [ { "key": "reportDatasetId", "value": "", "description": "(string)" } ] } } }, { "name": "List report datasets", "request": { "method": "GET", "description": "Return every dataset this caller may ask questions of. The caller may keep the answer for five minutes.\n\nOperation ID: queryReportDatasets", "url": { "raw": "{{baseUrl}}/report-datasets", "host": [ "{{baseUrl}}" ], "path": [ "report-datasets" ] } } }, { "name": "List report dataset dimension values", "request": { "method": "GET", "description": "Find the values a dimension can be filtered to, a page at a time. `q` is the search text, required for a `Search` lookup. The values page by cursor in a fixed order: a lookup searched by name in name order, a declared list in its declared order, anything else in its values' order. Pass `nextStartingAfter` back as `startingAfter` for the next page; `hasMore` says whether one follows. A cursor continues only the walk that issued it, the same dimension and `q`, and is refused with 400 otherwise. The walk is forward only, so `endingBefore` and `page` are refused with 400. A listed dimension's page is its declaration's, which the caller may keep for five minutes (`Cache-Control: private, max-age=300`); a searched or referenced one is read from the data each time and carries no `Cache-Control`.\n\nOperation ID: queryReportDatasetDimensionValues", "url": { "raw": "{{baseUrl}}/report-datasets/:reportDatasetId/dimension-values", "host": [ "{{baseUrl}}" ], "path": [ "report-datasets", ":reportDatasetId", "dimension-values" ], "variable": [ { "key": "reportDatasetId", "value": "", "description": "(string)" } ] } } }, { "name": "Get report range", "request": { "method": "GET", "description": "Return one named time range, by its name.\n\nOperation ID: getReportRange", "url": { "raw": "{{baseUrl}}/report-ranges/:reportRangeId", "host": [ "{{baseUrl}}" ], "path": [ "report-ranges", ":reportRangeId" ], "variable": [ { "key": "reportRangeId", "value": "", "description": "(string)" } ] } } }, { "name": "List report ranges", "request": { "method": "GET", "description": "Return every named time range, in display order.\n\nOperation ID: queryReportRanges", "url": { "raw": "{{baseUrl}}/report-ranges", "host": [ "{{baseUrl}}" ], "path": [ "report-ranges" ] } } }, { "name": "Create report queries", "request": { "method": "POST", "description": "Ask a dataset a question. The answer is returned and not stored.\n\nOperation ID: createReportQueries", "url": { "raw": "{{baseUrl}}/report-queries", "host": [ "{{baseUrl}}" ], "path": [ "report-queries" ] } } }, { "name": "Create report query batches", "request": { "method": "POST", "description": "Ask several questions at once. The answers come back in the order asked, each answered or refused.\n\nOperation ID: createReportQueryBatches", "url": { "raw": "{{baseUrl}}/report-query-batches", "host": [ "{{baseUrl}}" ], "path": [ "report-query-batches" ] } } }, { "name": "Create report exports", "request": { "method": "POST", "description": "Export a question's whole answer. The answer is the file, and nothing is stored.\n\nOperation ID: createReportExports", "url": { "raw": "{{baseUrl}}/report-exports", "host": [ "{{baseUrl}}" ], "path": [ "report-exports" ] } } }, { "name": "Create report query plans", "request": { "method": "POST", "description": "Explain a question: its SQL, plan and estimated cost. Nothing is run and nothing is stored.\n\nOperation ID: createReportQueryPlans", "url": { "raw": "{{baseUrl}}/report-query-plans", "host": [ "{{baseUrl}}" ], "path": [ "report-query-plans" ] } } }, { "name": "Get report space", "request": { "method": "GET", "description": "Return one space the caller can see.\n\nOperation ID: getReportSpace", "url": { "raw": "{{baseUrl}}/report-spaces/:reportSpaceId", "host": [ "{{baseUrl}}" ], "path": [ "report-spaces", ":reportSpaceId" ], "variable": [ { "key": "reportSpaceId", "value": "", "description": "(string)" } ] } } }, { "name": "List report spaces", "request": { "method": "GET", "description": "Return a page of the spaces the caller can see, in the order they were saved. `q` matches part of a name. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `page` and `endingBefore` are refused with 400.\n\nOperation ID: queryReportSpaces", "url": { "raw": "{{baseUrl}}/report-spaces", "host": [ "{{baseUrl}}" ], "path": [ "report-spaces" ] } } }, { "name": "Create report spaces", "request": { "method": "POST", "description": "Save a space, or with `RspcCmdDefault` find or make the caller's default space. A shared one needs `Reports_Manage` as well.\n\nOperation ID: createReportSpaces", "url": { "raw": "{{baseUrl}}/report-spaces", "host": [ "{{baseUrl}}" ], "path": [ "report-spaces" ] } } }, { "name": "Update report space", "request": { "method": "PATCH", "description": "Rename, move or share a space the caller may change. Sharing one, or changing a shared one, needs `Reports_Manage` as well, and the System space keeps its name and place.\n\nOperation ID: updateReportSpace", "url": { "raw": "{{baseUrl}}/report-spaces/:reportSpaceId", "host": [ "{{baseUrl}}" ], "path": [ "report-spaces", ":reportSpaceId" ], "variable": [ { "key": "reportSpaceId", "value": "", "description": "(string)" } ] } } }, { "name": "Delete report space", "request": { "method": "DELETE", "description": "Delete a space the caller may change, moving what it held up to its parent, or from a private space at the top to the caller's default space. A shared space at the top and the default space must be empty, and the System space cannot be deleted.\n\nOperation ID: deleteReportSpace", "url": { "raw": "{{baseUrl}}/report-spaces/:reportSpaceId", "host": [ "{{baseUrl}}" ], "path": [ "report-spaces", ":reportSpaceId" ], "variable": [ { "key": "reportSpaceId", "value": "", "description": "(string)" } ] } } }, { "name": "Get report chart", "request": { "method": "GET", "description": "Return one chart the caller can read.\n\nOperation ID: getReportChart", "url": { "raw": "{{baseUrl}}/report-charts/:reportChartId", "host": [ "{{baseUrl}}" ], "path": [ "report-charts", ":reportChartId" ], "variable": [ { "key": "reportChartId", "value": "", "description": "(string)" } ] } } }, { "name": "List report charts", "request": { "method": "GET", "description": "Return a page of the charts the caller can read, in the order they were saved. `q` matches part of a title. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `page` and `endingBefore` are refused with 400.\n\nOperation ID: queryReportCharts", "url": { "raw": "{{baseUrl}}/report-charts", "host": [ "{{baseUrl}}" ], "path": [ "report-charts" ] } } }, { "name": "Create report charts", "request": { "method": "POST", "description": "Save a chart, or a copy of one. Saving in a shared space needs `Reports_Manage` as well.\n\nOperation ID: createReportCharts", "url": { "raw": "{{baseUrl}}/report-charts", "host": [ "{{baseUrl}}" ], "path": [ "report-charts" ] } } }, { "name": "Update report chart", "request": { "method": "PATCH", "description": "Rename, move, re-ask or redraw a chart the caller may change. Changing one in a shared space needs `Reports_Manage` as well.\n\nOperation ID: updateReportChart", "url": { "raw": "{{baseUrl}}/report-charts/:reportChartId", "host": [ "{{baseUrl}}" ], "path": [ "report-charts", ":reportChartId" ], "variable": [ { "key": "reportChartId", "value": "", "description": "(string)" } ] } } }, { "name": "Delete report chart", "request": { "method": "DELETE", "description": "Delete a chart the caller may change, and its tiles from every dashboard showing it.\n\nOperation ID: deleteReportChart", "url": { "raw": "{{baseUrl}}/report-charts/:reportChartId", "host": [ "{{baseUrl}}" ], "path": [ "report-charts", ":reportChartId" ], "variable": [ { "key": "reportChartId", "value": "", "description": "(string)" } ] } } }, { "name": "Get report dashboard", "request": { "method": "GET", "description": "Return one dashboard the caller can read, with the tiles it may read. `include=Charts` also returns the charts those tiles show that the caller may read, each as `GET /report-charts/{id}` returns it, in tile order and each once, so a dashboard's charts are read in one request. Any other `include` value is refused with 400.\n\nOperation ID: getReportDashboard", "url": { "raw": "{{baseUrl}}/report-dashboards/:reportDashboardId", "host": [ "{{baseUrl}}" ], "path": [ "report-dashboards", ":reportDashboardId" ], "variable": [ { "key": "reportDashboardId", "value": "", "description": "(string)" } ] } } }, { "name": "List report dashboards", "request": { "method": "GET", "description": "Return a page of the dashboards the caller can read, in the order they were saved. `q` matches part of a title. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `page` and `endingBefore` are refused with 400.\n\nOperation ID: queryReportDashboards", "url": { "raw": "{{baseUrl}}/report-dashboards", "host": [ "{{baseUrl}}" ], "path": [ "report-dashboards" ] } } }, { "name": "Create report dashboards", "request": { "method": "POST", "description": "Save a dashboard, or a copy of one. Saving in a shared space needs `Reports_Manage` as well.\n\nOperation ID: createReportDashboards", "url": { "raw": "{{baseUrl}}/report-dashboards", "host": [ "{{baseUrl}}" ], "path": [ "report-dashboards" ] } } }, { "name": "Update report dashboard", "request": { "method": "PATCH", "description": "Rename, move, lay out or set the presentation of a dashboard the caller may change. Changing one in a shared space needs `Reports_Manage` as well.\n\nOperation ID: updateReportDashboard", "url": { "raw": "{{baseUrl}}/report-dashboards/:reportDashboardId", "host": [ "{{baseUrl}}" ], "path": [ "report-dashboards", ":reportDashboardId" ], "variable": [ { "key": "reportDashboardId", "value": "", "description": "(string)" } ] } } }, { "name": "Delete report dashboard", "request": { "method": "DELETE", "description": "Delete a dashboard the caller may change, and every pin of it.\n\nOperation ID: deleteReportDashboard", "url": { "raw": "{{baseUrl}}/report-dashboards/:reportDashboardId", "host": [ "{{baseUrl}}" ], "path": [ "report-dashboards", ":reportDashboardId" ], "variable": [ { "key": "reportDashboardId", "value": "", "description": "(string)" } ] } } }, { "name": "Get report notebook", "request": { "method": "GET", "description": "Return one notebook the caller can read.\n\nOperation ID: getReportNotebook", "url": { "raw": "{{baseUrl}}/report-notebooks/:reportNotebookId", "host": [ "{{baseUrl}}" ], "path": [ "report-notebooks", ":reportNotebookId" ], "variable": [ { "key": "reportNotebookId", "value": "", "description": "(string)" } ] } } }, { "name": "List report notebooks", "request": { "method": "GET", "description": "Return a page of the notebooks the caller can read, in the order they were saved. `q` matches part of a title. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `page` and `endingBefore` are refused with 400.\n\nOperation ID: queryReportNotebooks", "url": { "raw": "{{baseUrl}}/report-notebooks", "host": [ "{{baseUrl}}" ], "path": [ "report-notebooks" ] } } }, { "name": "Create report notebooks", "request": { "method": "POST", "description": "Save a notebook, or a copy of one. Saving in a shared space needs `Reports_Manage` as well.\n\nOperation ID: createReportNotebooks", "url": { "raw": "{{baseUrl}}/report-notebooks", "host": [ "{{baseUrl}}" ], "path": [ "report-notebooks" ] } } }, { "name": "Update report notebook", "request": { "method": "PATCH", "description": "Rename, move or rewrite a notebook the caller may change. Changing one in a shared space needs `Reports_Manage` as well.\n\nOperation ID: updateReportNotebook", "url": { "raw": "{{baseUrl}}/report-notebooks/:reportNotebookId", "host": [ "{{baseUrl}}" ], "path": [ "report-notebooks", ":reportNotebookId" ], "variable": [ { "key": "reportNotebookId", "value": "", "description": "(string)" } ] } } }, { "name": "Delete report notebook", "request": { "method": "DELETE", "description": "Delete a notebook the caller may change.\n\nOperation ID: deleteReportNotebook", "url": { "raw": "{{baseUrl}}/report-notebooks/:reportNotebookId", "host": [ "{{baseUrl}}" ], "path": [ "report-notebooks", ":reportNotebookId" ], "variable": [ { "key": "reportNotebookId", "value": "", "description": "(string)" } ] } } }, { "name": "Get report pin", "request": { "method": "GET", "description": "Return one of the caller's pins.\n\nOperation ID: getReportPin", "url": { "raw": "{{baseUrl}}/report-pins/:reportPinId", "host": [ "{{baseUrl}}" ], "path": [ "report-pins", ":reportPinId" ], "variable": [ { "key": "reportPinId", "value": "", "description": "(string)" } ] } } }, { "name": "List report pins", "request": { "method": "GET", "description": "Return the caller's pins in its order. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `q`, `page` and `endingBefore` are refused with 400.\n\nOperation ID: queryReportPins", "url": { "raw": "{{baseUrl}}/report-pins", "host": [ "{{baseUrl}}" ], "path": [ "report-pins" ] } } }, { "name": "Create report pins", "request": { "method": "POST", "description": "Pin a dashboard the caller can read.\n\nOperation ID: createReportPins", "url": { "raw": "{{baseUrl}}/report-pins", "host": [ "{{baseUrl}}" ], "path": [ "report-pins" ] } } }, { "name": "Update report pin", "request": { "method": "PATCH", "description": "Move a pin to another place in the caller's list.\n\nOperation ID: updateReportPin", "url": { "raw": "{{baseUrl}}/report-pins/:reportPinId", "host": [ "{{baseUrl}}" ], "path": [ "report-pins", ":reportPinId" ], "variable": [ { "key": "reportPinId", "value": "", "description": "(string)" } ] } } }, { "name": "Delete report pin", "request": { "method": "DELETE", "description": "Unpin a dashboard.\n\nOperation ID: deleteReportPin", "url": { "raw": "{{baseUrl}}/report-pins/:reportPinId", "host": [ "{{baseUrl}}" ], "path": [ "report-pins", ":reportPinId" ], "variable": [ { "key": "reportPinId", "value": "", "description": "(string)" } ] } } }, { "name": "Get report hidden dashboard", "request": { "method": "GET", "description": "Return one of the caller's hidden dashboards.\n\nOperation ID: getReportHiddenDashboard", "url": { "raw": "{{baseUrl}}/report-hidden-dashboards/:reportHiddenDashboardId", "host": [ "{{baseUrl}}" ], "path": [ "report-hidden-dashboards", ":reportHiddenDashboardId" ], "variable": [ { "key": "reportHiddenDashboardId", "value": "", "description": "(string)" } ] } } }, { "name": "List report hidden dashboards", "request": { "method": "GET", "description": "Return the dashboards the caller has hidden, oldest first. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `q`, `page` and `endingBefore` are refused with 400.\n\nOperation ID: queryReportHiddenDashboards", "url": { "raw": "{{baseUrl}}/report-hidden-dashboards", "host": [ "{{baseUrl}}" ], "path": [ "report-hidden-dashboards" ] } } }, { "name": "Create report hidden dashboards", "request": { "method": "POST", "description": "Hide a dashboard the caller can read.\n\nOperation ID: createReportHiddenDashboards", "url": { "raw": "{{baseUrl}}/report-hidden-dashboards", "host": [ "{{baseUrl}}" ], "path": [ "report-hidden-dashboards" ] } } }, { "name": "Delete report hidden dashboard", "request": { "method": "DELETE", "description": "Show a hidden dashboard again.\n\nOperation ID: deleteReportHiddenDashboard", "url": { "raw": "{{baseUrl}}/report-hidden-dashboards/:reportHiddenDashboardId", "host": [ "{{baseUrl}}" ], "path": [ "report-hidden-dashboards", ":reportHiddenDashboardId" ], "variable": [ { "key": "reportHiddenDashboardId", "value": "", "description": "(string)" } ] } } }, { "name": "Create report asks", "request": { "method": "POST", "description": "Ask the caller's reporting a question in words. An agent reads the datasets and asks the semantic layer as the caller, then proposes questions, a chart or a dashboard, which nothing saves. Answered as server-sent events: `progress`, then a `proposal` or an `error`, then `done`. Off for a tenant until it is opted in.\n\nOperation ID: createReportAsks", "url": { "raw": "{{baseUrl}}/report-asks", "host": [ "{{baseUrl}}" ], "path": [ "report-asks" ] } } }, { "name": "Get report conversation", "request": { "method": "GET", "description": "Return one of the caller's conversations with its messages, in order, to reopen it.\n\nOperation ID: getReportConversation", "url": { "raw": "{{baseUrl}}/report-conversations/:reportConversationId", "host": [ "{{baseUrl}}" ], "path": [ "report-conversations", ":reportConversationId" ], "variable": [ { "key": "reportConversationId", "value": "", "description": "(string)" } ] } } }, { "name": "List report conversations", "request": { "method": "GET", "description": "Return the caller's own conversations with Ask, most recently active first. A single Ask is never listed.\n\nOperation ID: queryReportConversations", "url": { "raw": "{{baseUrl}}/report-conversations", "host": [ "{{baseUrl}}" ], "path": [ "report-conversations" ] } } }, { "name": "Create report conversations", "request": { "method": "POST", "description": "Start a conversation with Ask with its first message. An agent reads the datasets and asks the semantic layer as the caller, then answers in words, proposes questions, a chart or a dashboard, which nothing saves, or asks a question back. Answered as server-sent events: `message`, `text` and `progress`, then a `proposal` or an `error`, then `done`. The conversation is the caller's alone. Off for a tenant until it is opted in.\n\nOperation ID: createReportConversations", "url": { "raw": "{{baseUrl}}/report-conversations", "host": [ "{{baseUrl}}" ], "path": [ "report-conversations" ] } } }, { "name": "Delete report conversation", "request": { "method": "DELETE", "description": "Delete one of the caller's conversations with its messages. A message being answered is stopped first.\n\nOperation ID: deleteReportConversation", "url": { "raw": "{{baseUrl}}/report-conversations/:reportConversationId", "host": [ "{{baseUrl}}" ], "path": [ "report-conversations", ":reportConversationId" ], "variable": [ { "key": "reportConversationId", "value": "", "description": "(string)" } ] } } }, { "name": "Create report conversation messages", "request": { "method": "POST", "description": "Send a message to one of the caller's conversations, answered with the conversation so far as its context, as server-sent events as the first message is. One message is answered at a time: a message sent while another is answered is refused with 409, and so is one to a conversation that has used all it may.\n\nOperation ID: createReportConversationMessages", "url": { "raw": "{{baseUrl}}/report-conversations/:reportConversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "report-conversations", ":reportConversationId", "messages" ], "variable": [ { "key": "reportConversationId", "value": "", "description": "(string)" } ] } } }, { "name": "Get export", "request": { "method": "GET", "description": "Return one of your exports, with a fresh link to its file once it is done.\n\nOperation ID: getExport", "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "key": "exportId", "value": "", "description": "(string)" } ] } } }, { "name": "List exports", "request": { "method": "GET", "description": "Return your exports, newest first, with no links: read one to sign a link to its file.\n\nOperation ID: queryExports", "url": { "raw": "{{baseUrl}}/exports", "host": [ "{{baseUrl}}" ], "path": [ "exports" ] } } }, { "name": "Create exports", "request": { "method": "POST", "description": "Export what a source reads: the file itself when it is small, otherwise an export that writes it.\n\nOperation ID: createExports", "url": { "raw": "{{baseUrl}}/exports", "host": [ "{{baseUrl}}" ], "path": [ "exports" ] } } }, { "name": "Update export", "request": { "method": "PATCH", "description": "Cancel one of your exports while it is queued or being written, or retry one that failed or whose file has expired. A cancel answers the export as it now is; a retry answers the new export.\n\nOperation ID: updateExport", "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "key": "exportId", "value": "", "description": "(string)" } ] } } }, { "name": "Delete export", "request": { "method": "DELETE", "description": "Delete one of your exports once it has finished: its file is removed at once.\n\nOperation ID: deleteExport", "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "key": "exportId", "value": "", "description": "(string)" } ] } } }, { "name": "Create reports", "request": { "method": "POST", "description": "Run a report. The answer is the report, nothing is stored, so keep it. Each report is authorised as the collection it reports on is.\n\nOperation ID: createReports", "url": { "raw": "{{baseUrl}}/reports", "host": [ "{{baseUrl}}" ], "path": [ "reports" ] } } } ] }, { "name": "Settlement", "item": [ { "name": "Get merchant invoice", "request": { "method": "GET", "description": "Return one invoice, with its lines and billing details.\n\nOperation ID: getMerchantInvoice", "url": { "raw": "{{baseUrl}}/merchant-invoices/:merchantInvoiceId", "host": [ "{{baseUrl}}" ], "path": [ "merchant-invoices", ":merchantInvoiceId" ], "variable": [ { "key": "merchantInvoiceId", "value": "", "description": "(string)" } ] } } }, { "name": "List merchant invoices", "request": { "method": "GET", "description": "Return a page of invoices. Filter by `invoiceReference` to find the one printed on a paper invoice, or by the two date pairs, issued, or falling due. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/merchant-invoices` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: queryMerchantInvoices", "url": { "raw": "{{baseUrl}}/merchant-invoices", "host": [ "{{baseUrl}}" ], "path": [ "merchant-invoices" ] } } }, { "name": "Create merchant invoices", "request": { "method": "POST", "description": "Raise an invoice over a period for the credential's own merchant. The category decides which of its ledgers is billed.\n\nOperation ID: createMerchantInvoices", "url": { "raw": "{{baseUrl}}/merchant-invoices", "host": [ "{{baseUrl}}" ], "path": [ "merchant-invoices" ] } } }, { "name": "Update merchant invoice", "request": { "method": "PATCH", "description": "Record an out-of-band payment, resend the invoice by email, or push it through a billing run. Selected by the body's `type`.\n\nOperation ID: updateMerchantInvoice", "url": { "raw": "{{baseUrl}}/merchant-invoices/:merchantInvoiceId", "host": [ "{{baseUrl}}" ], "path": [ "merchant-invoices", ":merchantInvoiceId" ], "variable": [ { "key": "merchantInvoiceId", "value": "", "description": "(string)" } ] } } }, { "name": "List settlement entries", "request": { "method": "GET", "description": "Return a page of a merchant's settlement entries. A merchant is required, named by `merchantId`, a `payoutId` or the `Merchant-Id` header, and so is a period: `clearingFrom` and `clearingTo`, or `createdAfter` and `createdBefore`, or a `payoutId` in place of either. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/settlement-entries` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.\n\nOperation ID: querySettlementEntries", "url": { "raw": "{{baseUrl}}/settlement-entries", "host": [ "{{baseUrl}}" ], "path": [ "settlement-entries" ] } } }, { "name": "Create fee adjustments", "request": { "method": "POST", "description": "Recalculate platform fees over a window, as a dry run or for real. The response is the only record of the run.\n\nOperation ID: createFeeAdjustments", "url": { "raw": "{{baseUrl}}/fee-adjustments", "host": [ "{{baseUrl}}" ], "path": [ "fee-adjustments" ] } } } ] }, { "name": "Simulations", "item": [ { "name": "Create simulations", "request": { "method": "POST", "description": "Make the platform act as a card network or issuer would: authorise, clear, refund or dispute a card payment, replay an issuer message, or process the queued ones. Test environments only.\n\nOperation ID: createSimulations", "url": { "raw": "{{baseUrl}}/simulations", "host": [ "{{baseUrl}}" ], "path": [ "simulations" ] } } } ] } ] }