API reference

Parameters

Responses

• 200The calling consumer

  application/json ConsumerWhoAmIResponse

  Name	Type	Description
  consumerrequired	object
  api_keyrequired	object | null	The key used for this request. Null for tcr_<64 hex> keys.

• 400api_key_conflict (X-TuCOPRamp-Key and Authorization carry different keys) or invalid_api_version (unknown TuCOPRamp-Version)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing, invalid, expired or revoked consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403api_key_ip_not_allowed (the key is limited to other IP ranges) or api_key_origin_not_allowed (an older pk key limited to other origins)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Responses

• 200Accepted document types

  application/json DocumentTypesResponse

  Name	Type	Description
  countryrequired	string	ISO 3166-1 alpha-3 code.
  country_namerequired	string
  party_typerequired	string: individual, business
  document_typesrequired	array of object

• 400invalid_country (not an ISO 3166-1 alpha-3 code), invalid_party_type, api_key_conflict or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing, invalid, expired or revoked consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Responses

• 200A page of events

  application/json EventsPage

  Name	Type	Description
  datarequired	array of Event
  next_afterrequired	integer	Pass as after to get the next page. Equal to after when data is empty.
  has_morerequired	boolean

• 400invalid_query, or invalid_api_version (unknown TuCOPRamp-Version)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing, invalid, expired or revoked consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403api_key_ip_not_allowed (the key is limited to other IP ranges) or api_key_origin_not_allowed (an older pk key limited to other origins)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request bodyrequired

Responses

• 202Code sent

  application/json object

  Name	Type	Description
  expires_atrequired	string (date-time)

• 400invalid_body or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing, invalid, expired or revoked consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403product_not_enabled (the key has no On/Off Ramp service: withdraw, pay, collect or deposit; category on_off_ramp), api_key_ip_not_allowed (the key is limited to other IP ranges), api_key_origin_not_allowed (an older pk key limited to other origins) or api_key_scope_missing (a read-only key on a request that changes something)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429rate_limited_email or rate_limited_consumer. See Retry-After.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 502email_not_sent

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request bodyrequired

Responses

• 201Session opened

  application/json PartySession

  Name	Type	Description
  tokenrequired	string	Send it in the X-TuCOPRamp-Party-Session header. Shown once; TuCOP keeps only its hash.
  methodrequired	string: email_otp, wallet, google
  expires_atrequired	string (date-time)	One hour after it was issued.
  party_idrequired	PartyPublicId & string | null

• 400invalid_body or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401invalid_code (wrong, used or expired), or an invalid consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403product_not_enabled (the key has no On/Off Ramp service: withdraw, pay, collect or deposit; category on_off_ramp), api_key_ip_not_allowed (the key is limited to other IP ranges), api_key_origin_not_allowed (an older pk key limited to other origins) or api_key_scope_missing (a read-only key on a request that changes something)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429rate_limited_email or rate_limited_consumer. See Retry-After.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request bodyrequired

Responses

• 201Nonce issued

  application/json object

  Name	Type	Description
  noncerequired	string
  messagerequired	string
  chain_idrequired	integer
  expires_atrequired	string (date-time)

• 400invalid_body or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing, invalid, expired or revoked consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403product_not_enabled (the key has no On/Off Ramp service: withdraw, pay, collect or deposit; category on_off_ramp), api_key_ip_not_allowed (the key is limited to other IP ranges), api_key_origin_not_allowed (an older pk key limited to other origins) or api_key_scope_missing (a read-only key on a request that changes something)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 422chain_not_supported

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429rate_limited_wallet or rate_limited_consumer. See Retry-After.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request bodyrequired

Responses

• 201Session opened

  application/json PartySession

  Name	Type	Description
  tokenrequired	string	Send it in the X-TuCOPRamp-Party-Session header. Shown once; TuCOP keeps only its hash.
  methodrequired	string: email_otp, wallet, google
  expires_atrequired	string (date-time)	One hour after it was issued.
  party_idrequired	PartyPublicId & string | null

• 400invalid_body or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401nonce_invalid (unknown, used, expired or issued to another consumer), signature_invalid, or an invalid consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403product_not_enabled (the key has no On/Off Ramp service: withdraw, pay, collect or deposit; category on_off_ramp), api_key_ip_not_allowed (the key is limited to other IP ranges), api_key_origin_not_allowed (an older pk key limited to other origins) or api_key_scope_missing (a read-only key on a request that changes something)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429rate_limited_consumer. See Retry-After.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request body

Responses

• 201Nonce issued

  application/json object

  Name	Type	Description
  noncerequired	string
  client_idrequired	string
  expires_atrequired	string (date-time)

• 400invalid_body or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing, invalid, expired or revoked consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403product_not_enabled (the key has no On/Off Ramp service: withdraw, pay, collect or deposit; category on_off_ramp), api_key_ip_not_allowed (the key is limited to other IP ranges), api_key_origin_not_allowed (an older pk key limited to other origins) or api_key_scope_missing (a read-only key on a request that changes something)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429rate_limited_consumer. See Retry-After.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 503google_sign_in_unavailable

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request bodyrequired

Responses

• 201Session opened

  application/json PartySession

  Name	Type	Description
  tokenrequired	string	Send it in the X-TuCOPRamp-Party-Session header. Shown once; TuCOP keeps only its hash.
  methodrequired	string: email_otp, wallet, google
  expires_atrequired	string (date-time)	One hour after it was issued.
  party_idrequired	PartyPublicId & string | null

• 400invalid_body or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401id_token_invalid, nonce_invalid (unknown, used, expired or issued to another consumer), email_not_verified, or an invalid consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403product_not_enabled (the key has no On/Off Ramp service: withdraw, pay, collect or deposit; category on_off_ramp), api_key_ip_not_allowed (the key is limited to other IP ranges), api_key_origin_not_allowed (an older pk key limited to other origins) or api_key_scope_missing (a read-only key on a request that changes something)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429rate_limited_consumer. See Retry-After.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 503google_sign_in_unavailable

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Responses

• 204Signed out

• 401party_session_required (header missing) or an invalid consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403product_not_enabled (the key has no On/Off Ramp service: withdraw, pay, collect or deposit; category on_off_ramp), api_key_ip_not_allowed (the key is limited to other IP ranges), api_key_origin_not_allowed (an older pk key limited to other origins) or api_key_scope_missing (a read-only key on a request that changes something)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429rate_limited_consumer. See Retry-After.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request bodyrequired

Responses

• 200The existing party, now linked to your consumer

  application/json PartyResponse

  Name	Type	Description
  partyrequired	Party	A person or a business served through your consumer.

• 201Party created

  application/json PartyResponse

  Name	Type	Description
  partyrequired	Party	A person or a business served through your consumer.

• 400invalid_body, invalid_country, invalid_document, invalid_name, invalid_consent, invalid_api_version, idempotency_key_required or idempotency_key_invalid

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401party_session_required (also with the API key alone: creating or linking a party always needs a party session), party_session_invalid, or an invalid consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403product_not_enabled (the key has no On/Off Ramp service: withdraw, pay, collect or deposit; category on_off_ramp), api_key_ip_not_allowed (the key is limited to other IP ranges), api_key_origin_not_allowed (an older pk key limited to other origins) or api_key_scope_missing (a read-only key on a request that changes something)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 409party_identity_not_proven or idempotency_in_progress

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 422email_required, redirect_url_not_allowed or idempotency_key_reuse

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429rate_limited_party_session. See Retry-After.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 502provider_unavailable. Retry with the same Idempotency-Key.

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Responses

• 200The party

  application/json PartyMe

  Name	Type	Description
  partyrequired	Party	A person or a business served through your consumer.
  instrumentsrequired	object	Instruments your consumer may see: destinations it created and the party's own (first-party) destinations. Empty while the party is restricted.

• 400invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401party_session_required, party_session_invalid, or an invalid consumer key

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403party_required (the session has no party linked to your consumer yet), product_not_enabled (no On/Off Ramp service; category on_off_ramp), api_key_ip_not_allowed or api_key_origin_not_allowed

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Responses

• 200Destinations

  application/json DestinationList

  Name	Type	Description
  datarequired	array of Destination
  has_morerequired	boolean

• 400invalid_query or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing or invalid consumer key, party_session_required (no session, and TuCOP has not linked a payments provider account to your integrator) or party_session_invalid

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403party_required (the session has no party linked to your consumer yet), party_not_linked, party_restricted, product_not_enabled, integrator_customer_mismatch (your integrator pays from its own payments provider account and the session is for another party), or an API key restriction

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 409integrator_not_linked (no session sent, and the payments provider account TuCOP set for your integrator is not linked to it yet)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request bodyrequired

Responses

• 200The destination already existed

  application/json Destination

  Name	Type	Description
  idrequired	DestinationPublicId	Public id of a destination: dst_ followed by 26 Crockford base32 characters. Treat it as an opaque string; compare it case-insensitively.
  ownershiprequired	string: first_party, third_party
  railrequired	string: bre_b
  statusrequired	string: pending, verified, rejected	pending until the Bre-B directory answers (about a minute), then verified or rejected. Each change is also sent as destination.verified or destination.rejected.
  key_maskedrequired	string | null
  owner_namerequired	string | null	Holder name sent to the payments provider: the payer's input for third_party, the KYC'd name for first_party. null for a key lookup (third_party created without owner_name): the holder comes from the Bre-B directory in holder.
  holderrequired	object | null	What the Bre-B directory returned. Only on verified. Show it to the payer before they confirm a third-party destination. For a key lookup this is how the payer learns who holds the key.
  rejection_reasonrequired	string | null: directory_no_match, holder_name_mismatch, holder_document_mismatch, verification_timeout, directory_unavailable
  verified_atrequired	string | null (date-time)
  confirmed_atrequired	string | null (date-time)	When the payer confirmed the holder. Payments need it on third_party.
  activerequired	boolean	false once the destination was deleted (DELETE /destinations/{id}). A deleted destination is only returned by GET /destinations/{id} and by GET /destinations?include_disabled=true, and cannot be paid or withdrawn to. status stays the verification status.
  disabled_atrequired	string | null (date-time)	When the destination was deleted. Null while active.
  created_atrequired	string (date-time)
  updated_atrequired	string (date-time)

• 202Created; verification in progress

  application/json Destination

  Name	Type	Description
  idrequired	DestinationPublicId	Public id of a destination: dst_ followed by 26 Crockford base32 characters. Treat it as an opaque string; compare it case-insensitively.
  ownershiprequired	string: first_party, third_party
  railrequired	string: bre_b
  statusrequired	string: pending, verified, rejected	pending until the Bre-B directory answers (about a minute), then verified or rejected. Each change is also sent as destination.verified or destination.rejected.
  key_maskedrequired	string | null
  owner_namerequired	string | null	Holder name sent to the payments provider: the payer's input for third_party, the KYC'd name for first_party. null for a key lookup (third_party created without owner_name): the holder comes from the Bre-B directory in holder.
  holderrequired	object | null	What the Bre-B directory returned. Only on verified. Show it to the payer before they confirm a third-party destination. For a key lookup this is how the payer learns who holds the key.
  rejection_reasonrequired	string | null: directory_no_match, holder_name_mismatch, holder_document_mismatch, verification_timeout, directory_unavailable
  verified_atrequired	string | null (date-time)
  confirmed_atrequired	string | null (date-time)	When the payer confirmed the holder. Payments need it on third_party.
  activerequired	boolean	false once the destination was deleted (DELETE /destinations/{id}). A deleted destination is only returned by GET /destinations/{id} and by GET /destinations?include_disabled=true, and cannot be paid or withdrawn to. status stays the verification status.
  disabled_atrequired	string | null (date-time)	When the destination was deleted. Null while active.
  created_atrequired	string (date-time)
  updated_atrequired	string (date-time)

• 400invalid_body, invalid_bre_b_key, invalid_owner_name, idempotency_key_required, idempotency_key_invalid or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing or invalid consumer key, party_session_required (no session, and TuCOP has not linked a payments provider account to your integrator) or party_session_invalid

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403party_required (the session has no party linked to your consumer yet), party_not_linked, party_restricted, product_not_enabled, integrator_customer_mismatch (your integrator pays from its own payments provider account and the session is for another party), or an API key restriction

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 409party_not_verified, kyc_name_missing (first_party, KYC name not available yet), first_party_not_available (first_party for a party that stands for a payments provider account linked by TuCOP: it has no identity document to match; use pay for third-party keys), destination_conflict (the same key is being registered by another request; retry), holder_name_mismatch (third_party: the key was already looked up and its holder does not match owner_name; includes destination_id), destination_already_registered (the key is already registered on this payments provider account and could not be matched to one; list destinations or contact TuCOP), destination_limit_reached (first_party: the person already has as many active first-party keys registered by this integrator as allowed: the lower of the limit the integrator sets in its console and a maximum TuCOP may set for the integrator; none by default. The detail says which applies; delete one first), integrator_not_linked or idempotency_in_progress

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 422destination_invalid (the payments provider refused the key) or idempotency_key_reuse

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Responses

• 200The destination

  application/json Destination

  Name	Type	Description
  idrequired	DestinationPublicId	Public id of a destination: dst_ followed by 26 Crockford base32 characters. Treat it as an opaque string; compare it case-insensitively.
  ownershiprequired	string: first_party, third_party
  railrequired	string: bre_b
  statusrequired	string: pending, verified, rejected	pending until the Bre-B directory answers (about a minute), then verified or rejected. Each change is also sent as destination.verified or destination.rejected.
  key_maskedrequired	string | null
  owner_namerequired	string | null	Holder name sent to the payments provider: the payer's input for third_party, the KYC'd name for first_party. null for a key lookup (third_party created without owner_name): the holder comes from the Bre-B directory in holder.
  holderrequired	object | null	What the Bre-B directory returned. Only on verified. Show it to the payer before they confirm a third-party destination. For a key lookup this is how the payer learns who holds the key.
  rejection_reasonrequired	string | null: directory_no_match, holder_name_mismatch, holder_document_mismatch, verification_timeout, directory_unavailable
  verified_atrequired	string | null (date-time)
  confirmed_atrequired	string | null (date-time)	When the payer confirmed the holder. Payments need it on third_party.
  activerequired	boolean	false once the destination was deleted (DELETE /destinations/{id}). A deleted destination is only returned by GET /destinations/{id} and by GET /destinations?include_disabled=true, and cannot be paid or withdrawn to. status stays the verification status.
  disabled_atrequired	string | null (date-time)	When the destination was deleted. Null while active.
  created_atrequired	string (date-time)
  updated_atrequired	string (date-time)

• 400invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing or invalid consumer key, party_session_required (no session, and TuCOP has not linked a payments provider account to your integrator) or party_session_invalid

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403party_required (the session has no party linked to your consumer yet), party_not_linked, party_restricted, product_not_enabled, integrator_customer_mismatch (your integrator pays from its own payments provider account and the session is for another party), or an API key restriction

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 404destination_not_found

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 409integrator_not_linked (no session sent, and the payments provider account TuCOP set for your integrator is not linked to it yet)

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Responses

• 204Deleted

• 400invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing or invalid consumer key, party_session_required (no session, and TuCOP has not linked a payments provider account to your integrator) or party_session_invalid

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403party_required (the session has no party linked to your consumer yet), party_not_linked, party_restricted, product_not_enabled, integrator_customer_mismatch (your integrator pays from its own payments provider account and the session is for another party), or an API key restriction

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 404destination_not_found

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 409destination_in_use (a payment in progress or an active withdrawal address uses it; disable the withdrawal first) or integrator_not_linked

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request body

Responses

• 200The confirmed destination

  application/json Destination

  Name	Type	Description
  idrequired	DestinationPublicId	Public id of a destination: dst_ followed by 26 Crockford base32 characters. Treat it as an opaque string; compare it case-insensitively.
  ownershiprequired	string: first_party, third_party
  railrequired	string: bre_b
  statusrequired	string: pending, verified, rejected	pending until the Bre-B directory answers (about a minute), then verified or rejected. Each change is also sent as destination.verified or destination.rejected.
  key_maskedrequired	string | null
  owner_namerequired	string | null	Holder name sent to the payments provider: the payer's input for third_party, the KYC'd name for first_party. null for a key lookup (third_party created without owner_name): the holder comes from the Bre-B directory in holder.
  holderrequired	object | null	What the Bre-B directory returned. Only on verified. Show it to the payer before they confirm a third-party destination. For a key lookup this is how the payer learns who holds the key.
  rejection_reasonrequired	string | null: directory_no_match, holder_name_mismatch, holder_document_mismatch, verification_timeout, directory_unavailable
  verified_atrequired	string | null (date-time)
  confirmed_atrequired	string | null (date-time)	When the payer confirmed the holder. Payments need it on third_party.
  activerequired	boolean	false once the destination was deleted (DELETE /destinations/{id}). A deleted destination is only returned by GET /destinations/{id} and by GET /destinations?include_disabled=true, and cannot be paid or withdrawn to. status stays the verification status.
  disabled_atrequired	string | null (date-time)	When the destination was deleted. Null while active.
  created_atrequired	string (date-time)
  updated_atrequired	string (date-time)

• 400invalid_body, idempotency_key_required or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing or invalid consumer key, party_session_required (no session, and TuCOP has not linked a payments provider account to your integrator) or party_session_invalid

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403party_required (the session has no party linked to your consumer yet), party_not_linked, party_restricted, product_not_enabled, integrator_customer_mismatch (your integrator pays from its own payments provider account and the session is for another party), or an API key restriction

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 404destination_not_found

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 409destination_not_verified, integrator_not_linked or idempotency_in_progress

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 422idempotency_key_reuse

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

Parameters

Request bodyrequired

Responses

• 201The quote

  application/json Quote

  Name	Type	Description
  idrequired	QuotePublicId	Public id of a quote: qte_ followed by 26 Crockford base32 characters. Treat it as an opaque string; compare it case-insensitively.
  productrequired	string: pay, withdraw
  destination_idrequired	DestinationPublicId	Public id of a destination: dst_ followed by 26 Crockford base32 characters. Treat it as an opaque string; compare it case-insensitively.
  destination_amountrequired	Money	An amount of one asset.
  source_amountrequired	Money & any
  feesrequired	object
  total_amountrequired	Money & any
  consumer_fee_walletrequired	string | null
  raterequired	object
  rounding_moderequired	string: floor, ceil, down, up, half_up, half_even	How every division was rounded. ceil: the payer never sends too little.
  settlement_timerequired	SettlementTime	How long the payout usually takes: after the USDC land on-chain, the pesos usually reach the Bre-B key between min_minutes and max_minutes later. Meanwhile the payment reads awaiting_funds while the provider detects the deposit, then processing (a withdrawal payout is in progress); neither is a failure. The status and the operation.updated webhook say when it completed. An expectation, not a guarantee.
  expires_atrequired	string (date-time)
  created_atrequired	string (date-time)

• 400invalid_body, invalid_amount, amount_not_settleable (not whole pesos), idempotency_key_required or invalid_api_version

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 401Missing or invalid consumer key, party_session_required (no session, and TuCOP has not linked a payments provider account to your integrator) or party_session_invalid

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 403party_required (the session has no party linked to your consumer yet), party_not_linked, party_restricted, product_not_enabled, integrator_customer_mismatch (your integrator pays from its own payments provider account and the session is for another party), or an API key restriction

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 404destination_not_found

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 409destination_not_verified, party_not_verified, first_party_not_available (withdraw, for a party that stands for a payments provider account linked by TuCOP; use pay for third-party keys), integrator_not_linked or idempotency_in_progress

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 422amount_below_minimum (pay: with minimum), pay_limit_exceeded (pay: with check, one of per_operation, integrator_day, integrator_month), destination_not_third_party (pay), destination_not_first_party (withdraw) or idempotency_key_reuse

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 429Rate limited

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.

• 502rate_unavailable

  application/problem+json Error

  Name	Type	Description
  type	string	URI derived from code. An identifier, not a page.
  title	string
  statusrequired	integer
  coderequired	string	Machine-readable code in snake_case. Branch on this field only.
  detailrequired	string	A sentence for people. It can change at any time.
  request_id	string	Same value as the X-Request-Id response header.
  issues	array of object	Fields that failed validation, when there are any.
  category	string | null: on_off_ramp, p2p	On product_not_enabled: the category of the services that would open the route. on_off_ramp (a payments provider moves the money) or p2p (TuCOP runs the exchange). Null when they belong to both.
  required	array of string	On product_not_enabled: the services that would open the route. Any one is enough.