This method has the function of requesting an FX, being able to be executed in a second "execution" method to execute the FX.

  • Published on Feb 20, 2025
  • 10 minute(s) read
Prev Next
Post
/quotes

Prior to the request, the "x-santander-client-id" in the header must be configured in PagoNxt Trade to one or more customer_id.

In the query_params, there is a customer_id field, which has the following functionality:

  • If for an "x-santander-client-id" there is only one parameterised customer_id in the PagoNxt systems, the query_params does not need to be informed, it would be optional.
  • If for an "x-santander-client-id" there is more than one parameterised customer_id in PagoNxt systems, the query_params customer_id becomes mandatory, and additionally the API validates that the customer_id corresponds to those parameterised in PagoNxt Trade, if it does not match, the request is rejected.
  • The fields client_sell_ccy and client_sell_buy are both mandatory, and cannot contain the same ccy, they would be rejected in this case.Client_sell_amount and client_buy_amount are optional fields, but at least one of them must be reported. Must be >0 and cannot be negative values.
  • valueDate: is an optional field.
    • If not informed, FX nearest ESD (Earliest Settlement Day) is returned.
    • If informed, it search for an FX for the given date. If there is no FX for the valueDate informed, nearest FX would be returned, indicating in the API Output the field valueDateChange=true indicating that the value has changed and valueDate= “AAAA-MM-DD” the new valueDate for the FX request is reported.
  • A tradeId is returned, FX reference, which will need to be sent in second method/endpoint to be able to execute the FX and make it firm.
Security
OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
quote.createcreate the quote data
Header parameters
x-client-id
stringRequired

Client ID header

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Examplea1b30a84-7bf3-442e-84a0-e935d8163b5a
Query parameters
customer_id
string

Customer identifier

Max length255
Pattern^[a-zA-Z_0-9-]*$
Example1460ef1d-4da5-0272-5e91-3153ed8230e1
Body parameters

QuoteCustomersRequest

QuoteCustomersRequestExample
{
  "clientSell": {
    "amount": "500",
    "currency": "EUR"
  },
  "clientBuy": {
    "amount": "1000",
    "currency": "USD"
  },
  "valueDate": "2022-01-27"
}
Expand All
object

quote Customers Request

clientSell
object (ClientSellBuy)

Client Sell or Buy Object

amount
number (double)

Amount on sell / buy detail

Minimum0
Maximum2147483647
Example1235.01
currency
string Required

currency

Min length0
Max length7
Pattern^[a-zA-Z]*$
ExampleEUR
clientBuy
object (ClientSellBuy)

Client Sell or Buy Object

amount
number (double)

Amount on sell / buy detail

Minimum0
Maximum2147483647
Example1235.01
currency
string Required

currency

Min length0
Max length7
Pattern^[a-zA-Z]*$
ExampleEUR
valueDate
string (date)

ISO 8601 Complete Data format (YYYY-MM-DD):\n YYYY = four-digit year\n MM = two-digit month (01=January, etc.)\n DD = two-digit day of month (01 through 31)

Example2020-08-14
Responses
201

quote customer response

QuoteCustomersResponseExample
{
  "quoteId": "709b3c24-902c-4ce2-89a4-46dc68f8448f",
  "customerId": "pagofx_ukGB847868066",
  "ccyPair": "EUR/USD",
  "exchangeRate": "1.0505",
  "clientSell": {
    "amount": "951.93",
    "currency": "EUR"
  },
  "clientBuy": {
    "amount": "1000",
    "currency": "USD"
  },
  "valueDate": "2022-01-27",
  "valueDateChange": false,
  "quoteCreatedAt": "2023-01-27T15:16:42Z",
  "quoteExpiresAt": "2023-01-27T15:21:42Z",
  "cutoffDebitAccount": "2023-01-27T16:00:00Z"
}
Expand All
object

quote customer response

quoteId
string

Global unique id for the requested trade

Min length0
Max length50
Pattern^[a-zA-Z_0-9-]*$
Example709b3c24-902c-4ce2-89a4-46dc68f8448f
customerId
string

Customer identifier

Min length0
Max length50
Pattern^[a-zA-Z_0-9-]*$
Example1460ef1d-4da5-0272-5e91-3153ed8230e1
ccyPair
string

Currency pair of the requested quote

Min length0
Max length7
Pattern^[a-zA-Z_0-9\/]*$
ExampleEUR/USD
exchangeRate
number (double)

Fx rate of the requested currency pair. Precision: 5 integer, 8 decimals

Minimum0
Maximum2147483647
Example0.8778
clientSell
object (ClientSellBuy)

Client Sell or Buy Object

amount
number (double)

Amount on sell / buy detail

Minimum0
Maximum2147483647
Example1235.01
currency
string

currency

Min length0
Max length7
Pattern^[a-zA-Z]*$
ExampleEUR
clientBuy
object (ClientSellBuy)

Client Sell or Buy Object

amount
number (double)

Amount on sell / buy detail

Minimum0
Maximum2147483647
Example1235.01
currency
string

currency

Min length0
Max length7
Pattern^[a-zA-Z]*$
ExampleEUR
valueDate
string (date)

Date when the date exchange rate is valid

Min length0
Max length10
Example2021-09-27
valueDateChange
boolean

true when the valueDate logic reported in the input is triggered and there is no price, double call

ExampleTrue
quoteCreatedAt
string (date-time)

Timestamp of the fx transaction api response

Min length0
Max length20
Example2021-09-27T11:22:12Z
quoteExpiresAt
string (date-time)

Expiration timeStamp of response provided by fx_transactional

Min length0
Max length20
Example2021-09-27T11:27:12Z
cutoffDebitAccount
string (date-time)

cut off debit account timeStamp

Min length0
Max length20
Example2021-09-27T11:27:12Z
400

Bad request

err400Example
{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "level": "ERROR",
      "message": "Bad Request",
      "description": "Error validating schema"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
401

Unauthorized

err401Example
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Unauthorized",
      "level": "ERROR",
      "description": "Unauthorized description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
403

Forbidden

err403Example
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "level": "ERROR",
      "message": "Forbidden",
      "description": "Forbidden description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
404

Not Found

err404Example
{
  "errors": [
    {
      "code": "NOT_FOUND",
      "level": "ERROR",
      "message": "Not Found",
      "description": "Not Found description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
406

OWASP

err406Example
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "level": "ERROR",
      "message": "Not Acceptable",
      "description": "Not Acceptable description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
409

Conflict

err409Example
{
  "errors": [
    {
      "code": "CONFLICT",
      "level": "ERROR",
      "message": "Conflict",
      "description": "Conflict description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
413

Payload Too Large

err413Example
{
  "errors": [
    {
      "code": "PAYLOAD_TOO_LARGE",
      "level": "ERROR",
      "message": "Payload Too Large",
      "description": "Payload Too Large description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
414

URI Too Long

err414Example
{
  "errors": [
    {
      "code": "URI_TOO_LONG",
      "level": "ERROR",
      "message": "URI Too Long",
      "description": "URI Too Long description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
415

Unsupported Media Type

err415Example
{
  "errors": [
    {
      "code": "UNSUPORTED_MEDIA_TYPE",
      "level": "ERROR",
      "message": "Unsupported Media Type",
      "description": "Unsupported Media Type description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
422

Unprocessable Entity

err422Example
{
  "errors": [
    {
      "code": "UNPROCESABLE_ENTITY",
      "level": "ERROR",
      "message": "Unprocessable Entity",
      "description": "Unprocessable Entity description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
429

Too many requests

err429Example
{
  "errors": [
    {
      "code": "TOO_MANY_REQUEST",
      "level": "ERROR",
      "message": "Too Many Requests",
      "description": "Too Many Requests description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
500

Internal server error

err500Example
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "ERROR",
      "message": "Internal server error",
      "description": "Internal Server Error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
503

Service unavailable

err53Example
{
  "errors": [
    {
      "code": "SERVICE_UNAVAILABLE",
      "level": "ERROR",
      "message": "Service unavailable",
      "description": "Service unavailable"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
504

Gateway timeout

err504Example
{
  "errors": [
    {
      "code": "GATEWAY_TIMEOUT",
      "level": "ERROR",
      "message": "Gateway timeout",
      "description": "Gateway timeout"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
default

Unexpected error

errDefaultExample
{
  "errors": [
    {
      "code": "UNEXPECTED_ERROR",
      "level": "ERROR",
      "message": "Unexpected error",
      "description": "Unexpected error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (X-Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription