--- api: 'Open Banking API' --- # Create an international payment consent Create an international payment consent described in the [Open Banking API documentation: Account and Transaction API Specification](https://openbanking.atlassian.net/wiki/spaces/DZ/pages/999622968/Account+and+Transaction+API+Specification+-+v3.1.1). Use international payments for international SWIFT payments in all currencies supported by Revolut. :::note Only the payments with `InstructedAmount` in the same currency as `CurrencyOfTransfer` are supported. However, users can select which account they want to be charged in the consent authorization UI even if the selected account is in a different currency. In such a case, the `ExchangeRateInformation` response field contains information about the `ExchangeRate` between `SourceCurrency` and `CurrencyOfTransfer`. If the user doesn't have enough funds on the selected account, the consent authorization is rejected. ::: :::note For international payment initiation consents, we recommend including the creditor's name and address. Otherwise, the API may return the error `Address is required for this beneficiary` if the address is not provided for international payments. ::: When you make the API call, ensure that you pass the corresponding JSON Web Signature (JWS) in the `x-jws-signature` request header. Note: - The JWS is generated from the request body with the [TPP](/docs/guides/build-banking-apps/glossary) signing key that is specified in the JWS header. - The JWS consists of a header and a signature in the `..` format. To see how to create a JWS, see the guide: [Work with JSON Web Signatures](/docs/guides/build-banking-apps/tutorials/work-with-json-web-signatures). See also [Tutorials: Initiate your first payment](/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment#2-create-a-domestic-payment-consent). ## Endpoint POST `/international-payment-consents` ## Parameters ### header parameters - `x-fapi-financial-id` (string, required) The unique ID of the [ASPSP](/docs/guides/build-banking-apps/glossary) that the request is issued to. The ID of Revolut is `001580000103UAvAAM`. - `x-fapi-customer-last-logged-time` (string, optional) The date and time when the [PSU](/docs/guides/build-banking-apps/glossary) last logged in with the [TPP](/docs/guides/build-banking-apps/glossary). All dates in the HTTP headers are represented as [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.1.1) Full Dates. For example: `Sun, 10 Sep 2017 19:43:31 UTC`. - `x-fapi-customer-ip-address` (string, optional) The IP address of the [PSU](/docs/guides/build-banking-apps/glossary) if the PSU is logged in with the [TPP](/docs/guides/build-banking-apps/glossary). - `x-fapi-interaction-id` (string, optional) An [RFC4122](https://datatracker.ietf.org/doc/html/rfc4122) UUID used as a correlation ID. - `Authorization` (string, required) The access token that you've generated. For more information, see [Generate an access token](/docs/guides/build-banking-apps/get-started/get-access-token). - `x-idempotency-key` (string, required) Each request is processed only once per `x-idempotency-key`. The idempotency key is valid for 24 hours. - `x-jws-signature` (string, required) A [detached JWS signature](/docs/guides/build-banking-apps/tutorials/work-with-json-web-signatures) of the body of the payload. - `x-customer-user-agent` (string, optional) The user agent that the [PSU](/docs/guides/build-banking-apps/glossary) is using. ## Request body ### Attributes - `Data` (object) - `Data.Initiation` (object) The initiation payload that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which is used to request movement of funds from the debtor account to the creditor for a single international payment. - `Data.Initiation.InstructionIdentification` (string) The unique ID that an instructing party assigns for an instructed party to unambiguously identify the instruction. This ID is used between the instructing party and the instructed party to refer to the individual instruction. It can be included in the messages related to the instruction. - `Data.Initiation.EndToEndIdentification` (string) The unique and immutable ID that the initiating party assigns to unambiguously identify the transaction. This ID is used for reconciliation or to link tasks related to the transaction. It can be included in the messages related to the transaction. :::note Faster Payments Scheme can access only 31 characters for the `EndToEndIdentification` field. ::: - `Data.Initiation.ChargeBearer` (enum, optional) The party or parties bear the charges associated with the processing of the payment transaction. Possible enum values: - `BorneByDebtor` - `FollowingServiceLevel` - `Data.Initiation.CurrencyOfTransfer` (string) The currency of the money to be transferred, which is different from the currency of the debtor's account. - `Data.Initiation.InstructedAmount` (object) The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency that the initiating party instructs. This amount has to be transported unchanged through the transaction chain. - `Data.Initiation.InstructedAmount.Amount` (string) The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `Data.Initiation.InstructedAmount.Currency` (string) - `Data.Initiation.ExchangeRateInformation` (object, optional) The details on the currency exchange rate and contract. - `Data.Initiation.ExchangeRateInformation.UnitCurrency` (string) The currency that the exchange rate is expressed in. For example, for 1 GBP = xxx EUR, the `UnitCurrency` value is GBP. - `Data.Initiation.ExchangeRateInformation.ExchangeRate` (number, optional) The exchange rate used to convert an amount from one currency into another. This reflects the price that one currency was bought at with another currency. - `Data.Initiation.ExchangeRateInformation.RateType` (enum) The type used to complete the currency exchange. Possible enum values: - `Actual` - `Agreed` - `Indicative` - `Data.Initiation.ExchangeRateInformation.ContractIdentification` (string, optional) The unique reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. - `Data.Initiation.Creditor` (object, optional) The party that an amount of money is due to. - `Data.Initiation.Creditor.Name` (string, optional) The name of a known party used to identify the party. - `Data.Initiation.Creditor.PostalAddress` (object, optional) The postal address of the creditor, as defined by postal services. - `Data.Initiation.Creditor.PostalAddress.Department` (string, optional) The name of the department. - `Data.Initiation.Creditor.PostalAddress.SubDepartment` (string, optional) The name of the sub-department. - `Data.Initiation.Creditor.PostalAddress.StreetName` (string, optional) The name of the street. - `Data.Initiation.Creditor.PostalAddress.BuildingNumber` (string, optional) The number of the building. - `Data.Initiation.Creditor.PostalAddress.PostCode` (string, optional) The post code of the address. - `Data.Initiation.Creditor.PostalAddress.TownName` (string, optional) The name of the town. - `Data.Initiation.Creditor.PostalAddress.CountrySubDivision` (string, optional) The subdivision of the country, such as state, region, or county. - `Data.Initiation.Creditor.PostalAddress.Country` (string, optional) The name of the country. - `Data.Initiation.Creditor.PostalAddress.AddressLine` (array of string, optional) The information that locates and identifies the address of the creditor, presented in free format text. - `Data.Initiation.CreditorAgent` (object, optional) The party that manages the account on behalf of the account owner by: - Managing the registration and booking of entries on the account. - Calculating balances on the account. - Providing information about the account. This is the servicer of the beneficiary account. - `Data.Initiation.CreditorAgent.SchemeName` (array of string, optional) The name of the identification scheme, which is published in an external list. - `Data.Initiation.CreditorAgent.Identification` (string, optional) The unique ID of the servicing institution. - `Data.Initiation.CreditorAgent.Name` (string, optional) The name of a known agent used to identify the agent. - `Data.Initiation.CreditorAgent.PostalAddress` (object, optional) The postal address of the creditor, as defined by postal services. - `Data.Initiation.CreditorAgent.PostalAddress.Department` (string, optional) The name of the department. - `Data.Initiation.CreditorAgent.PostalAddress.SubDepartment` (string, optional) The name of the sub-department. - `Data.Initiation.CreditorAgent.PostalAddress.StreetName` (string, optional) The name of the street. - `Data.Initiation.CreditorAgent.PostalAddress.BuildingNumber` (string, optional) The number of the building. - `Data.Initiation.CreditorAgent.PostalAddress.PostCode` (string, optional) The post code of the address. - `Data.Initiation.CreditorAgent.PostalAddress.TownName` (string, optional) The name of the town. - `Data.Initiation.CreditorAgent.PostalAddress.CountrySubDivision` (string, optional) The subdivision of the country, such as state, region, or county. - `Data.Initiation.CreditorAgent.PostalAddress.Country` (string, optional) The name of the country. - `Data.Initiation.CreditorAgent.PostalAddress.AddressLine` (array of string, optional) The information that locates and identifies the address of the creditor, presented in free format text. - `Data.Initiation.CreditorAccount` (object) The details to identify the account. - `Data.Initiation.CreditorAccount.SchemeName` (enum) The name of the identification scheme. Possible enum values: - `UK.OBIE.IBAN` - `UK.OBIE.SortCodeAccountNumber` - `US.RoutingNumberAccountNumber` - `US.BranchCodeAccountNumber` - `Data.Initiation.CreditorAccount.Identification` (string) The account ID that the institution assigns to identify an account, which is known by the account owner. - `Data.Initiation.CreditorAccount.Name` (string) The account name that the account servicing institution assigns. The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. :::note [ASPSP](/docs/guides/build-banking-apps/glossary)s might optionally validate this name to confirm the payee. ::: - `Data.Initiation.CreditorAccount.SecondaryIdentification` (string, optional) The secondary account ID that the account servicing institution assigns. Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination. - `Data.Initiation.RemittanceInformation` (object, optional) The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. - `Data.Initiation.RemittanceInformation.Unstructured` (string, optional) The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. - `Data.Initiation.RemittanceInformation.Reference` (string, optional) The unique reference that the creditor assigns to unambiguously identify the payment transaction. If available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. :::note Faster Payments Scheme can accept only 18 characters for the `Reference` field. ::: :::warning Only one reference should be provided, if both `Reference` and `Unstructured` parameters are provided, then the `Unstructured` parameter will be ignored. ::: - `Data.Initiation.DebtorAccount` (object, optional) The details to identify the account from which the payment consent can be approved. If provided in the consent, the [PSU](/docs/guides/build-banking-apps/glossary) will only be able to approve the payment consent from an account which matches the provided account identifier. - `Data.Initiation.DebtorAccount.SchemeName` (enum) The name of the identification scheme. Possible enum values: - `UK.OBIE.IBAN` - `UK.OBIE.SortCodeAccountNumber` - `US.RoutingNumberAccountNumber` - `US.BranchCodeAccountNumber` - `Data.Initiation.DebtorAccount.Identification` (string) The identifier assigned to the account, which is known by the account owner. - `Data.Initiation.DebtorAccount.Name` (string, optional) The name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. :::warning The name value is not validated against the actual owner name of the account. ::: - `Data.Initiation.DebtorAccount.SecondaryIdentification` (string, optional) The secondary account ID that the account servicing institution assigns. Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination. - `Risk` (object) The Risk section contains the risk indicators that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which can be used to specify additional details for risk scoring for account information. - `Risk.PaymentContextCode` (enum, optional) The payment context. Possible enum values: - `BillPayment` - `EcommerceGoods` - `EcommerceServices` - `Other` - `PartyToParty` - `Risk.MerchantCategoryCode` (string, optional) The merchant category code. - `Risk.MerchantCustomerIdentification` (string, optional) The merchant customer identification. - `Risk.DeliveryAddress` (object, optional) The information that locates and identifies the delivery address, as defined by postal services or in free format text. - `Risk.DeliveryAddress.AddressLine` (array of string, optional) The information that locates and identifies the delivery address, as defined by postal services, that is presented in free format text. - `Risk.DeliveryAddress.StreetName` (string, optional) The name of the street. - `Risk.DeliveryAddress.BuildingNumber` (string, optional) The number of the building. - `Risk.DeliveryAddress.PostCode` (string, optional) The post code of the delivery address. - `Risk.DeliveryAddress.TownName` (string) The name of the town. - `Risk.DeliveryAddress.CountrySubDivision` (array of string, optional) The subdivision of the country, for example, state, region or county. - `Risk.DeliveryAddress.Country` (string) The name of the country. ## Returns ### 201 International Payment Consents Created #### Response attributes - `Data` (object) - `Data.ConsentId` (string) The unique ID that the [ASPSP](/docs/guides/build-banking-apps/glossary) assigns to identify the consent resource. - `Data.CreationDateTime` (string) The date and time when the resource was created. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.Status` (enum) The status of the consent. Possible enum values: - `Authorised` - `AwaitingAuthorisation` - `Consumed` - `Rejected` - `Data.StatusUpdateDateTime` (string) The date and time when the resource status was updated. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.ExchangeRateInformation` (object, optional) Further detailed information on the exchange rate that is used in the payment transaction. - `Data.ExchangeRateInformation.UnitCurrency` (string) The currency that the exchange rate is expressed in. For example, for 1 GBP = xxx EUR, the `UnitCurrency` value is GBP. - `Data.ExchangeRateInformation.ExchangeRate` (string) The exchange rate used to convert an amount from one currency into another. This reflects the price that one currency was bought at with another currency. - `Data.ExchangeRateInformation.RateType` (enum) The type used to complete the currency exchange. Possible enum values: - `Actual` - `Agreed` - `Indicative` - `Data.ExchangeRateInformation.ContractIdentification` (string, optional) The unique reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. - `Data.ExchangeRateInformation.ExpirationDateTime` (string, optional) The date and time when the exchange rate agreement expires. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.Initiation` (object) The initiation payload that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which is used to request movement of funds from the debtor account to the creditor for a single international payment. - `Data.Initiation.InstructionIdentification` (string) The unique ID that an instructing party assigns for an instructed party to unambiguously identify the instruction. This ID is used between the instructing party and the instructed party to refer to the individual instruction. It can be included in the messages related to the instruction. - `Data.Initiation.EndToEndIdentification` (string) The unique and immutable ID that the initiating party assigns to unambiguously identify the transaction. This ID is used for reconciliation or to link tasks related to the transaction. It can be included in the messages related to the transaction. :::note Faster Payments Scheme can access only 31 characters for the `EndToEndIdentification` field. ::: - `Data.Initiation.ChargeBearer` (enum, optional) The party or parties bear the charges associated with the processing of the payment transaction. Possible enum values: - `BorneByDebtor` - `FollowingServiceLevel` - `Data.Initiation.CurrencyOfTransfer` (string) The currency of the money to be transferred, which is different from the currency of the debtor's account. - `Data.Initiation.InstructedAmount` (object) The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency that the initiating party instructs. This amount has to be transported unchanged through the transaction chain. - `Data.Initiation.InstructedAmount.Amount` (string) The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `Data.Initiation.InstructedAmount.Currency` (string) - `Data.Initiation.ExchangeRateInformation` (object, optional) The details on the currency exchange rate and contract. - `Data.Initiation.ExchangeRateInformation.UnitCurrency` (string) The currency that the exchange rate is expressed in. For example, for 1 GBP = xxx EUR, the `UnitCurrency` value is GBP. - `Data.Initiation.ExchangeRateInformation.ExchangeRate` (number, optional) The exchange rate used to convert an amount from one currency into another. This reflects the price that one currency was bought at with another currency. - `Data.Initiation.ExchangeRateInformation.RateType` (enum) The type used to complete the currency exchange. Possible enum values: - `Actual` - `Agreed` - `Indicative` - `Data.Initiation.ExchangeRateInformation.ContractIdentification` (string, optional) The unique reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. - `Data.Initiation.Creditor` (object, optional) The party that an amount of money is due to. - `Data.Initiation.Creditor.Name` (string, optional) The name of a known party used to identify the party. - `Data.Initiation.Creditor.PostalAddress` (object, optional) The postal address of the creditor, as defined by postal services. - `Data.Initiation.Creditor.PostalAddress.Department` (string, optional) The name of the department. - `Data.Initiation.Creditor.PostalAddress.SubDepartment` (string, optional) The name of the sub-department. - `Data.Initiation.Creditor.PostalAddress.StreetName` (string, optional) The name of the street. - `Data.Initiation.Creditor.PostalAddress.BuildingNumber` (string, optional) The number of the building. - `Data.Initiation.Creditor.PostalAddress.PostCode` (string, optional) The post code of the address. - `Data.Initiation.Creditor.PostalAddress.TownName` (string, optional) The name of the town. - `Data.Initiation.Creditor.PostalAddress.CountrySubDivision` (string, optional) The subdivision of the country, such as state, region, or county. - `Data.Initiation.Creditor.PostalAddress.Country` (string, optional) The name of the country. - `Data.Initiation.Creditor.PostalAddress.AddressLine` (array of string, optional) The information that locates and identifies the address of the creditor, presented in free format text. - `Data.Initiation.CreditorAgent` (object, optional) The party that manages the account on behalf of the account owner by: - Managing the registration and booking of entries on the account. - Calculating balances on the account. - Providing information about the account. This is the servicer of the beneficiary account. - `Data.Initiation.CreditorAgent.SchemeName` (array of string, optional) The name of the identification scheme, which is published in an external list. - `Data.Initiation.CreditorAgent.Identification` (string, optional) The unique ID of the servicing institution. - `Data.Initiation.CreditorAgent.Name` (string, optional) The name of a known agent used to identify the agent. - `Data.Initiation.CreditorAgent.PostalAddress` (object, optional) The postal address of the creditor, as defined by postal services. - `Data.Initiation.CreditorAgent.PostalAddress.Department` (string, optional) The name of the department. - `Data.Initiation.CreditorAgent.PostalAddress.SubDepartment` (string, optional) The name of the sub-department. - `Data.Initiation.CreditorAgent.PostalAddress.StreetName` (string, optional) The name of the street. - `Data.Initiation.CreditorAgent.PostalAddress.BuildingNumber` (string, optional) The number of the building. - `Data.Initiation.CreditorAgent.PostalAddress.PostCode` (string, optional) The post code of the address. - `Data.Initiation.CreditorAgent.PostalAddress.TownName` (string, optional) The name of the town. - `Data.Initiation.CreditorAgent.PostalAddress.CountrySubDivision` (string, optional) The subdivision of the country, such as state, region, or county. - `Data.Initiation.CreditorAgent.PostalAddress.Country` (string, optional) The name of the country. - `Data.Initiation.CreditorAgent.PostalAddress.AddressLine` (array of string, optional) The information that locates and identifies the address of the creditor, presented in free format text. - `Data.Initiation.CreditorAccount` (object) The details to identify the account. - `Data.Initiation.CreditorAccount.SchemeName` (enum) The name of the identification scheme. Possible enum values: - `UK.OBIE.IBAN` - `UK.OBIE.SortCodeAccountNumber` - `US.RoutingNumberAccountNumber` - `US.BranchCodeAccountNumber` - `Data.Initiation.CreditorAccount.Identification` (string) The account ID that the institution assigns to identify an account, which is known by the account owner. - `Data.Initiation.CreditorAccount.Name` (string) The account name that the account servicing institution assigns. The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. :::note [ASPSP](/docs/guides/build-banking-apps/glossary)s might optionally validate this name to confirm the payee. ::: - `Data.Initiation.CreditorAccount.SecondaryIdentification` (string, optional) The secondary account ID that the account servicing institution assigns. Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination. - `Data.Initiation.RemittanceInformation` (object, optional) The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. - `Data.Initiation.RemittanceInformation.Unstructured` (string, optional) The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. - `Data.Initiation.RemittanceInformation.Reference` (string, optional) The unique reference that the creditor assigns to unambiguously identify the payment transaction. If available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. :::note Faster Payments Scheme can accept only 18 characters for the `Reference` field. ::: :::warning Only one reference should be provided, if both `Reference` and `Unstructured` parameters are provided, then the `Unstructured` parameter will be ignored. ::: - `Data.Initiation.DebtorAccount` (object, optional) The details to identify the account from which the payment consent can be approved. If provided in the consent, the [PSU](/docs/guides/build-banking-apps/glossary) will only be able to approve the payment consent from an account which matches the provided account identifier. - `Data.Initiation.DebtorAccount.SchemeName` (enum) The name of the identification scheme. Possible enum values: - `UK.OBIE.IBAN` - `UK.OBIE.SortCodeAccountNumber` - `US.RoutingNumberAccountNumber` - `US.BranchCodeAccountNumber` - `Data.Initiation.DebtorAccount.Identification` (string) The identifier assigned to the account, which is known by the account owner. - `Data.Initiation.DebtorAccount.Name` (string, optional) The name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. :::warning The name value is not validated against the actual owner name of the account. ::: - `Data.Initiation.DebtorAccount.SecondaryIdentification` (string, optional) The secondary account ID that the account servicing institution assigns. Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination. - `Risk` (object) The Risk section contains the risk indicators that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which can be used to specify additional details for risk scoring for account information. - `Risk.PaymentContextCode` (enum, optional) The payment context. Possible enum values: - `BillPayment` - `EcommerceGoods` - `EcommerceServices` - `Other` - `PartyToParty` - `Risk.MerchantCategoryCode` (string, optional) The merchant category code. - `Risk.MerchantCustomerIdentification` (string, optional) The merchant customer identification. - `Risk.DeliveryAddress` (object, optional) The information that locates and identifies the delivery address, as defined by postal services or in free format text. - `Risk.DeliveryAddress.AddressLine` (array of string, optional) The information that locates and identifies the delivery address, as defined by postal services, that is presented in free format text. - `Risk.DeliveryAddress.StreetName` (string, optional) The name of the street. - `Risk.DeliveryAddress.BuildingNumber` (string, optional) The number of the building. - `Risk.DeliveryAddress.PostCode` (string, optional) The post code of the delivery address. - `Risk.DeliveryAddress.TownName` (string) The name of the town. - `Risk.DeliveryAddress.CountrySubDivision` (array of string, optional) The subdivision of the country, for example, state, region or county. - `Risk.DeliveryAddress.Country` (string) The name of the country. - `Links` (object) Links relevant to the payload. - `Links.Self` (string) The absolute URI to the resource. - `Links.Next` (string, optional) The absolute URI to the next pagination resource. - `Links.Prev` (string, optional) The absolute URI to the previous pagination resource. - `Meta` (object) Meta data relevant to the payload. - `Meta.TotalPages` (integer, optional) Used for pagination. Indicates how many pages of results are available. ## Error responses | HTTP status code | Description | | --- | --- | | 400 | Bad request | | 401 | Unauthorized | | 403 | Forbidden | | 405 | Method Not Allowed | | 406 | Not Acceptable | | 415 | Unsupported Media Type | | 429 | Too Many Requests | | 500 | Internal Server Error |