openapi: 3.2.0 info: title: Gr4vy Merchant Accounts API version: '1.0' description: 'Operations tagged Merchant Accounts across 2 of this provider''s published API definitions: gr4vy-docs-v1-openapi.json, gr4vy-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: https://api.sandbox.{id}.gr4vy.app x-speakeasy-server-id: sandbox variables: id: default: example description: The subdomain for your Gr4vy instance. - url: https://api.{id}.gr4vy.app x-speakeasy-server-id: production variables: id: default: example description: The subdomain for your Gr4vy instance. tags: - name: Merchant Accounts description: 'In Gr4vy, a merchant account represents an individual merchant in an instance. Each instance has one or more merchant accounts, and each merchant account has its own connections, Flow rules, transactions, and more.' paths: /merchant-accounts: get: operationId: list-merchant-accounts summary: List merchant accounts description: Lists all merchant accounts in an instance. tags: - Merchant Accounts responses: '200': description: Returns a paginated list of merchant accounts. content: application/json: schema: $ref: '#/components/schemas/MerchantAccounts' '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' security: - bearerAuth: [] post: operationId: new-merchant-account summary: New merchant account description: 'Create a merchant account. Optionally, provide an `outbound_webhook_url`, and if HTTP Basic Authentication is required, provide the `outbound_webhook_username` and `outbound_webhook_password`. When retrieving a Merchant Account the `outbound_webhook_password` will be omitted. Optionally provide Network Tokens configuration per scheme. If done, all parameters for the same scheme must be provided.' tags: - Merchant Accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/MerchantAccountCreate' examples: Create a merchant account: value: id: plantly-uk display_name: Plantly UK outbound_webhook_url: https://www.example.com/webhook outbound_webhook_username: gr4vy outbound_webhook_password: super-secret-password visa_network_tokens_requestor_id: e50fa0da-903d-4d54-aacc-4cac57d48df2 visa_network_tokens_app_id: ca12b3d0-4e23-41a9-906f-e5cbb8e6a731 responses: '201': description: Returns the created merchant account. content: application/json: schema: $ref: '#/components/schemas/MerchantAccount' examples: Merchant Account: value: type: merchant-account id: plantly-uk display_name: Plantly UK outbound_webhook_url: https://www.example.com/webhook outbound_webhook_username: gr4vy visa_network_tokens_requestor_id: e50fa0da-903d-4d54-aacc-4cac57d48df2 visa_network_tokens_app_id: ca12b3d0-4e23-41a9-906f-e5cbb8e6a731 created_at: '2022-02-01T14:20:00.000+00:00' updated_at: '2022-02-01T14:20:00.000+00:00' '400': description: Returns an error if the request was badly formatted, missing required fields or configuration doesn't meet uniqueness conditions. content: application/json: schema: $ref: '#/components/schemas/Error400BadRequest' '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' '409': description: Returns an error if duplicate resource has been found. content: application/json: schema: $ref: '#/components/schemas/Error409DuplicateRecord' security: - bearerAuth: [] servers: - url: https://api.sandbox.{id}.gr4vy.app x-speakeasy-server-id: sandbox variables: id: default: example description: The subdomain for your Gr4vy instance. - url: https://api.{id}.gr4vy.app x-speakeasy-server-id: production variables: id: default: example description: The subdomain for your Gr4vy instance. /merchant-accounts/{merchant_account_id}: parameters: - schema: type: string example: plantly-uk name: merchant_account_id in: path required: true description: The unique ID for a merchant account. get: operationId: get-merchant-account summary: Get merchant account description: Retrieves details of a merchant account. tags: - Merchant Accounts responses: '200': description: Returns a merchant account. content: application/json: schema: $ref: '#/components/schemas/MerchantAccount' '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' '404': description: Returns an error if the resource can not be found. content: application/json: schema: $ref: '#/components/schemas/Error404NotFound' security: - bearerAuth: [] put: operationId: update-merchant-account summary: Update merchant account description: 'Update an existing merchant account. Optionally, provide an `outbound_webhook_url`, and if HTTP Basic Authentication is required, provide the `outbound_webhook_username` and `outbound_webhook_password`. When retrieving a Merchant Account the `outbound_webhook_password` will be omitted. Optionally provide Network Tokens configuration per scheme. If done, all parameters for the same scheme must be provided.' tags: - Merchant Accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/MerchantAccountUpdate' examples: Update a merchant account: value: display_name: Plantly UK outbound_webhook_url: https://www.example.com/webhook outbound_webhook_username: gr4vy outbound_webhook_password: super-secret-password visa_network_tokens_requestor_id: e50fa0da-903d-4d54-aacc-4cac57d48df2 visa_network_tokens_app_id: ca12b3d0-4e23-41a9-906f-e5cbb8e6a731 responses: '200': description: Returns the updated merchant account. content: application/json: schema: $ref: '#/components/schemas/MerchantAccount' '400': description: Returns an error if the request was badly formatted, missing required fields or configuration doesn't meet uniqueness conditions. content: application/json: schema: $ref: '#/components/schemas/Error400BadRequest' '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' '404': description: Returns an error if the resource can not be found. content: application/json: schema: $ref: '#/components/schemas/Error404NotFound' security: - bearerAuth: [] delete: operationId: delete-merchant-accuont summary: Delete merchant account description: Deletes a specific merchant account. tags: - Merchant Accounts responses: '204': description: Returns an empty response. '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' '404': description: Returns an error if the resource can not be found. content: application/json: schema: $ref: '#/components/schemas/Error404NotFound' security: - bearerAuth: [] servers: - url: https://api.sandbox.{id}.gr4vy.app x-speakeasy-server-id: sandbox variables: id: default: example description: The subdomain for your Gr4vy instance. - url: https://api.{id}.gr4vy.app x-speakeasy-server-id: production variables: id: default: example description: The subdomain for your Gr4vy instance. components: schemas: MerchantAccounts: title: Merchant Accounts type: object x-tags: - Merchant Accounts properties: items: type: array description: A list of merchant accounts. items: $ref: '#/components/schemas/MerchantAccount' limit: type: integer description: 'The limit applied to request. This represents the number of items that are at maximum returned by this request.' format: int32 minimum: 1 maximum: 100 example: 1 default: 20 next_cursor: type: - string - 'null' description: 'The cursor that represents the next page of results. Use the `cursor` query parameter to fetch this page of items.' example: ZXhhbXBsZTE minLength: 1 maxLength: 1000 previous_cursor: type: - string - 'null' description: 'The cursor that represents the next page of results. Use the `cursor` query parameter to fetch this page of items.' example: null minLength: 1 maxLength: 1000 MerchantAccountUpdate: title: Merchant Account (Update) type: object description: A request to update a merchant account. x-tags: - Merchant Accounts properties: display_name: type: string description: The human-readable name of the merchant account. example: Plantly UK minLength: 1 maxLength: 255 outbound_webhook_url: type: - string - 'null' description: The optional URL where webhooks will be received. example: https://www.example.com/webhook outbound_webhook_username: type: - string - 'null' description: 'The optional username to use when `outbound_webhook_url` is configured and requires basic authentication.' example: gr4vy outbound_webhook_password: type: - string - 'null' description: 'The optional password to use when `outbound_webhook_url` is configured and requires basic authentication.' example: super-secret-password visa_network_tokens_requestor_id: type: - string - 'null' description: 'Requestor ID provided for Visa after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 visa_network_tokens_app_id: type: - string - 'null' description: 'Application ID provided for Visa after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 amex_network_tokens_requestor_id: type: - string - 'null' description: 'Requestor ID provided for Amex after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 amex_network_tokens_app_id: type: - string - 'null' description: Application ID provided for Amex after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts. example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 mastercard_network_tokens_requestor_id: type: - string - 'null' description: 'Requestor ID provided for Mastercard after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 mastercard_network_tokens_app_id: type: - string - 'null' description: 'Application ID provided for Mastercard after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 loon_client_key: type: - string - 'null' minLength: 1 description: 'Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy. * If the field is not set, the Account Updater service configuration is not updated. * If the field is set to `null`, the Account Updater service is disabled. * If the field is set to `null`, the other `loon_*` fields must be set to `null` as well.' loon_secret_key: type: - string - 'null' minLength: 1 description: 'Secret key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy. * If the field is not set, the Account Updater service configuration is not updated. * If the field is set to `null`, the Account Updater service is disabled. * If the field is set to `null`, the other `loon_*` fields must be set to `null` as well.' loon_accepted_schemes: type: - array - 'null' items: type: string example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null description: 'Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service used by Gr4vy. * If the field is not set, the Account Updater service configuration is not updated. * If the field is set to `null`, the Account Updater service is disabled. * If the field is set to `null`, the other `loon_*` fields must be set to `null` as well.' over_capture_amount: type: - number - 'null' example: 1000 minimum: 1 maximum: 99999999 description: 'The maximum monetary amount allowed for over-capture, in the smallest currency unit, for example `1299` cents to allow for an over-capture of `$12.99`.' over_capture_percentage: type: - number - 'null' example: 20 minimum: 1 maximum: 99999999 description: 'The maximum percentage allowed for over-capture, for example `25` to allow for an over-capture of 25% of the original transaction amount.' account_updater_enabled: type: boolean example: true default: false description: 'Whether the Realtime Account Updater service is enabled for this merchant account. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `false`, the Account Updater service doesn''t get called if a payment fails with expired or invalid card details. * If the field is set to `true`, the service is called. Please note that for this to work the other `account_updater_*` fields must be set as well.' account_updater_request_encryption_key: type: - string - 'null' example: example-encryption-key description: 'The public key used to encrypt the request to the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_request_encryption_key_id: type: - string - 'null' example: example-encryption-key-id description: 'The public key ID used to encrypt the request to the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_response_decryption_key: type: - string - 'null' example: example-decryption-key description: 'The private key used to decrypt the response from the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_response_decryption_key_id: type: - string - 'null' example: example-decryption-key-id description: 'The private key ID used to decrypt the response from the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' Error404NotFound: title: Not Found Error type: object description: Not Found Error (HTTP 404). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: The reason code for the error. example: not_found enum: - not_found - pending_creation status: type: integer description: '`404`.' example: 404 enum: - 404 message: type: string description: The human readable reason for the error. example: The resource could not be found details: type: array description: 'A list of detail objects that further clarify the reason for the error. Not every error supports more detail.' example: [] items: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: title: Error details description: Additional detail about the part of a request body that caused an issue. type: object x-tags: - Errors properties: location: type: string example: body description: The location where the error caused an issue. enum: - query - body - path - header type: type: string example: value_error.missing description: A unique identifier for the type of error that occurred. pointer: type: string example: /payment_method/number description: 'The exact item for which the validation did not succeed. This is a JSON pointer for request bodies, while for query, path, and header parameters it is the name of the parameter.' message: type: string example: field required description: A human readable message for this error detail. Error409DuplicateRecord: title: Duplicate Record Error type: object description: Duplicate Record Error (HTTP 409). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: '`duplicate_record`.' example: duplicate_record enum: - duplicate_record status: type: integer description: '`409`.' example: 409 enum: - 409 message: type: string description: Further details on the field that triggered the error. example: A duplicate record exists with this external_identifier value details: type: array description: 'A list of detail objects that further clarify the reason for the error. Not every error supports more detail.' example: [] items: $ref: '#/components/schemas/ErrorDetail' Error401Unauthorized: title: Unauthorized Error type: object description: Unauthorized Error (HTTP 401). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: '`unauthorized`.' example: unauthorized enum: - unauthorized status: type: integer description: '`401`.' example: 401 enum: - 401 message: type: string description: No valid API authentication found. example: No valid API authentication found enum: - No valid API authentication found details: type: array description: 'A list of detail objects that further clarify the reason for the error. Not every error supports more detail.' example: [] items: $ref: '#/components/schemas/ErrorDetail' MerchantAccount: title: Merchant Account type: object x-tags: - Merchant Account properties: type: type: string description: '`merchant-account`.' example: merchant-account enum: - merchant-account id: type: string description: The ID for this merchant account. example: plantly-uk display_name: type: string description: The display name of this merchant account. example: Plantly UK outbound_webhook_url: type: - string - 'null' format: uri description: The optional URL where webhooks will be received. example: https://www.example.com/webhook outbound_webhook_username: type: - string - 'null' description: 'The optional username to use when `outbound_webhook_url` is configured and requires basic authentication.' example: gr4vy outbound_webhook_password: type: - string - 'null' description: 'The optional password to use when `outbound_webhook_url` is configured and requires basic authentication. If the field is not `null`, the value is masked to avoid exposing sensitive information.' example: '********' visa_network_tokens_requestor_id: type: - string - 'null' description: Requestor ID provided for Visa after onboarding to use Network Tokens. example: e50fa0da-903d-4d54-aacc-4cac57d48df2 visa_network_tokens_app_id: type: - string - 'null' description: 'Application ID provided for Visa after onboarding to use Network Tokens.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 amex_network_tokens_requestor_id: type: - string - 'null' description: Requestor ID provided for Amex after onboarding to use Network Tokens. example: e50fa0da-903d-4d54-aacc-4cac57d48df2 amex_network_tokens_app_id: type: - string - 'null' description: Application ID provided for Amex after onboarding to use Network Tokens. example: e50fa0da-903d-4d54-aacc-4cac57d48df2 mastercard_network_tokens_requestor_id: type: - string - 'null' description: 'Requestor ID provided for Mastercard after onboarding to use Network Tokens.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 mastercard_network_tokens_app_id: type: - string - 'null' description: 'Application ID provided for Mastercard after onboarding to use Network Tokens.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 loon_client_key: type: - string - 'null' description: 'Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy.' example: 7DD771287D0024BA418F8F7ECC7DF1CD loon_secret_key: type: - string - 'null' description: 'Secret key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy. If the field is not `null`, the value is masked to avoid exposing sensitive information.' example: '********' loon_accepted_schemes: type: - array - 'null' items: type: string example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null description: 'Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service used by Gr4vy.' example: - mastercard - visa account_updater_enabled: type: boolean example: true default: false description: 'Whether the Realtime Account Updater service is enabled for this merchant account. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `false`, the Account Updater service doesn''t get called if a payment fails with expired or invalid card details. * If the field is set to `true`, the service is called. Please note that for this to work the other `account_updater_*` fields must be set as well.' account_updater_request_encryption_key: type: - string - 'null' example: example-encryption-key description: 'The public key used to encrypt the request to the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_request_encryption_key_id: type: - string - 'null' example: example-encryption-key-id description: 'The public key ID used to encrypt the request to the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_response_decryption_key: type: - string - 'null' example: example-decryption-key description: 'The private key used to decrypt the response from the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_response_decryption_key_id: type: - string - 'null' example: example-decryption-key-id description: 'The private key ID used to decrypt the response from the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' created_at: type: string description: The date and time when this merchant account was created. format: date-time example: '2022-02-01T14:20:00.000+00:00' updated_at: type: string description: The date and time when this merchant account was updated. format: date-time example: '2022-02-01T14:20:00.000+00:00' over_capture_amount: type: - number - 'null' example: 1000 minimum: 1 maximum: 99999999 description: 'The maximum monetary amount allowed for over-capture, in the smallest currency unit, for example `1299` cents to allow for an over-capture of `$12.99`.' over_capture_percentage: type: - number - 'null' example: 20 minimum: 1 maximum: 99999999 description: 'The maximum percentage allowed for over-capture, for example `25` to allow for an over-capture of 25% of the original transaction amount.' Error400BadRequest: title: Bad Request type: object description: Bad Request (HTTP 400). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: A short code that describes the reason for the error. example: bad_request enum: - bad_request - incorrect_json - invalid_credentials status: type: integer description: '`400`.' example: 400 enum: - 400 message: type: string description: A human-readable reason for the error. example: Missing '****' field details: type: array description: A list of detail objects that further clarify the reason for the error. items: $ref: '#/components/schemas/ErrorDetail' MerchantAccountCreate: title: Merchant Account (Create) type: object description: A request to create a merchant account. x-tags: - Merchant Accounts properties: id: type: string description: The unique ID for the merchant account. example: plantly-uk minLength: 1 maxLength: 22 display_name: type: string description: The human-readable name of the merchant account. example: Plantly UK minLength: 1 maxLength: 255 outbound_webhook_url: type: - string - 'null' description: The optional URL where webhooks will be received. example: https://www.example.com/webhook outbound_webhook_username: type: - string - 'null' description: 'The optional username to use when `outbound_webhook_url` is configured and requires basic authentication.' example: gr4vy outbound_webhook_password: type: - string - 'null' description: 'The optional password to use when `outbound_webhook_url` is configured and requires basic authentication.' example: super-secret-password visa_network_tokens_requestor_id: type: - string - 'null' description: 'Requestor ID provided for Visa after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 visa_network_tokens_app_id: type: - string - 'null' description: 'Application ID provided for Visa after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 amex_network_tokens_requestor_id: type: - string - 'null' description: 'Requestor ID provided for Amex after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 amex_network_tokens_app_id: type: - string - 'null' description: Application ID provided for Amex after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts. example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 mastercard_network_tokens_requestor_id: type: - string - 'null' description: 'Requestor ID provided for Mastercard after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 mastercard_network_tokens_app_id: type: - string - 'null' description: 'Application ID provided for Mastercard after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.' example: e50fa0da-903d-4d54-aacc-4cac57d48df2 maxLength: 300 loon_client_key: type: - string - 'null' minLength: 1 description: 'Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get configured. * If the field is set to `null`, the other `loon_*` fields must be set to `null` as well.' loon_secret_key: type: - string - 'null' minLength: 1 description: 'Secret key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get configured. * If the field is set to `null`, the other `loon_*` fields must be set to `null` as well.' loon_accepted_schemes: type: - array - 'null' items: type: string example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null description: 'Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service used by Gr4vy. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get configured. * If the field is set to `null`, the other `loon_*` fields must be set to `null` as well.' over_capture_amount: type: - number - 'null' example: 1000 minimum: 1 maximum: 99999999 description: 'The maximum monetary amount allowed for over-capture, in the smallest currency unit, for example `1299` cents to allow for an over-capture of `$12.99`.' over_capture_percentage: type: - number - 'null' example: 20 minimum: 1 maximum: 99999999 description: 'The maximum percentage allowed for over-capture, for example `25` to allow for an over-capture of 25% of the original transaction amount.' account_updater_enabled: type: boolean example: true default: false description: 'Whether the Realtime Account Updater service is enabled for this merchant account. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `false`, the Account Updater service doesn''t get called if a payment fails with expired or invalid card details. * If the field is set to `true`, the service is called. Please note that for this to work the other `account_updater_*` fields must be set as well.' account_updater_request_encryption_key: type: - string - 'null' example: example-encryption-key description: 'The public key used to encrypt the request to the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_request_encryption_key_id: type: - string - 'null' example: example-encryption-key-id description: 'The public key ID used to encrypt the request to the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_response_decryption_key: type: - string - 'null' example: example-decryption-key description: 'The private key used to decrypt the response from the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' account_updater_response_decryption_key_id: type: - string - 'null' example: example-decryption-key-id description: 'The private key ID used to decrypt the response from the Realtime Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. * If the field is not set or if it''s set to `null`, the Account Updater service doesn''t get called. * If the field is set, the other `account_updater_*` fields must be set as well.' MerchantAccounts_2: properties: items: items: $ref: '#/components/schemas/MerchantAccount_2' type: array title: Items description: A list of items returned for this request. limit: type: integer maximum: 100.0 minimum: 1.0 title: Limit description: The number of items for this page. default: 20 examples: - 20 next_cursor: anyOf: - type: string maxLength: 1000 minLength: 1 - type: 'null' title: Next Cursor description: The cursor pointing at the next page of items. examples: - ZXhhbXBsZTE previous_cursor: anyOf: - type: string maxLength: 1000 minLength: 1 - type: 'null' title: Previous Cursor description: The cursor pointing at the previous page of items. examples: - Xkjss7asS additionalProperties: false type: object required: - items title: MerchantAccounts Error401: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `unauthorized` default: unauthorized examples: - unauthorized status: type: integer title: Status description: Always `401`. default: 401 examples: - 401 message: type: string title: Message description: A human readable message that provides more context to the error. default: No valid API authentication found examples: - No valid API authentication found details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error401 Error404: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `not_found` default: not_found examples: - not_found status: type: integer title: Status description: Always `404`. default: 404 examples: - 404 message: type: string title: Message description: A human readable message that provides more context to the error. default: The resource could not be found examples: - The resource could not be found details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error404 ErrorLocation: type: string enum: - query - body - path - header - unknown title: ErrorLocation Error425: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `too_early` default: too_early examples: - too_early status: type: integer title: Status description: Always `425`. default: 425 examples: - 425 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error425 MerchantAccountCreate_2: properties: account_updater_enabled: type: boolean title: Account Updater Enabled description: Whether the Real-Time Account Updater service is enabled for this merchant account. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `false`, the Account Updater service doesn't get called if a payment fails with expired or invalid card details. If the field is set to `true`, the service is called. Please note that for this to work the other `account_updater_* fields` must be set as well. default: false examples: - true account_updater_request_encryption_key: anyOf: - type: string - type: 'null' title: Account Updater Request Encryption Key description: The public key used to encrypt the request to the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-1234 account_updater_request_encryption_key_id: anyOf: - type: string - type: 'null' title: Account Updater Request Encryption Key Id description: The ID of the key used to encrypt the request to the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-id-1234 account_updater_response_decryption_key: anyOf: - type: string - type: 'null' title: Account Updater Response Decryption Key description: The key used to decrypt the response from the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-1234 account_updater_response_decryption_key_id: anyOf: - type: string - type: 'null' title: Account Updater Response Decryption Key Id description: The ID of the key used to decrypt the request from the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-id-1234 over_capture_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Over Capture Amount description: The maximum monetary amount allowed for over-capture, in the smallest currency unit, for example `1299` cents to allow for an over-capture of `$12.99`. examples: - 1299 over_capture_percentage: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Over Capture Percentage description: The maximum percentage allowed for over-capture, for example `25` to allow for an over-capture of `25%` of the original transaction amount. examples: - 25 loon_client_key: anyOf: - type: string - type: 'null' title: Loon Client Key description: Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. deprecated: true examples: - client-key-1234 loon_secret_key: anyOf: - type: string - type: 'null' title: Loon Secret Key description: Secret key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. deprecated: true examples: - key-12345 loon_accepted_schemes: anyOf: - items: $ref: '#/components/schemas/CardScheme' type: array uniqueItems: true - type: 'null' title: Loon Accepted Schemes description: Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. examples: - - visa loon_merchant_account_id: anyOf: - type: string - type: 'null' title: Loon Merchant Account Id description: Merchant account ID provided by Pagos to identify this merchant account on the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. examples: - loon-merchant-account-1234 visa_network_tokens_requestor_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Visa Network Tokens Requestor Id description: Requestor ID provided for Visa after onboarding to use Network Tokens. examples: - id-12345 visa_network_tokens_app_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Visa Network Tokens App Id description: Application ID provided for Visa after onboarding to use Network Tokens. examples: - id-12345 amex_network_tokens_requestor_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Amex Network Tokens Requestor Id description: Requestor ID provided for American Express after onboarding to use Network Tokens. examples: - id-12345 amex_network_tokens_app_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Amex Network Tokens App Id description: Application ID provided for American Express after onboarding to use Network Tokens. examples: - id-12345 mastercard_network_tokens_requestor_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Mastercard Network Tokens Requestor Id description: Requestor ID provided for Mastercard after onboarding to use Network Tokens. examples: - id-12345 mastercard_network_tokens_app_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Mastercard Network Tokens App Id description: Application ID provided for Mastercard after onboarding to use Network Tokens. examples: - id-12345 discover_network_tokens_requestor_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Discover Network Tokens Requestor Id description: Requestor ID provided for Discover after onboarding to use Network Tokens. examples: - id-12345 discover_network_tokens_app_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Discover Network Tokens App Id description: Application ID provided for Discover after onboarding to use Network Tokens. examples: - id-12345 async_network_tokens_enabled: type: boolean title: Async Network Tokens Enabled description: When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. default: false examples: - true - false id: type: string maxLength: 50 minLength: 1 pattern: ^[a-zA-Z0-9-]+$ title: Id description: The ID for the merchant account. examples: - merchant-12345 display_name: type: string maxLength: 255 minLength: 1 title: Display Name description: The display name for the merchant account. examples: - Example additionalProperties: false type: object required: - id - display_name title: MerchantAccountCreate HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ErrorDetail_2: properties: location: $ref: '#/components/schemas/ErrorLocation' description: The part of the request where the property can be found that caused the error. examples: - body pointer: anyOf: - type: string format: json-pointer - type: string title: Pointer description: A JSON pointer for the particular property that caused the error. examples: - /currency message: type: string title: Message description: A human-readdable explanation of the error. examples: - 'Unknown ISO 4217 currency code: USX' type: type: string title: Type description: The type of error that was raised for this property. examples: - value_error additionalProperties: false type: object required: - location - pointer - message - type title: ErrorDetail Error405: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `method_not_allowed` default: method_not_allowed examples: - method_not_allowed status: type: integer title: Status description: Always `405`. default: 405 examples: - 405 message: type: string title: Message description: A human readable message that provides more context to the error. default: Method Not Allowed examples: - Method Not Allowed details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error405 Error429: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `too_many_requests` default: too_many_requests examples: - too_many_requests status: type: integer title: Status description: Always `429`. default: 429 examples: - 429 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error429 Error500: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `server_error` default: server_error examples: - server_error status: type: integer title: Status description: Always `500`. default: 500 examples: - 500 message: type: string title: Message description: A human readable message that provides more context to the error. default: Request could not be processed examples: - Request could not be processed details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error500 MerchantAccountUpdate_2: properties: account_updater_enabled: type: boolean title: Account Updater Enabled description: Whether the Real-Time Account Updater service is enabled for this merchant account. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `false`, the Account Updater service doesn't get called if a payment fails with expired or invalid card details. If the field is set to `true`, the service is called. Please note that for this to work the other `account_updater_* fields` must be set as well. default: false examples: - true account_updater_request_encryption_key: anyOf: - type: string - type: 'null' title: Account Updater Request Encryption Key description: The public key used to encrypt the request to the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-1234 account_updater_request_encryption_key_id: anyOf: - type: string - type: 'null' title: Account Updater Request Encryption Key Id description: The ID of the key used to encrypt the request to the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-id-1234 account_updater_response_decryption_key: anyOf: - type: string - type: 'null' title: Account Updater Response Decryption Key description: The key used to decrypt the response from the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-1234 account_updater_response_decryption_key_id: anyOf: - type: string - type: 'null' title: Account Updater Response Decryption Key Id description: The ID of the key used to decrypt the request from the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-id-1234 over_capture_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Over Capture Amount description: The maximum monetary amount allowed for over-capture, in the smallest currency unit, for example `1299` cents to allow for an over-capture of `$12.99`. examples: - 1299 over_capture_percentage: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Over Capture Percentage description: The maximum percentage allowed for over-capture, for example `25` to allow for an over-capture of `25%` of the original transaction amount. examples: - 25 loon_client_key: anyOf: - type: string - type: 'null' title: Loon Client Key description: Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. deprecated: true examples: - client-key-1234 loon_secret_key: anyOf: - type: string - type: 'null' title: Loon Secret Key description: Secret key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. deprecated: true examples: - key-12345 loon_accepted_schemes: anyOf: - items: $ref: '#/components/schemas/CardScheme' type: array uniqueItems: true - type: 'null' title: Loon Accepted Schemes description: Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. examples: - - visa loon_merchant_account_id: anyOf: - type: string - type: 'null' title: Loon Merchant Account Id description: Merchant account ID provided by Pagos to identify this merchant account on the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. examples: - loon-merchant-account-1234 visa_network_tokens_requestor_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Visa Network Tokens Requestor Id description: Requestor ID provided for Visa after onboarding to use Network Tokens. examples: - id-12345 visa_network_tokens_app_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Visa Network Tokens App Id description: Application ID provided for Visa after onboarding to use Network Tokens. examples: - id-12345 amex_network_tokens_requestor_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Amex Network Tokens Requestor Id description: Requestor ID provided for American Express after onboarding to use Network Tokens. examples: - id-12345 amex_network_tokens_app_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Amex Network Tokens App Id description: Application ID provided for American Express after onboarding to use Network Tokens. examples: - id-12345 mastercard_network_tokens_requestor_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Mastercard Network Tokens Requestor Id description: Requestor ID provided for Mastercard after onboarding to use Network Tokens. examples: - id-12345 mastercard_network_tokens_app_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Mastercard Network Tokens App Id description: Application ID provided for Mastercard after onboarding to use Network Tokens. examples: - id-12345 discover_network_tokens_requestor_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Discover Network Tokens Requestor Id description: Requestor ID provided for Discover after onboarding to use Network Tokens. examples: - id-12345 discover_network_tokens_app_id: anyOf: - type: string maxLength: 300 minLength: 0 - type: 'null' title: Discover Network Tokens App Id description: Application ID provided for Discover after onboarding to use Network Tokens. examples: - id-12345 async_network_tokens_enabled: type: boolean title: Async Network Tokens Enabled description: When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. default: false examples: - true - false display_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Display Name description: The display name for the merchant account. examples: - Example additionalProperties: false type: object title: MerchantAccountUpdate Error504: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `gateway_timeout` default: gateway_timeout examples: - gateway_timeout status: type: integer title: Status default: 504 message: type: string title: Message description: A human readable message that provides more context to the error. default: Request could not be processed examples: - Request could not be processed details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error504 Error400: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `bad_request` default: bad_request examples: - bad_request status: type: integer title: Status description: Always `400`. default: 400 examples: - 400 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error400 ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError Error502: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `bad_gateway` default: bad_gateway examples: - bad_gateway status: type: integer title: Status description: Always `502`. default: 502 examples: - 502 message: type: string title: Message description: A human readable message that provides more context to the error. default: Request could not be processed examples: - Request could not be processed details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error502 Error409: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `duplicate_record` default: duplicate_record examples: - duplicate_record status: type: integer title: Status description: Always `409`. default: 409 examples: - 409 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] resource_id: anyOf: - type: string - type: 'null' title: Resource Id description: The ID of the conflicting resource. examples: - cdc70639-cb9c-4222-a73f-b8ce39f7821b additionalProperties: false type: object title: Error409 Error403: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `forbidden` default: forbidden examples: - forbidden status: type: integer title: Status description: Always `403`. default: 403 examples: - 403 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error403 CardScheme: type: string enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - qcard - rupay - star - uatp - unionpay - visa title: CardScheme MerchantAccount_2: properties: type: type: string const: merchant-account title: Type description: Always `merchant-account`. default: merchant-account examples: - merchant-account id: type: string maxLength: 50 minLength: 1 title: Id description: The ID for the merchant account. examples: - merchant-12345 display_name: type: string maxLength: 255 minLength: 1 title: Display Name description: The display name for the buyer. examples: - John Doe loon_client_key: anyOf: - type: string - type: 'null' title: Loon Client Key description: Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. deprecated: true examples: - client-key-1234 loon_secret_key: anyOf: - type: string - type: 'null' title: Loon Secret Key description: Secret key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. deprecated: true examples: - key-12345 loon_accepted_schemes: anyOf: - items: $ref: '#/components/schemas/CardScheme' type: array - type: 'null' title: Loon Accepted Schemes description: Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. examples: - - visa loon_merchant_account_id: anyOf: - type: string - type: 'null' title: Loon Merchant Account Id description: Merchant account ID provided by Pagos to identify this merchant account on the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to `null`, the other `loon_*` fields must be set to null as well. examples: - loon-merchant-account-1234 account_updater_request_encryption_key: anyOf: - type: string - type: 'null' title: Account Updater Request Encryption Key description: The public key used to encrypt the request to the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-1234 account_updater_request_encryption_key_id: anyOf: - type: string - type: 'null' title: Account Updater Request Encryption Key Id description: The ID of the key used to encrypt the request to the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-id-1234 account_updater_response_decryption_key: anyOf: - type: string - type: 'null' title: Account Updater Response Decryption Key description: The key used to decrypt the response from the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-1234 account_updater_response_decryption_key_id: anyOf: - type: string - type: 'null' title: Account Updater Response Decryption Key Id description: The ID of the key used to decrypt the request from the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `null`, the Account Updater service doesn't get called. If the field is set, the other `account_updater_*` fields must be set as well. deprecated: true examples: - key-id-1234 account_updater_enabled: type: boolean title: Account Updater Enabled description: Whether the Real-Time Account Updater service is enabled for this merchant account. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to `false`, the Account Updater service doesn't get called if a payment fails with expired or invalid card details. If the field is set to `true`, the service is called. Please note that for this to work the other `account_updater_* fields` must be set as well. examples: - true over_capture_amount: anyOf: - type: integer - type: 'null' title: Over Capture Amount description: The maximum monetary amount allowed for over-capture, in the smallest currency unit, for example `1299` cents to allow for an over-capture of `$12.99`. examples: - 1299 over_capture_percentage: anyOf: - type: integer - type: 'null' title: Over Capture Percentage description: The maximum percentage allowed for over-capture, for example `25` to allow for an over-capture of `25%` of the original transaction amount. examples: - 25 visa_network_tokens_requestor_id: anyOf: - type: string - type: 'null' title: Visa Network Tokens Requestor Id description: Requestor ID provided for Visa after onboarding to use Network Tokens. examples: - id-12345 visa_network_tokens_app_id: anyOf: - type: string - type: 'null' title: Visa Network Tokens App Id description: Application ID provided for Visa after onboarding to use Network Tokens. examples: - id-12345 amex_network_tokens_requestor_id: anyOf: - type: string - type: 'null' title: Amex Network Tokens Requestor Id description: Requestor ID provided for American Express after onboarding to use Network Tokens. examples: - id-12345 amex_network_tokens_app_id: anyOf: - type: string - type: 'null' title: Amex Network Tokens App Id description: Application ID provided for American Express after onboarding to use Network Tokens. examples: - id-12345 mastercard_network_tokens_requestor_id: anyOf: - type: string - type: 'null' title: Mastercard Network Tokens Requestor Id description: Requestor ID provided for Mastercard after onboarding to use Network Tokens. examples: - id-12345 mastercard_network_tokens_app_id: anyOf: - type: string - type: 'null' title: Mastercard Network Tokens App Id description: Application ID provided for Mastercard after onboarding to use Network Tokens. examples: - id-12345 discover_network_tokens_requestor_id: anyOf: - type: string - type: 'null' title: Discover Network Tokens Requestor Id description: Requestor ID provided for Discover after onboarding to use Network Tokens. examples: - id-12345 discover_network_tokens_app_id: anyOf: - type: string - type: 'null' title: Discover Network Tokens App Id description: Application ID provided for Discover after onboarding to use Network Tokens. examples: - id-12345 async_network_tokens_enabled: type: boolean title: Async Network Tokens Enabled description: When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. default: false examples: - true - false created_at: type: string format: date-time title: Created At description: The date this merchant account was created at. examples: - '2013-07-16T19:23:00.000+00:00' updated_at: type: string format: date-time title: Updated At description: The date this merchant account was last updated at. examples: - '2013-07-16T19:23:00.000+00:00' additionalProperties: false type: object required: - id - display_name - account_updater_enabled - created_at - updated_at title: MerchantAccount securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT OAuth2PasswordBearer: type: oauth2 flows: password: scopes: embed: Shorthand for all gr4vy embed related scopes sessions.refresh: Refresh access-token anti-fraud-service-definitions.read: Read Anti Fraud Service Definitions anti-fraud-services.read: Read Anti Fraud Services api-key-pairs.read: Read API Key Pairs api-logs.read: Read API Logs apple-pay-certificates.read: Read Apple Pay Certificates audit-logs.read: Read Audit Logs bin-checker.read: Read BIN Checker buyers.read: Read Buyers buyers.billing-details.read: Read Billing Details card-scheme-definitions.read: Read Card Scheme Definitions checkout-sessions.read: Read Checkout Sessions connections.read: Read Connections digital-wallets.read: Read Digital Wallets flows.read: Read Flows gift-card-service-definitions.read: Read Gift Card Service Definitions gift-card-services.read: Read Gift Card Services gift-cards.read: Read Gift Cards merchant-accounts.read: Read Merchant Accounts payment-links.read: Read Payment Links payment-method-definitions.read: Read Payment Method Definitions payment-methods.read: Read Payment Methods payment-options.read: Read Payment Options payment-service-definitions.read: Read Payment Service Definitions payment-services.read: Read Payment Service payouts.read: Read Payouts reports.read: Read Reports roles.read: Read Roles three-ds-scenarios.read: Read 3DS Scenarios transactions.read: Read Transactions users.me.read: Read User Profile vault-forward.read: Read Vault Forward vault-forward-authentications.read: Read Vault Forward Authentications vault-forward-configs.read: Read Vault Forward Configurations vault-forward-definitions.read: Read Vault Forward Definitions webhook-subscriptions.read: Read Webhook Subscriptions business-contexts.read: Read Business Contexts health-dashboard.read: Read Health Dashboard metrics-explorer.read: Read Metrics Explorer monitoring.read: Read Monitoring reset.read: Read Reset sessions.read: Read Sessions users.read: Read Users anti-fraud-service-definitions.write: Write Anti Fraud Service Definitions anti-fraud-services.write: Write Anti Fraud Services api-key-pairs.write: Write API Key Pairs api-logs.write: Write API Logs apple-pay-certificates.write: Write Apple Pay Certificates audit-logs.write: Write Audit Logs bin-checker.write: Write BIN Checker buyers.write: Write Buyers buyers.billing-details.write: Write Billing Details card-scheme-definitions.write: Write Card Scheme Definitions checkout-sessions.write: Write Checkout Sessions connections.write: Write Connections digital-wallets.write: Write Digital Wallets flows.write: Write Flows gift-card-service-definitions.write: Write Gift Card Service Definitions gift-card-services.write: Write Gift Card Services gift-cards.write: Write Gift Cards merchant-accounts.write: Write Merchant Accounts payment-links.write: Write Payment Links payment-method-definitions.write: Write Payment Method Definitions payment-methods.write: Write Payment Methods payment-options.write: Write Payment Options payment-service-definitions.write: Write Payment Service Definitions payment-services.write: Write Payment Service payouts.write: Write Payouts reports.write: Write Reports roles.write: Write Roles three-ds-scenarios.write: Write 3DS Scenarios transactions.write: Write Transactions users.me.write: Write User Profile vault-forward.write: Write Vault Forward vault-forward-authentications.write: Write Vault Forward Authentications vault-forward-configs.write: Write Vault Forward Configurations vault-forward-definitions.write: Write Vault Forward Definitions webhook-subscriptions.write: Write Webhook Subscriptions business-contexts.write: Write Business Contexts health-dashboard.write: Write Health Dashboard metrics-explorer.write: Write Metrics Explorer monitoring.write: Write Monitoring reset.write: Write Reset sessions.write: Write Sessions users.write: Write Users tokenUrl: auth/token x-refined-from: - gr4vy-docs-v1-openapi.json - gr4vy-openapi.json