diff --git a/api/anchor-platform/callbacks/get-rates.api.mdx b/api/anchor-platform/callbacks/get-rates.api.mdx index f51ae6d1f..248efa43d 100644 --- a/api/anchor-platform/callbacks/get-rates.api.mdx +++ b/api/anchor-platform/callbacks/get-rates.api.mdx @@ -52,7 +52,7 @@ Success. An object describing the fees added on top of the rate provided via the `price` attribute. -
details object[]
  • Array [
  • ]
  • +
    details object[]
  • Array [
  • ]
  • Unprocessable Entity. This status should be returned when the anchor understood the request but cannot return a success response. diff --git a/api/anchor-platform/callbacks/post-event.api.mdx b/api/anchor-platform/callbacks/post-event.api.mdx index 8b6df5521..4f0bb4f75 100644 --- a/api/anchor-platform/callbacks/post-event.api.mdx +++ b/api/anchor-platform/callbacks/post-event.api.mdx @@ -5,7 +5,7 @@ description: "Receive a JSON object representing an event." sidebar_label: "Receive an Event" hide_title: true hide_table_of_contents: true -api: {"tags":["Events","SEP-6","SEP-24","SEP-31"],"operationId":"postEvent","description":"Receive a JSON object representing an event.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["transaction_created","transaction_status_changed","transaction_error","quote_created","customer_updated"],"description":"The transaction event type. Can be one of the following:\n- `transaction_created` - a transaction was created through the SEP endpoints. The payload is in the `transaction` field.\n- `transaction_status_changed` - the status of a transaction has changed. The payload is in the `transaction` field.\n- `transaction_error` - error processing the transaction. The payload is in the `transaction` field.\n- `quote_created` - a quote was created via the SEP38 API. The payload is in the `quote` field.\n"},"timestamp":{"type":"string","format":"date-time"},"payload":{"type":"object","properties":{"transaction":{"oneOf":[{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"refund_memo":{"description":"if provided, this memo should be used for refund transactions","type":"string"},"refund_memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"client_domain":{"type":"string"},"client_name":{"type":"string"}},"title":"TransactionSEP24"},{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"client_domain":{"type":"string"},"client_name":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.\n\nFor a SEP-6 Anchor, the `account` and `memo` fields should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."},"memo":{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.\n\nFor a SEP-6 Anchor, the `account` and `memo` fields should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."},"memo":{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.\n\nFor a SEP-6 Anchor, the `account` and `memo` fields should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."},"memo":{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}},"title":"StellarId"}},"title":"TransactionSEP31"}]},"quote":{"type":"object","properties":{"id":{"type":"string"},"sell_amount":{"type":"string"},"sell_asset":{"type":"string"},"buy_amount":{"type":"string"},"buy_asset":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"price":{"type":"string"},"total_price":{"type":"string"},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.\n\nFor a SEP-6 Anchor, the `account` and `memo` fields should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."},"memo":{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}},"title":"StellarId"},"transaction_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"title":"Quote"},"customer":{"type":"object","properties":{"id":{"type":"string"}},"title":"Customer"}}}},"required":["id","type","payload","timestamp"],"title":"Event"}}}},"responses":{"200":{"description":"The event is successfully processed and ready to receive next event. The response body is empty."},"400":{"description":"The event is invalid or rejected. The response body contains the error message."}},"method":"post","path":"/event","jsonRequestBodyExample":{"id":"string","type":"transaction_created","timestamp":"2023-11-30T18:55:11.974Z","payload":{"transaction":{"id":"string","sep":"24","kind":"deposit","status":"incomplete","amount_expected":{"amount":"string","asset":"string"},"amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"quote_id":"string","started_at":"2023-11-30T18:55:11.974Z","updated_at":"2023-11-30T18:55:11.974Z","completed_at":"2023-11-30T18:55:11.974Z","transfer_received_at":"2023-11-30T18:55:11.974Z","message":"string","refunds":{"amount_refunded":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"payments":[{"id":"string","id_type":"stellar","amount":{"amount":"string","asset":"string"},"fee":{"amount":"string","asset":"string"},"requested_at":"2023-11-30T18:55:11.974Z","refunded_at":"2023-11-30T18:55:11.974Z"}]},"stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-11-30T18:55:11.974Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"source_account":"string","destination_account":"string","external_transaction_id":"string","memo":"string","memo_type":"text id hash","refund_memo":"string","refund_memo_type":"text id hash","client_domain":"string","client_name":"string"},"quote":{"id":"string","sell_amount":"string","sell_asset":"string","buy_amount":"string","buy_asset":"string","expires_at":"2023-11-30T18:55:11.974Z","price":"string","total_price":"string","creator":{"id":"string","account":"string","memo":"string"},"transaction_id":"string","created_at":"2023-11-30T18:55:11.974Z"},"customer":{"id":"string"}}},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Receive an Event","description":{"content":"Receive a JSON object representing an event.\n","type":"text/plain"},"url":{"path":["event"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Events","SEP-6","SEP-24","SEP-31"],"operationId":"postEvent","description":"Receive a JSON object representing an event.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["transaction_created","transaction_status_changed","transaction_error","quote_created","customer_updated"],"description":"The transaction event type. Can be one of the following:\n- `transaction_created` - a transaction was created through the SEP endpoints. The payload is in the `transaction` field.\n- `transaction_status_changed` - the status of a transaction has changed. The payload is in the `transaction` field.\n- `transaction_error` - error processing the transaction. The payload is in the `transaction` field.\n- `quote_created` - a quote was created via the SEP38 API. The payload is in the `quote` field.\n"},"timestamp":{"type":"string","format":"date-time"},"payload":{"type":"object","properties":{"transaction":{"oneOf":[{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"refund_memo":{"description":"if provided, this memo should be used for refund transactions","type":"string"},"refund_memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"client_domain":{"type":"string"},"client_name":{"type":"string"}},"title":"TransactionSEP24"},{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"client_domain":{"type":"string"},"client_name":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.\n\nFor a SEP-6 Anchor, the `account` and `memo` fields should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."},"memo":{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.\n\nFor a SEP-6 Anchor, the `account` and `memo` fields should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."},"memo":{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.\n\nFor a SEP-6 Anchor, the `account` and `memo` fields should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."},"memo":{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}},"title":"StellarId"}},"title":"TransactionSEP31"}]},"quote":{"type":"object","properties":{"id":{"type":"string"},"sell_amount":{"type":"string"},"sell_asset":{"type":"string"},"buy_amount":{"type":"string"},"buy_asset":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"price":{"type":"string"},"total_price":{"type":"string"},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.\n\nFor a SEP-6 Anchor, the `account` and `memo` fields should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."},"memo":{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}},"title":"StellarId"},"transaction_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"title":"Quote"},"customer":{"type":"object","properties":{"id":{"type":"string"}},"title":"Customer"}}}},"required":["id","type","payload","timestamp"],"title":"Event"}}}},"responses":{"200":{"description":"The event is successfully processed and ready to receive next event. The response body is empty."},"400":{"description":"The event is invalid or rejected. The response body contains the error message."}},"method":"post","path":"/event","jsonRequestBodyExample":{"id":"string","type":"transaction_created","timestamp":"2024-01-29T19:37:08.994Z","payload":{"transaction":{"id":"string","sep":"24","kind":"deposit","status":"incomplete","amount_expected":{"amount":"string","asset":"string"},"amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"quote_id":"string","started_at":"2024-01-29T19:37:08.995Z","updated_at":"2024-01-29T19:37:08.995Z","completed_at":"2024-01-29T19:37:08.995Z","transfer_received_at":"2024-01-29T19:37:08.995Z","message":"string","refunds":{"amount_refunded":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"payments":[{"id":"string","id_type":"stellar","amount":{"amount":"string","asset":"string"},"fee":{"amount":"string","asset":"string"},"requested_at":"2024-01-29T19:37:08.995Z","refunded_at":"2024-01-29T19:37:08.995Z"}]},"stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2024-01-29T19:37:08.995Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"source_account":"string","destination_account":"string","external_transaction_id":"string","memo":"string","memo_type":"text id hash","refund_memo":"string","refund_memo_type":"text id hash","client_domain":"string","client_name":"string"},"quote":{"id":"string","sell_amount":"string","sell_asset":"string","buy_amount":"string","buy_asset":"string","expires_at":"2024-01-29T19:37:08.995Z","price":"string","total_price":"string","creator":{"id":"string","account":"string","memo":"string"},"transaction_id":"string","created_at":"2024-01-29T19:37:08.995Z"},"customer":{"id":"string"}}},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Receive an Event","description":{"content":"Receive a JSON object representing an event.\n","type":"text/plain"},"url":{"path":["event"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null diff --git a/api/anchor-platform/callbacks/put-customer.api.mdx b/api/anchor-platform/callbacks/put-customer.api.mdx index c6e945c8c..54699acf0 100644 --- a/api/anchor-platform/callbacks/put-customer.api.mdx +++ b/api/anchor-platform/callbacks/put-customer.api.mdx @@ -5,7 +5,7 @@ description: "**The Anchor Platform does not persist any customer KYC data.**" sidebar_label: "Create or Update Customer Info" hide_title: true hide_table_of_contents: true -api: {"tags":["Customers","SEP-12","SEP-24","SEP-31"],"description":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","operationId":"putCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"ip_address":{"type":"string"},"sex":{"type":"string"}},"title":"PutCustomerRequest"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"title":"PutCustomerResponse"}}}},"400":{"description":"Invalid data.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"put","path":"/customer","jsonRequestBodyExample":{"id":"string","account":"string","memo":"string","memo_type":"id","type":"string","first_name":"string","last_name":"string","additional_name":"string","address_country_code":"string","state_or_province":"string","city":"string","postal_code":"string","address":"string","mobile_number":"string","email_address":"string","birth_date":"2023-11-30","birth_place":"string","birth_country_code":"string","bank_account_number":"string","bank_account_type":"string","bank_number":"string","bank_phone_number":"string","bank_branch_number":"string","tax_id":"string","tax_id_name":"string","occupation":"string","employer_name":"string","employer_address":"string","language_code":"string","id_type":"string","id_country_code":"string","id_issue_date":"2023-11-30","id_expiration_date":"2023-11-30","id_number":"string","ip_address":"string","sex":"string"},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Create or Update Customer Info","description":{"content":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Customers","SEP-12","SEP-24","SEP-31"],"description":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`. Requests containing only string fields will \nbe forwarded to the anchor as with the `application/json` content type. Requests containing\nbinary fields will be forwarded to the anchor as with the `multipart/form-data` content type.\n","operationId":"putCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"clabe_number":{"type":"string"},"cbu_alias":{"type":"string"},"crypto_address":{"type":"string"},"crypto_memo":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"ip_address":{"type":"string"},"sex":{"type":"string"},"referral_id":{"type":"string"}},"title":"PutCustomerRequest"}},"multipart/form-data":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"clabe_number":{"type":"string"},"cbu_alias":{"type":"string"},"crypto_address":{"type":"string"},"crypto_memo":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"photo_id_front":{"type":"file","format":"binary"},"photo_id_back":{"type":"file","format":"binary"},"notary_approval_of_photo_id":{"type":"file","format":"binary"},"ip_address":{"type":"string"},"photo_proof_residence":{"type":"file","format":"binary"},"sex":{"type":"string"},"photo_proof_of_income":{"type":"file","format":"binary"},"proof_of_liveness":{"type":"file","format":"binary"},"referral_id":{"type":"string"}},"title":"PutCustomerMultipartRequest"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"title":"PutCustomerResponse"}}}},"400":{"description":"Invalid data.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"put","path":"/customer","jsonRequestBodyExample":{"id":"string","account":"string","memo":"string","memo_type":"id","type":"string","first_name":"string","last_name":"string","additional_name":"string","address_country_code":"string","state_or_province":"string","city":"string","postal_code":"string","address":"string","mobile_number":"string","email_address":"string","birth_date":"2024-01-29","birth_place":"string","birth_country_code":"string","bank_account_number":"string","bank_account_type":"string","bank_number":"string","bank_phone_number":"string","bank_branch_number":"string","clabe_number":"string","cbu_alias":"string","crypto_address":"string","crypto_memo":"string","tax_id":"string","tax_id_name":"string","occupation":"string","employer_name":"string","employer_address":"string","language_code":"string","id_type":"string","id_country_code":"string","id_issue_date":"2024-01-29","id_expiration_date":"2024-01-29","id_number":"string","ip_address":"string","sex":"string","referral_id":"string"},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Create or Update Customer Info","description":{"content":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`. Requests containing only string fields will \nbe forwarded to the anchor as with the `application/json` content type. Requests containing\nbinary fields will be forwarded to the anchor as with the `multipart/form-data` content type.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"formdata","formdata":[]}}} sidebar_class_name: "put api-method" info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null @@ -35,10 +35,12 @@ The request and response for this endpoint are identical to the request and response defined in SEP-12. Client applications make requests with the following request body, which is forwarded to the anchor. Anchors -must validate and persist the data passed, and return the customer's `id`. +must validate and persist the data passed, and return the customer's `id`. Requests containing only string fields will +be forwarded to the anchor as with the `application/json` content type. Requests containing +binary fields will be forwarded to the anchor as with the `multipart/form-data` content type. -
    Request Body
    +
    Request Body
    Request Body
    Success. diff --git a/api/anchor-platform/resources/get-transaction.api.mdx b/api/anchor-platform/resources/get-transaction.api.mdx index 9a7199726..6f2b9662c 100644 --- a/api/anchor-platform/resources/get-transaction.api.mdx +++ b/api/anchor-platform/resources/get-transaction.api.mdx @@ -101,7 +101,7 @@ For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. For a SEP-6 Anchor, the `account` and `memo` fields should be used. -
    +
    Bad Request diff --git a/api/anchor-platform/resources/get-transactions.api.mdx b/api/anchor-platform/resources/get-transactions.api.mdx index 5926df722..af54f607f 100644 --- a/api/anchor-platform/resources/get-transactions.api.mdx +++ b/api/anchor-platform/resources/get-transactions.api.mdx @@ -101,7 +101,7 @@ For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. For a SEP-6 Anchor, the `account` and `memo` fields should be used. -
  • ]
  • +
  • ]
  • Bad Request diff --git a/openapi/anchor-platform/Callbacks API.yml b/openapi/anchor-platform/Callbacks API.yml index 2b43d0d92..2a24646fa 100644 --- a/openapi/anchor-platform/Callbacks API.yml +++ b/openapi/anchor-platform/Callbacks API.yml @@ -411,7 +411,9 @@ paths: request and response defined in SEP-12. Client applications make requests with the following request body, which is forwarded to the anchor. Anchors - must validate and persist the data passed, and return the customer's `id`. + must validate and persist the data passed, and return the customer's `id`. Requests containing only string fields will + be forwarded to the anchor as with the `application/json` content type. Requests containing + binary fields will be forwarded to the anchor as with the `multipart/form-data` content type. summary: Create or Update Customer Info operationId: putCustomer requestBody: @@ -419,6 +421,9 @@ paths: application/json: schema: $ref: './schemas.yml#/components/schemas/PutCustomerRequest' + multipart/form-data: + schema: + $ref: './schemas.yml#/components/schemas/PutCustomerMultipartRequest' responses: '200': description: Success. diff --git a/openapi/anchor-platform/bundled_callback.yml b/openapi/anchor-platform/bundled_callback.yml index 14465528a..a900153e8 100644 --- a/openapi/anchor-platform/bundled_callback.yml +++ b/openapi/anchor-platform/bundled_callback.yml @@ -410,7 +410,9 @@ paths: request and response defined in SEP-12. Client applications make requests with the following request body, which is forwarded to the anchor. Anchors - must validate and persist the data passed, and return the customer's `id`. + must validate and persist the data passed, and return the customer's `id`. Requests containing only string fields will + be forwarded to the anchor as with the `application/json` content type. Requests containing + binary fields will be forwarded to the anchor as with the `multipart/form-data` content type. summary: Create or Update Customer Info operationId: putCustomer requestBody: @@ -418,6 +420,9 @@ paths: application/json: schema: $ref: '#/components/schemas/PutCustomerRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PutCustomerMultipartRequest' responses: '200': description: Success. @@ -700,6 +705,14 @@ components: type: string bank_branch_number: type: string + clabe_number: + type: string + cbu_alias: + type: string + crypto_address: + type: string + crypto_memo: + type: string tax_id: type: string tax_id_name: @@ -728,6 +741,127 @@ components: type: string sex: type: string + referral_id: + type: string + PutCustomerMultipartRequest: + type: object + properties: + id: + description: The ID of the customer as returned in the response of a previous PUT request. + type: string + account: + description: The Stellar or Muxed Account authenticated with the Platform via SEP-10. + type: string + memo: + description: The memo value identifying a customer with a shared account, where the shared account is `account`. + type: string + memo_type: + description: The type of memo used to identify a customer with a shared account. + type: string + enum: + - id + - hash + - text + type: + description: | + The type of action the customer is being KYCd for. + See the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info. + For SEP-31 you can define your own types in the assets configuration. + For SEP-24 pre-defined value `sep24-customer` is used. + type: string + first_name: + type: string + last_name: + type: string + additional_name: + type: string + address_country_code: + type: string + state_or_province: + type: string + city: + type: string + postal_code: + type: string + address: + type: string + mobile_number: + type: string + email_address: + type: string + birth_date: + type: string + format: date + birth_place: + type: string + birth_country_code: + type: string + bank_account_number: + type: string + bank_account_type: + type: string + bank_number: + type: string + bank_phone_number: + type: string + bank_branch_number: + type: string + clabe_number: + type: string + cbu_alias: + type: string + crypto_address: + type: string + crypto_memo: + type: string + tax_id: + type: string + tax_id_name: + type: string + occupation: + type: string + employer_name: + type: string + employer_address: + type: string + language_code: + type: string + id_type: + type: string + id_country_code: + type: string + id_issue_date: + type: string + format: date + id_expiration_date: + type: string + format: date + id_number: + type: string + photo_id_front: + type: file + format: binary + photo_id_back: + type: file + format: binary + notary_approval_of_photo_id: + type: file + format: binary + ip_address: + type: string + photo_proof_residence: + type: file + format: binary + sex: + type: string + photo_proof_of_income: + type: file + format: binary + proof_of_liveness: + type: file + format: binary + referral_id: + type: string PutCustomerResponse: type: object properties: diff --git a/openapi/anchor-platform/schemas.yml b/openapi/anchor-platform/schemas.yml index 4ea344aac..bdf1d3894 100644 --- a/openapi/anchor-platform/schemas.yml +++ b/openapi/anchor-platform/schemas.yml @@ -73,6 +73,115 @@ components: type: string bank_branch_number: type: string + clabe_number: + type: string + cbu_alias: + type: string + crypto_address: + type: string + crypto_memo: + type: string + tax_id: + type: string + tax_id_name: + type: string + occupation: + type: string + employer_name: + type: string + employer_address: + type: string + language_code: + type: string + id_type: + type: string + id_country_code: + type: string + id_issue_date: + type: string + format: date + id_expiration_date: + type: string + format: date + id_number: + type: string + ip_address: + type: string + sex: + type: string + referral_id: + type: string + PutCustomerMultipartRequest: + type: object + properties: + id: + description: The ID of the customer as returned in the response of a previous PUT request. + type: string + account: + description: The Stellar or Muxed Account authenticated with the Platform via SEP-10. + type: string + memo: + description: The memo value identifying a customer with a shared account, where the shared account is `account`. + type: string + memo_type: + description: The type of memo used to identify a customer with a shared account. + type: string + enum: + - id + - hash + - text + type: + description: | + The type of action the customer is being KYCd for. + See the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info. + For SEP-31 you can define your own types in the assets configuration. + For SEP-24 pre-defined value `sep24-customer` is used. + type: string + first_name: + type: string + last_name: + type: string + additional_name: + type: string + address_country_code: + type: string + state_or_province: + type: string + city: + type: string + postal_code: + type: string + address: + type: string + mobile_number: + type: string + email_address: + type: string + birth_date: + type: string + format: date + birth_place: + type: string + birth_country_code: + type: string + bank_account_number: + type: string + bank_account_type: + type: string + bank_number: + type: string + bank_phone_number: + type: string + bank_branch_number: + type: string + clabe_number: + type: string + cbu_alias: + type: string + crypto_address: + type: string + crypto_memo: + type: string tax_id: type: string tax_id_name: @@ -97,10 +206,30 @@ components: format: date id_number: type: string + photo_id_front: + type: file + format: binary + photo_id_back: + type: file + format: binary + notary_approval_of_photo_id: + type: file + format: binary ip_address: type: string + photo_proof_residence: + type: file + format: binary sex: type: string + photo_proof_of_income: + type: file + format: binary + proof_of_liveness: + type: file + format: binary + referral_id: + type: string PutCustomerResponse: type: object