> ## Documentation Index > Fetch the complete documentation index at: https://help.awin.com/llms.txt > Use this file to discover all available pages before exploring further. # List payment settings > Returns a page of the payment settings on file for the publisher, one entry per payment currency and payment method, ordered by `paymentMethod` ascending then `paymentCurrency` ascending (both sorted as plain case-sensitive string comparisons), a stable order that holds across pages. Use it to check which accounts a publisher's payments are currently routed to. Read-only, with no side effects. The caller must belong to the publisher account and hold at least the Full Access role on it; otherwise the request is rejected with `403`. ## OpenAPI ````json GET /v1/publishers/{publisherId}/payment-settings { "openapi": "3.0.3", "info": { "title": "Awin Public API", "version": "0.1.0" }, "servers": [ { "url": "https://api.awin.com/public", "description": "Production" } ], "tags": [ { "name": "Advertisers", "description": "Endpoints for advertiser accounts." }, { "name": "Advertisers > Partnerships", "description": "Advertiser partnerships with publishers." }, { "name": "Advertisers > Tracking links", "description": "Advertiser tracking links." }, { "name": "Advertisers > Billing", "description": "Advertiser billing and prepayments." }, { "name": "Publishers", "description": "Endpoints for publisher accounts." }, { "name": "Publishers > Partnerships", "description": "Publisher partnerships with advertisers." }, { "name": "Publishers > Transactions", "description": "Publisher transactions." }, { "name": "Publishers > Payments", "description": "Publisher payments and payment details." } ], "paths": { "/v1/publishers/{publisherId}/payment-settings": { "x-awin-owner": "hqteamapollo", "parameters": [ { "$ref": "#/components/parameters/PublisherId" } ], "get": { "tags": [ "Publishers > Payments" ], "operationId": "listPublisherPaymentSettings", "x-awin-audience": "public", "summary": "List payment settings", "description": "Returns a page of the payment settings on file for the publisher, one entry per payment currency and payment method, ordered by `paymentMethod` ascending then `paymentCurrency` ascending (both sorted as plain case-sensitive string comparisons), a stable order that holds across pages. Use it to check which accounts a publisher's payments are currently routed to. Read-only, with no side effects. The caller must belong to the publisher account and hold at least the Full Access role on it; otherwise the request is rejected with `403`.", "x-awin-public-api-authorization": { "accountType": "publisher", "minRole": "userFullAccess" }, "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "responses": { "200": { "description": "A page of the publisher's payment settings. An empty `results` array means the publisher has no payment settings on file; this is not an error.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "results": { "type": "array", "description": "The payment settings in this page.", "items": { "$ref": "#/components/schemas/PaymentSettings" } } } } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "security": [ { "patBearer": [] } ] } } }, "components": { "parameters": { "PublisherId": { "name": "publisherId", "in": "path", "required": true, "description": "Identifier of the publisher account.", "schema": { "type": "string", "pattern": "^[0-9]+$", "example": "45678" } }, "Limit": { "name": "limit", "in": "query", "required": false, "description": "Maximum number of results to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25, "example": 25 } }, "Offset": { "name": "offset", "in": "query", "required": false, "description": "Number of results to skip. Offsets beyond 10000 are rejected with `400`.", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0, "example": 0 } } }, "schemas": { "PaginatedResult": { "type": "object", "description": "Envelope for an offset-paginated collection.", "required": [ "total", "offset", "limit", "results" ], "properties": { "total": { "type": "integer", "minimum": 0, "description": "Total number of results across all pages.", "example": 567 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of results skipped before this page.", "example": 200 }, "limit": { "type": "integer", "minimum": 1, "description": "Maximum number of results in this page.", "example": 50 }, "results": { "type": "array", "description": "The results in this page.", "items": {} } } }, "PaymentSettings": { "description": "Payment settings for one payment region and payment method recorded for a publisher. The concrete shape of `accountDetails` is determined by `paymentMethod`. New payment methods may be added without a new major version (APIG-4A.8); a consumer MUST treat an unrecognised `paymentMethod` as a non-fatal case to skip, not as an error.", "oneOf": [ { "$ref": "#/components/schemas/AchPaymentSettings" }, { "$ref": "#/components/schemas/BacsPaymentSettings" }, { "$ref": "#/components/schemas/DomesticBrlPaymentSettings" }, { "$ref": "#/components/schemas/DomesticMxnPaymentSettings" }, { "$ref": "#/components/schemas/DomesticIbanPaymentSettings" }, { "$ref": "#/components/schemas/SepaPaymentSettings" }, { "$ref": "#/components/schemas/InternationalWirePaymentSettings" } ], "discriminator": { "propertyName": "paymentMethod", "mapping": { "ACH": "#/components/schemas/AchPaymentSettings", "BACS": "#/components/schemas/BacsPaymentSettings", "DOMESTIC_BRL": "#/components/schemas/DomesticBrlPaymentSettings", "DOMESTIC_MXN": "#/components/schemas/DomesticMxnPaymentSettings", "DOMESTIC_CHF": "#/components/schemas/DomesticIbanPaymentSettings", "DOMESTIC_DKK": "#/components/schemas/DomesticIbanPaymentSettings", "DOMESTIC_NOK": "#/components/schemas/DomesticIbanPaymentSettings", "DOMESTIC_PLN": "#/components/schemas/DomesticIbanPaymentSettings", "DOMESTIC_SEK": "#/components/schemas/DomesticIbanPaymentSettings", "SEPA": "#/components/schemas/SepaPaymentSettings", "SEPA_FROM_BRL": "#/components/schemas/SepaPaymentSettings", "SEPA_FROM_MXN": "#/components/schemas/SepaPaymentSettings", "INTERNATIONAL_WIRE": "#/components/schemas/InternationalWirePaymentSettings" } } }, "AchPaymentSettings": { "allOf": [ { "$ref": "#/components/schemas/PaymentSettingsIdentity" }, { "type": "object", "additionalProperties": false, "properties": { "paymentCurrency": { "$ref": "#/components/schemas/paymentCurrency" }, "paymentFrequency": { "$ref": "#/components/schemas/paymentFrequency" }, "paymentThreshold": { "$ref": "#/components/schemas/paymentThreshold" }, "paymentMethod": { "type": "string", "enum": [ "ACH" ], "description": "Discriminator identifying this as an ACH payment settings entry." }, "accountDetails": { "$ref": "#/components/schemas/AchAccountDetails" } }, "required": [ "paymentMethod", "accountDetails" ] } ] }, "BacsPaymentSettings": { "allOf": [ { "$ref": "#/components/schemas/PaymentSettingsIdentity" }, { "type": "object", "additionalProperties": false, "properties": { "paymentCurrency": { "$ref": "#/components/schemas/paymentCurrency" }, "paymentFrequency": { "$ref": "#/components/schemas/paymentFrequency" }, "paymentThreshold": { "$ref": "#/components/schemas/paymentThreshold" }, "paymentMethod": { "type": "string", "enum": [ "BACS" ], "description": "Discriminator identifying this as a BACS payment settings entry." }, "accountDetails": { "$ref": "#/components/schemas/BacsAccountDetails" } }, "required": [ "paymentMethod", "accountDetails" ] } ] }, "DomesticBrlPaymentSettings": { "allOf": [ { "$ref": "#/components/schemas/PaymentSettingsIdentity" }, { "type": "object", "additionalProperties": false, "properties": { "paymentCurrency": { "$ref": "#/components/schemas/paymentCurrency" }, "paymentFrequency": { "$ref": "#/components/schemas/paymentFrequency" }, "paymentThreshold": { "$ref": "#/components/schemas/paymentThreshold" }, "paymentMethod": { "type": "string", "enum": [ "DOMESTIC_BRL" ], "description": "Discriminator identifying this as a domestic Brazilian real (BRL) payment settings entry." }, "accountDetails": { "$ref": "#/components/schemas/DomesticBrlAccountDetails" } }, "required": [ "paymentMethod", "accountDetails" ] } ] }, "DomesticMxnPaymentSettings": { "allOf": [ { "$ref": "#/components/schemas/PaymentSettingsIdentity" }, { "type": "object", "additionalProperties": false, "properties": { "paymentCurrency": { "$ref": "#/components/schemas/paymentCurrency" }, "paymentFrequency": { "$ref": "#/components/schemas/paymentFrequency" }, "paymentThreshold": { "$ref": "#/components/schemas/paymentThreshold" }, "paymentMethod": { "type": "string", "enum": [ "DOMESTIC_MXN" ], "description": "Discriminator identifying this as a domestic Mexican peso (MXN) payment settings entry." }, "accountDetails": { "$ref": "#/components/schemas/DomesticMxnAccountDetails" } }, "required": [ "paymentMethod", "accountDetails" ] } ] }, "DomesticIbanPaymentSettings": { "allOf": [ { "$ref": "#/components/schemas/PaymentSettingsIdentity" }, { "type": "object", "additionalProperties": false, "properties": { "paymentCurrency": { "$ref": "#/components/schemas/paymentCurrency" }, "paymentFrequency": { "$ref": "#/components/schemas/paymentFrequency" }, "paymentThreshold": { "$ref": "#/components/schemas/paymentThreshold" }, "paymentMethod": { "type": "string", "description": "Discriminator identifying this as a domestic IBAN payment settings entry, one value per settlement currency.", "enum": [ "DOMESTIC_CHF", "DOMESTIC_DKK", "DOMESTIC_NOK", "DOMESTIC_PLN", "DOMESTIC_SEK" ] }, "accountDetails": { "$ref": "#/components/schemas/DomesticIbanAccountDetails" } }, "required": [ "paymentMethod", "accountDetails" ] } ] }, "SepaPaymentSettings": { "allOf": [ { "$ref": "#/components/schemas/PaymentSettingsIdentity" }, { "type": "object", "additionalProperties": false, "properties": { "paymentCurrency": { "$ref": "#/components/schemas/paymentCurrency" }, "paymentFrequency": { "$ref": "#/components/schemas/paymentFrequency" }, "paymentThreshold": { "$ref": "#/components/schemas/paymentThreshold" }, "paymentMethod": { "type": "string", "description": "Discriminator identifying this as a SEPA payment settings entry, including SEPA payments converted from BRL or MXN.", "enum": [ "SEPA", "SEPA_FROM_BRL", "SEPA_FROM_MXN" ] }, "accountDetails": { "$ref": "#/components/schemas/SepaAccountDetails" } }, "required": [ "paymentMethod", "accountDetails" ] } ] }, "InternationalWirePaymentSettings": { "allOf": [ { "$ref": "#/components/schemas/PaymentSettingsIdentity" }, { "type": "object", "additionalProperties": false, "properties": { "paymentCurrency": { "$ref": "#/components/schemas/paymentCurrency" }, "paymentFrequency": { "$ref": "#/components/schemas/paymentFrequency" }, "paymentThreshold": { "$ref": "#/components/schemas/paymentThreshold" }, "paymentMethod": { "type": "string", "enum": [ "INTERNATIONAL_WIRE" ], "description": "Discriminator identifying this as an international wire payment settings entry." }, "accountDetails": { "$ref": "#/components/schemas/InternationalWireAccountDetails" } }, "required": [ "paymentMethod", "accountDetails" ] } ] }, "ValidationProblem": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "type": "object", "description": "A problem detail carrying the RFC 9457 extension member `errors`, used where a request fails validation on one or more specific fields.", "properties": { "errors": { "type": "array", "description": "One entry per field that failed validation.", "items": { "type": "object", "required": [ "pointer", "detail" ], "properties": { "pointer": { "type": "string", "description": "An [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901) JSON Pointer to the offending field in the request.", "example": "/name" }, "detail": { "type": "string", "description": "A human-readable explanation of this field's failure.", "example": "must be 100 characters or fewer" } } } } } } ] }, "Problem": { "type": "object", "description": "Problem details for an HTTP API error, as defined by [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). Served as `application/problem+json`.", "required": [ "title", "status", "detail", "code" ], "properties": { "type": { "type": "string", "format": "uri-reference", "default": "https://help.awin.com/apis/error", "description": "A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.", "example": "https://help.awin.com/apis/error" }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.", "example": "Not Found" }, "status": { "type": "integer", "description": "The HTTP status code, repeated here for convenience.", "example": 404 }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.", "example": "Resource not found with that ID" }, "instance": { "type": "string", "format": "uri-reference", "description": "A URI reference identifying this specific occurrence, typically the request path.", "example": "/v1/advertisers/12345/prepayments" }, "code": { "type": "string", "description": "A stable, machine-readable error code. It does not change when `detail` is reworded, so clients branch on `code`, never on `detail`.", "enum": [ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ], "example": "NOT_FOUND" } } }, "PaymentSettingsIdentity": { "type": "object", "description": "Fields common to every payment settings entry, regardless of payment method.", "required": [ "paymentCurrency" ], "properties": { "paymentCurrency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code this entry applies to.", "example": "EUR" }, "paymentFrequency": { "allOf": [ { "$ref": "#/components/schemas/PaymentFrequency" } ], "description": "How often payments are issued to the publisher for this payment method. Omitted if not set for this entry." }, "paymentThreshold": { "allOf": [ { "$ref": "#/components/schemas/Money" } ], "description": "Minimum balance that must accrue before a payment is issued for this payment method. Omitted if not set for this entry." }, "paymentMethod": { "type": "string", "description": "Payment method used for this payment settings entry." }, "accountDetails": { "type": "object", "description": "Account details specific to the payment method." } }, "additionalProperties": false }, "paymentCurrency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code this entry applies to.", "example": "EUR" }, "paymentFrequency": { "allOf": [ { "$ref": "#/components/schemas/PaymentFrequency" } ], "description": "How often payments are issued to the publisher for this payment method. Omitted if not set for this entry." }, "paymentThreshold": { "allOf": [ { "$ref": "#/components/schemas/Money" } ], "description": "Minimum balance that must accrue before a payment is issued for this payment method. Omitted if not set for this entry." }, "AchAccountDetails": { "type": "object", "additionalProperties": false, "description": "Account details for ACH bank transfers.", "required": [ "accountNumberLast4", "abaNumber" ], "properties": { "accountHolder": { "$ref": "#/components/schemas/AccountHolder" }, "accountNumberLast4": { "type": "string", "pattern": "^[0-9]{4}$", "description": "Last four digits of the bank account number. The full number is not returned; it is not needed to identify which account payments are routed to.", "example": "6789" }, "abaNumber": { "type": "string", "pattern": "^[0-9]{9}$", "description": "ABA routing number of the bank.", "example": "021000021" } } }, "BacsAccountDetails": { "type": "object", "additionalProperties": false, "description": "Account details for BACS bank transfers.", "required": [ "sortCode", "accountNumberLast4" ], "properties": { "accountHolder": { "$ref": "#/components/schemas/AccountHolder" }, "sortCode": { "type": "string", "pattern": "^[0-9]{6}$", "description": "UK bank sort code.", "example": "200415" }, "accountNumberLast4": { "type": "string", "pattern": "^[0-9]{4}$", "description": "Last four digits of the bank account number. The full number is not returned; it is not needed to identify which account payments are routed to.", "example": "6789" }, "bankName": { "type": "string", "description": "Name of the bank. Omitted if not recorded.", "example": "Example Bank plc" } } }, "DomesticBrlAccountDetails": { "type": "object", "additionalProperties": false, "description": "Account details for domestic Brazilian real (BRL) payments.", "required": [ "destinationCountry", "destinationCurrency", "accountNumberLast4", "bankName", "routingNumber" ], "properties": { "accountHolder": { "$ref": "#/components/schemas/AccountHolder" }, "destinationCountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 code of the country the funds are sent to.", "example": "BR" }, "destinationCurrency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code of the destination account.", "example": "BRL" }, "accountNumberLast4": { "type": "string", "pattern": "^[0-9]{4}$", "description": "Last four digits of the bank account number. The full number is not returned; it is not needed to identify which account payments are routed to.", "example": "6789" }, "bankName": { "type": "string", "description": "Name of the bank.", "example": "Banco Example S.A." }, "routingNumber": { "type": "string", "description": "Bank routing number.", "example": "001" }, "accountHolderTaxNumberType": { "allOf": [ { "$ref": "#/components/schemas/BrlAccountHolderTaxNumberType" } ], "description": "Type of tax identifier held for the account holder. The tax number itself is not returned. Omitted if not recorded." }, "bicOrSwiftCode": { "type": "string", "pattern": "^[A-Z0-9]{8}([A-Z0-9]{3})?$", "description": "BIC or SWIFT code of the bank. Omitted if not recorded.", "example": "BRASBRSP" } } }, "DomesticMxnAccountDetails": { "type": "object", "additionalProperties": false, "description": "Account details for domestic Mexican peso (MXN) payments.", "required": [ "destinationCountry", "destinationCurrency", "bankName", "accountNumberLast4" ], "properties": { "accountHolder": { "$ref": "#/components/schemas/AccountHolder" }, "destinationCountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 code of the country the funds are sent to.", "example": "MX" }, "destinationCurrency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code of the destination account.", "example": "MXN" }, "bankName": { "type": "string", "description": "Name of the bank.", "example": "Banco Example, S.A." }, "accountNumberLast4": { "type": "string", "pattern": "^[0-9]{4}$", "description": "Last four digits of the bank account number (CLABE). The full number is not returned; it is not needed to identify which account payments are routed to.", "example": "6789" }, "accountHolderTaxNumberType": { "allOf": [ { "$ref": "#/components/schemas/MxnAccountHolderTaxNumberType" } ], "description": "Type of tax identifier held for the account holder. The tax number itself is not returned. Omitted if not recorded." } } }, "DomesticIbanAccountDetails": { "type": "object", "additionalProperties": false, "description": "Account details for domestic IBAN payments (CHF, DKK, NOK, PLN, SEK).", "required": [ "destinationCountry", "destinationCurrency", "ibanLast4" ], "properties": { "accountHolder": { "$ref": "#/components/schemas/AccountHolder" }, "destinationCountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 code of the country the funds are sent to.", "example": "SE" }, "destinationCurrency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code of the destination account.", "example": "SEK" }, "ibanLast4": { "type": "string", "pattern": "^[A-Z0-9]{4}$", "description": "Last four characters of the IBAN of the destination account. The full IBAN is not returned; it is not needed to identify which account payments are routed to.", "example": "6789" }, "bicOrSwiftCode": { "type": "string", "pattern": "^[A-Z0-9]{8}([A-Z0-9]{3})?$", "description": "BIC or SWIFT code of the bank. Omitted if not recorded.", "example": "NDEASESS" } } }, "SepaAccountDetails": { "type": "object", "additionalProperties": false, "description": "Account details for SEPA payments.", "required": [ "destinationCountry", "destinationCurrency", "ibanLast4" ], "properties": { "accountHolder": { "$ref": "#/components/schemas/AccountHolder" }, "destinationCountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 code of the country the funds are sent to.", "example": "DE" }, "destinationCurrency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code of the destination account.", "example": "EUR" }, "ibanLast4": { "type": "string", "pattern": "^[A-Z0-9]{4}$", "description": "Last four characters of the IBAN of the destination account. The full IBAN is not returned; it is not needed to identify which account payments are routed to.", "example": "6789" }, "bicOrSwiftCode": { "type": "string", "pattern": "^[A-Z0-9]{8}([A-Z0-9]{3})?$", "description": "BIC or SWIFT code of the bank. Omitted if not recorded.", "example": "DEUTDEFF" } } }, "InternationalWireAccountDetails": { "type": "object", "additionalProperties": false, "description": "Account details for international wire payments. The account holder name is not returned for this payment method.", "required": [ "destinationCountry", "destinationCurrency" ], "properties": { "destinationCountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 code of the country the funds are sent to.", "example": "US" }, "destinationCurrency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code of the destination account.", "example": "USD" }, "paymentProvider": { "$ref": "#/components/schemas/PaymentProvider" } } }, "PaymentFrequency": { "type": "string", "description": "How often payments are issued to a publisher.", "enum": [ "MONTHLY", "TWICE_MONTHLY" ] }, "Money": { "type": "object", "description": "A monetary value: a decimal amount paired with its currency. MUST NOT carry any other property; a resource with several monetary values holds one `Money` per role, named by the role.", "additionalProperties": false, "required": [ "amount", "currency" ], "properties": { "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$", "description": "Decimal string amount. Transported as a string, not a number, since floating point cannot represent decimal currency values exactly.", "example": "125.50" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code, uppercase.", "example": "GBP" } } }, "AccountHolder": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Name of the bank account holder, returned so the publisher can confirm which account their payments are routed to. Omitted if not recorded or blank.", "example": "Andrea Smith" }, "BrlAccountHolderTaxNumberType": { "type": "string", "description": "Type of Brazilian tax identifier held for the account holder: CPF for an individual, CNPJ for a company.", "enum": [ "CPF", "CNPJ" ], "example": "CPF" }, "MxnAccountHolderTaxNumberType": { "type": "string", "description": "Type of Mexican tax identifier held for the account holder.", "enum": [ "RFC" ], "example": "RFC" }, "PaymentProvider": { "type": "string", "description": "The named third-party payment provider used to process an international wire payment. Omitted when the publisher is paid through Awin's standard payment process rather than a named third-party provider.", "enum": [ "PAYONEER" ], "example": "PAYONEER" } }, "headers": { "RateLimitLimit": { "description": "Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 1, "example": 5 } }, "RateLimitRemaining": { "description": "Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "RateLimitReset": { "description": "Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 1 } }, "RetryAfter": { "description": "Number of seconds to wait before retrying the request.", "required": true, "schema": { "type": "integer", "minimum": 0, "example": 1 } } }, "responses": { "BadRequest": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Bad Request", "status": 400, "detail": "Required parameters are missing from the request", "code": "VALIDATION_FAILED", "errors": [ { "pointer": "/name", "detail": "must be 100 characters or fewer" } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "Unauthorized": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Unauthorized", "status": 401, "detail": "No valid credentials were supplied with the request", "code": "UNAUTHORIZED" } } } }, "Forbidden": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Forbidden", "status": 403, "detail": "You do not have the correct privileges to access this resource", "code": "FORBIDDEN" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "TooManyRequests": { "description": "Too Many Requests", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "userRateLimitExceeded": { "value": { "type": "https://help.awin.com/apis/error", "title": "User rate limit exceeded", "status": 429, "detail": "You have exceeded your rate limit across the public API. Retry after the number of seconds in the Retry-After header", "code": "USER_RATE_LIMIT_EXCEEDED" } }, "routeRateLimitExceeded": { "value": { "type": "https://help.awin.com/apis/error", "title": "Route rate limit exceeded", "status": 429, "detail": "This endpoint is receiving more requests than it can accept right now. Retry after the number of seconds in the Retry-After header", "code": "ROUTE_RATE_LIMIT_EXCEEDED" } }, "tooManyRequests": { "value": { "type": "https://help.awin.com/apis/error", "title": "Too Many Requests", "status": 429, "detail": "Rate limit exceeded", "code": "TOO_MANY_REQUESTS" } } } } } }, "ServiceUnavailable": { "description": "Service Unavailable", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Service Unavailable", "status": 503, "detail": "The service is temporarily unavailable", "code": "SERVICE_UNAVAILABLE" } } } }, "UnexpectedError": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred", "code": "INTERNAL_ERROR" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } } }, "securitySchemes": { "patBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Personal Access Token, sent as `Authorization: Bearer `." } } } } ````