From 00e8b115c2e948f12563432ea80ed7c74f71ea61 Mon Sep 17 00:00:00 2001 From: Caio Teixeira Date: Mon, 8 Apr 2024 15:10:58 -0300 Subject: [PATCH] chore: update SDP docs build --- .../resources/authenticate-mfa.api.mdx | 2 +- .../resources/create-asset.api.mdx | 2 +- .../resources/create-disbursement.api.mdx | 2 +- .../stellar-disbursement-platform/resources/create-user.api.mdx | 2 +- .../resources/delete-asset.api.mdx | 2 +- .../resources/download-disbursement-instructions.api.mdx | 2 +- .../resources/forgot-password.api.mdx | 2 +- .../resources/get-all-assets.api.mdx | 2 +- .../resources/get-all-countries.api.mdx | 2 +- .../resources/get-all-roles.api.mdx | 2 +- .../resources/get-all-users.api.mdx | 2 +- .../resources/get-all-wallets.api.mdx | 2 +- .../resources/get-organization-info.api.mdx | 2 +- .../resources/get-organization-logo.api.mdx | 2 +- .../stellar-disbursement-platform/resources/get-profile.api.mdx | 2 +- .../resources/list-all-disbursement-receivers.api.mdx | 2 +- .../resources/list-all-disbursements.api.mdx | 2 +- .../resources/list-all-payments.api.mdx | 2 +- .../resources/list-all-receivers.api.mdx | 2 +- network/stellar-disbursement-platform/resources/log-in.api.mdx | 2 +- .../resources/provide-signed-challenge-transaction.api.mdx | 2 +- .../resources/refresh-token.api.mdx | 2 +- .../resources/request-challenge-transaction.api.mdx | 2 +- .../resources/request-registration-url.api.mdx | 2 +- .../resources/reset-password.api.mdx | 2 +- .../resources/retrieve-a-disbursement.api.mdx | 2 +- .../resources/retrieve-a-payment.api.mdx | 2 +- .../resources/retrieve-a-receiver.api.mdx | 2 +- .../resources/retrieve-all-statistics.api.mdx | 2 +- .../resources/retrieve-disbursement-statistics.api.mdx | 2 +- .../resources/retrieve-stellar-info-file.api.mdx | 2 +- .../resources/send-one-time-passcode.api.mdx | 2 +- .../resources/start-wallet-registration.api.mdx | 2 +- .../resources/update-a-disbursement-status.api.mdx | 2 +- .../resources/update-a-receiver.api.mdx | 2 +- .../resources/update-organization-profile.api.mdx | 2 +- .../resources/update-user-activation-status.api.mdx | 2 +- .../resources/update-user-profile.api.mdx | 2 +- .../resources/update-user-role.api.mdx | 2 +- .../resources/upload-disbursement-instructions.api.mdx | 2 +- .../resources/verify-receiver-registration.api.mdx | 2 +- 41 files changed, 41 insertions(+), 41 deletions(-) diff --git a/network/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx b/network/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx index 33664e4e2..bdb225036 100644 --- a/network/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx +++ b/network/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx @@ -5,7 +5,7 @@ description: "Governs the multi-factor authentication process for SDP user login sidebar_label: "Provide Multi-Factor Authentication" hide_title: true hide_table_of_contents: true -api: {"description":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","operationId":"authenticateMFA","tags":["Authentication"],"parameters":[{"in":"header","name":"Device-ID","required":false,"description":"Identifier of the device","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mfa_code":{"type":"string","description":"Multi-factor authentication code"},"remember_me":{"type":"boolean","description":"Boolean flag to remember the user"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true."}},"required":["mfa_code"]}}},"description":"MFA request data","required":true},"responses":{"200":{"description":"Successful authentication","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Authentication token"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"post","path":"/mfa","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"mfa_code":"string","remember_me":true,"recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Provide Multi-Factor Authentication","description":{"content":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","type":"text/plain"},"url":{"path":["mfa"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Identifier of the device","type":"text/plain"},"key":"Device-ID","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","operationId":"authenticateMFA","tags":["Authentication"],"parameters":[{"in":"header","name":"Device-ID","required":false,"description":"Identifier of the device","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mfa_code":{"type":"string","description":"Multi-factor authentication code"},"remember_me":{"type":"boolean","description":"Boolean flag to remember the user"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true."}},"required":["mfa_code"]}}},"description":"MFA request data","required":true},"responses":{"200":{"description":"Successful authentication","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Authentication token"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"post","path":"/mfa","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"mfa_code":"string","remember_me":true,"recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Provide Multi-Factor Authentication","description":{"content":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","type":"text/plain"},"url":{"path":["mfa"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Identifier of the device","type":"text/plain"},"key":"Device-ID","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/create-asset.api.mdx b/network/stellar-disbursement-platform/resources/create-asset.api.mdx index 605bdadf6..183a28cfc 100644 --- a/network/stellar-disbursement-platform/resources/create-asset.api.mdx +++ b/network/stellar-disbursement-platform/resources/create-asset.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint is used to create a new asset that can be used in a sidebar_label: "Create Asset" hide_title: true hide_table_of_contents: true -api: {"description":"This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","tags":["Organization"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The asset code","example":"USDC"},"issuer":{"type":"string","description":"The issuer","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"}},"required":["code","issuer"]}}},"description":"Asset to be created","required":true},"responses":{"201":{"description":"Asset created successfully"},"400":{"description":"Bad request, invalid request body or the provided code/issuer is invalid."}},"security":[{"BearerAuth":[]}],"method":"post","path":"/assets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"code":"USDC","issuer":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create Asset","description":{"content":"This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"description":"This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","tags":["Organization"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The asset code","example":"USDC"},"issuer":{"type":"string","description":"The issuer","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"}},"required":["code","issuer"]}}},"description":"Asset to be created","required":true},"responses":{"201":{"description":"Asset created successfully"},"400":{"description":"Bad request, invalid request body or the provided code/issuer is invalid."}},"security":[{"BearerAuth":[]}],"method":"post","path":"/assets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"code":"USDC","issuer":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create Asset","description":{"content":"This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/create-disbursement.api.mdx b/network/stellar-disbursement-platform/resources/create-disbursement.api.mdx index 946b7fa2a..29c78ed9f 100644 --- a/network/stellar-disbursement-platform/resources/create-disbursement.api.mdx +++ b/network/stellar-disbursement-platform/resources/create-disbursement.api.mdx @@ -5,7 +5,7 @@ description: "Creates a new disbursement in ```draft``` state with basic details sidebar_label: "Create Disbursement" hide_title: true hide_table_of_contents: true -api: {"responses":{"201":{"description":"A new disbursement","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Three-character ISO 3166 code","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Bad request","extras":{"status":400,"message":"Invalid country code provided"}}},"examples":{"response":{"value":{"error":"Bad request","extras":{"status":400,"message":"Invalid country code provided"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Create Disbursement","description":"Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```.","tags":["Disbursements"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"wallet_id":{"type":"string"},"asset_id":{"type":"string"},"country_code":{"type":"string","description":"Three-character ISO 3166 code"}},"example":{"name":"My New Disbursement name","wallet_id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","asset_id":"d227a68c-2f40-11ee-be56-0242ac120002","country_code":"UKR"}}}}},"security":[{"BearerAuth":[]}],"method":"post","path":"/disbursements","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"name":"My New Disbursement name","wallet_id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","asset_id":"d227a68c-2f40-11ee-be56-0242ac120002","country_code":"UKR"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create Disbursement","description":{"content":"Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```.","type":"text/plain"},"url":{"path":["disbursements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"201":{"description":"A new disbursement","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Three-character ISO 3166 code","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Bad request","extras":{"status":400,"message":"Invalid country code provided"}}},"examples":{"response":{"value":{"error":"Bad request","extras":{"status":400,"message":"Invalid country code provided"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Create Disbursement","description":"Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```.","tags":["Disbursements"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"wallet_id":{"type":"string"},"asset_id":{"type":"string"},"country_code":{"type":"string","description":"Three-character ISO 3166 code"}},"example":{"name":"My New Disbursement name","wallet_id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","asset_id":"d227a68c-2f40-11ee-be56-0242ac120002","country_code":"UKR"}}}}},"security":[{"BearerAuth":[]}],"method":"post","path":"/disbursements","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"name":"My New Disbursement name","wallet_id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","asset_id":"d227a68c-2f40-11ee-be56-0242ac120002","country_code":"UKR"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create Disbursement","description":{"content":"Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```.","type":"text/plain"},"url":{"path":["disbursements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/create-user.api.mdx b/network/stellar-disbursement-platform/resources/create-user.api.mdx index 29799d61b..b17012f57 100644 --- a/network/stellar-disbursement-platform/resources/create-user.api.mdx +++ b/network/stellar-disbursement-platform/resources/create-user.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint creates a new SDP user as the result of an SDP owner sidebar_label: "Create User" hide_title: true hide_table_of_contents: true -api: {"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Create User","description":"This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"email":{"type":"string"}},"example":{"first_name":"John","last_name":"Doe","roles":["business"],"email":"email@email.com"}}}}},"security":[{"BearerAuth":[]}],"method":"post","path":"/users","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"first_name":"John","last_name":"Doe","roles":["business"],"email":"email@email.com"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create User","description":{"content":"This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Create User","description":"This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"email":{"type":"string"}},"example":{"first_name":"John","last_name":"Doe","roles":["business"],"email":"email@email.com"}}}}},"security":[{"BearerAuth":[]}],"method":"post","path":"/users","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"first_name":"John","last_name":"Doe","roles":["business"],"email":"email@email.com"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create User","description":{"content":"This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/delete-asset.api.mdx b/network/stellar-disbursement-platform/resources/delete-asset.api.mdx index 9d77b60c5..021f2682a 100644 --- a/network/stellar-disbursement-platform/resources/delete-asset.api.mdx +++ b/network/stellar-disbursement-platform/resources/delete-asset.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint is used to soft delete an asset." sidebar_label: "Delete Asset" hide_title: true hide_table_of_contents: true -api: {"description":"This endpoint is used to soft delete an asset.","tags":["Organization"],"parameters":[{"name":"id","in":"path","description":"ID of the asset to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Asset deleted successfully"},"204":{"description":"Asset already deleted"},"404":{"description":"Asset not found"}},"security":[{"BearerAuth":[]}],"method":"delete","path":"/assets/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Delete Asset","description":{"content":"This endpoint is used to soft delete an asset.","type":"text/plain"},"url":{"path":["assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the asset to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"description":"This endpoint is used to soft delete an asset.","tags":["Organization"],"parameters":[{"name":"id","in":"path","description":"ID of the asset to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Asset deleted successfully"},"204":{"description":"Asset already deleted"},"404":{"description":"Asset not found"}},"security":[{"BearerAuth":[]}],"method":"delete","path":"/assets/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Delete Asset","description":{"content":"This endpoint is used to soft delete an asset.","type":"text/plain"},"url":{"path":["assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the asset to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/download-disbursement-instructions.api.mdx b/network/stellar-disbursement-platform/resources/download-disbursement-instructions.api.mdx index 52b528ddf..d6a2a6c6a 100644 --- a/network/stellar-disbursement-platform/resources/download-disbursement-instructions.api.mdx +++ b/network/stellar-disbursement-platform/resources/download-disbursement-instructions.api.mdx @@ -5,7 +5,7 @@ description: "Allows an SDP user to download the raw CSV file that was uploaded sidebar_label: "Download Disbursement Instructions" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Disbursement CSV file","headers":{"Content-Disposition":{"description":"The filename of the returned CSV file.","schema":{"type":"string"}},"Content-Type":{"description":"text/csv","schema":{"type":"string"}}},"content":{"text/csv":{"examples":{"response":{"value":""}}}}},"400":{"description":"Bad Request","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"foo":{"type":"string"},"message":{"type":"string"}}}},"example":{"error":"Invalid request","extras":{"foo":"bar","message":"Invalid request parameters"}}}},"application/json":{"examples":{"response":{"value":{"error":"Invalid request","extras":{"foo":"bar","message":"Invalid request parameters"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}},"application/json":{"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}}},"application/json":{"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}},"application/json":{"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Download Disbursement Instructions","description":"Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}/instructions","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Download Disbursement Instructions","description":{"content":"Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement.","type":"text/plain"},"url":{"path":["disbursements",":id","instructions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Disbursement CSV file","headers":{"Content-Disposition":{"description":"The filename of the returned CSV file.","schema":{"type":"string"}},"Content-Type":{"description":"text/csv","schema":{"type":"string"}}},"content":{"text/csv":{"examples":{"response":{"value":""}}}}},"400":{"description":"Bad Request","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"foo":{"type":"string"},"message":{"type":"string"}}}},"example":{"error":"Invalid request","extras":{"foo":"bar","message":"Invalid request parameters"}}}},"application/json":{"examples":{"response":{"value":{"error":"Invalid request","extras":{"foo":"bar","message":"Invalid request parameters"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}},"application/json":{"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}}},"application/json":{"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}},"application/json":{"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Download Disbursement Instructions","description":"Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}/instructions","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Download Disbursement Instructions","description":{"content":"Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement.","type":"text/plain"},"url":{"path":["disbursements",":id","instructions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/forgot-password.api.mdx b/network/stellar-disbursement-platform/resources/forgot-password.api.mdx index 065d5c2c8..ba7089bec 100644 --- a/network/stellar-disbursement-platform/resources/forgot-password.api.mdx +++ b/network/stellar-disbursement-platform/resources/forgot-password.api.mdx @@ -5,7 +5,7 @@ description: "Sends an email with a token to an SDP user who has gone through th sidebar_label: "Forgot Password" hide_title: true hide_table_of_contents: true -api: {"description":"Sends an email with a token to an SDP user who has gone through the Forgot Password process.","operationId":"forgotPassword","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Email of the user"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation"}},"required":["email"]}}},"description":"Forgot password request data","required":true},"responses":{"200":{"description":"Forgot password email sent successfully","content":{"*/*":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}}},"method":"post","path":"/forgot-password","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"email":"user@example.com","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Forgot Password","description":{"content":"Sends an email with a token to an SDP user who has gone through the Forgot Password process.","type":"text/plain"},"url":{"path":["forgot-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Sends an email with a token to an SDP user who has gone through the Forgot Password process.","operationId":"forgotPassword","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Email of the user"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation"}},"required":["email"]}}},"description":"Forgot password request data","required":true},"responses":{"200":{"description":"Forgot password email sent successfully","content":{"*/*":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}}},"method":"post","path":"/forgot-password","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"email":"user@example.com","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Forgot Password","description":{"content":"Sends an email with a token to an SDP user who has gone through the Forgot Password process.","type":"text/plain"},"url":{"path":["forgot-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/get-all-assets.api.mdx b/network/stellar-disbursement-platform/resources/get-all-assets.api.mdx index 180db29fd..ffeeec195 100644 --- a/network/stellar-disbursement-platform/resources/get-all-assets.api.mdx +++ b/network/stellar-disbursement-platform/resources/get-all-assets.api.mdx @@ -5,7 +5,7 @@ description: "Fetches the list of available assets to populate the dropdown box sidebar_label: "Get All Assets" hide_title: true hide_table_of_contents: true -api: {"description":"Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","tags":["Organization"],"responses":{"200":{"description":"A list of assets","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/assets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Assets","description":{"content":"Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"description":"Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","tags":["Organization"],"responses":{"200":{"description":"A list of assets","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/assets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Assets","description":{"content":"Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/get-all-countries.api.mdx b/network/stellar-disbursement-platform/resources/get-all-countries.api.mdx index 680d488df..e9b96e54e 100644 --- a/network/stellar-disbursement-platform/resources/get-all-countries.api.mdx +++ b/network/stellar-disbursement-platform/resources/get-all-countries.api.mdx @@ -5,7 +5,7 @@ description: "Fetches the list of available countries to populate the dropdown b sidebar_label: "Get All Countries" hide_title: true hide_table_of_contents: true -api: {"description":"Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers.","tags":["Organization"],"responses":{"200":{"description":"A list of countries","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Three-character ISO 3166 code","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/countries","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Countries","description":{"content":"Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers.","type":"text/plain"},"url":{"path":["countries"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"description":"Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers.","tags":["Organization"],"responses":{"200":{"description":"A list of countries","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Three-character ISO 3166 code","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/countries","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Countries","description":{"content":"Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers.","type":"text/plain"},"url":{"path":["countries"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/get-all-roles.api.mdx b/network/stellar-disbursement-platform/resources/get-all-roles.api.mdx index 9ad030534..d83fbd58e 100644 --- a/network/stellar-disbursement-platform/resources/get-all-roles.api.mdx +++ b/network/stellar-disbursement-platform/resources/get-all-roles.api.mdx @@ -5,7 +5,7 @@ description: "Fetches available SDP roles, such as owner, financial controller, sidebar_label: "Get All Roles" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}}},"example":{"roles":["developer","financial_controller","business","owner"]}},"examples":{"response":{"value":{"roles":["developer","financial_controller","business","owner"]}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Get All Roles","description":"Fetches available SDP roles, such as owner, financial controller, business user, and developer.","tags":["Users"],"security":[{"BearerAuth":[]}],"method":"get","path":"/users/roles","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Roles","description":{"content":"Fetches available SDP roles, such as owner, financial controller, business user, and developer.","type":"text/plain"},"url":{"path":["users","roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}}},"example":{"roles":["developer","financial_controller","business","owner"]}},"examples":{"response":{"value":{"roles":["developer","financial_controller","business","owner"]}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Get All Roles","description":"Fetches available SDP roles, such as owner, financial controller, business user, and developer.","tags":["Users"],"security":[{"BearerAuth":[]}],"method":"get","path":"/users/roles","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Roles","description":{"content":"Fetches available SDP roles, such as owner, financial controller, business user, and developer.","type":"text/plain"},"url":{"path":["users","roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/get-all-users.api.mdx b/network/stellar-disbursement-platform/resources/get-all-users.api.mdx index 5b85651fd..1a7a4f942 100644 --- a/network/stellar-disbursement-platform/resources/get-all-users.api.mdx +++ b/network/stellar-disbursement-platform/resources/get-all-users.api.mdx @@ -5,7 +5,7 @@ description: "Fetches all SDP users within the organization, whether they are ac sidebar_label: "Get All Users" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Returns a paginated list of User Details","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Get All Users","description":"Fetches all SDP users within the organization, whether they are active yet or not.","tags":["Users"],"security":[{"BearerAuth":[]}],"method":"get","path":"/users","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Users","description":{"content":"Fetches all SDP users within the organization, whether they are active yet or not.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Returns a paginated list of User Details","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Get All Users","description":"Fetches all SDP users within the organization, whether they are active yet or not.","tags":["Users"],"security":[{"BearerAuth":[]}],"method":"get","path":"/users","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Users","description":{"content":"Fetches all SDP users within the organization, whether they are active yet or not.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/get-all-wallets.api.mdx b/network/stellar-disbursement-platform/resources/get-all-wallets.api.mdx index 7dd6dce54..efdf373e9 100644 --- a/network/stellar-disbursement-platform/resources/get-all-wallets.api.mdx +++ b/network/stellar-disbursement-platform/resources/get-all-wallets.api.mdx @@ -5,7 +5,7 @@ description: "Fetches the list of available wallet providers to populate the dro sidebar_label: "Get All Wallets" hide_title: true hide_table_of_contents: true -api: {"description":"Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets.","tags":["Organization"],"responses":{"200":{"description":"A list of wallets","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/wallets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Wallets","description":{"content":"Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets.","type":"text/plain"},"url":{"path":["wallets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"description":"Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets.","tags":["Organization"],"responses":{"200":{"description":"A list of wallets","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/wallets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Wallets","description":{"content":"Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets.","type":"text/plain"},"url":{"path":["wallets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/get-organization-info.api.mdx b/network/stellar-disbursement-platform/resources/get-organization-info.api.mdx index 7131664ee..94d507be4 100644 --- a/network/stellar-disbursement-platform/resources/get-organization-info.api.mdx +++ b/network/stellar-disbursement-platform/resources/get-organization-info.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint returns the organization's info. It is used in many sidebar_label: "Get Organization Info" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Returns organization details","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Stellar Aid"},"logo_url":{"type":"string","example":"https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo"},"distribution_account_public_key":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"timezone_utc_offset":{"type":"string","example":"+00:00"},"is_approval_required":{"description":"Enables multi-user approval workflow for disbursements","type":"boolean","example":true},"sms_registration_message_template":{"description":"The custom SMS message template set for the registration invite. The `default` message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.RegistrationLink}} which is the link generated by SDP to send to the receiver (in case this is not present in the message, it's automatically appended at the end).","type":"string","example":"You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register."},"otp_message_template":{"description":"The custom OTP message template set to send OTP code to the receiver complete the registration flow. The `default` message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.OTP}} which is the OTP code to send to the receiver complete the registration flow (in case this is not present in the message, it's automatically appended at the end).","type":"string","example":"{{.OTP}} is your {{.OrganizationName}} phone verification code."}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"operationId":"Get Organization Info","description":"This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.","tags":["Organization"],"security":[{"BearerAuth":[]}],"method":"get","path":"/organization","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get Organization Info","description":{"content":"This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.","type":"text/plain"},"url":{"path":["organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Returns organization details","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Stellar Aid"},"logo_url":{"type":"string","example":"https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo"},"distribution_account_public_key":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"timezone_utc_offset":{"type":"string","example":"+00:00"},"is_approval_required":{"description":"Enables multi-user approval workflow for disbursements","type":"boolean","example":true},"sms_registration_message_template":{"description":"The custom SMS message template set for the registration invite. The `default` message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.RegistrationLink}} which is the link generated by SDP to send to the receiver (in case this is not present in the message, it's automatically appended at the end).","type":"string","example":"You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register."},"otp_message_template":{"description":"The custom OTP message template set to send OTP code to the receiver complete the registration flow. The `default` message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.OTP}} which is the OTP code to send to the receiver complete the registration flow (in case this is not present in the message, it's automatically appended at the end).","type":"string","example":"{{.OTP}} is your {{.OrganizationName}} phone verification code."}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"operationId":"Get Organization Info","description":"This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.","tags":["Organization"],"security":[{"BearerAuth":[]}],"method":"get","path":"/organization","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get Organization Info","description":{"content":"This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.","type":"text/plain"},"url":{"path":["organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/get-organization-logo.api.mdx b/network/stellar-disbursement-platform/resources/get-organization-logo.api.mdx index 2c8256ad0..5ee2b0bf9 100644 --- a/network/stellar-disbursement-platform/resources/get-organization-logo.api.mdx +++ b/network/stellar-disbursement-platform/resources/get-organization-logo.api.mdx @@ -5,7 +5,7 @@ description: "Retrieves the logo of the organization for display in the UI navba sidebar_label: "Retrieve Organization Logo" hide_title: true hide_table_of_contents: true -api: {"description":"Retrieves the logo of the organization for display in the UI navbar.","operationId":"GetOrganizationLogo","tags":["Organization"],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"method":"get","path":"/organization/logo","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Organization Logo","description":{"content":"Retrieves the logo of the organization for display in the UI navbar.","type":"text/plain"},"url":{"path":["organization","logo"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/octet-stream"}],"method":"GET"}} +api: {"description":"Retrieves the logo of the organization for display in the UI navbar.","operationId":"GetOrganizationLogo","tags":["Organization"],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"method":"get","path":"/organization/logo","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Organization Logo","description":{"content":"Retrieves the logo of the organization for display in the UI navbar.","type":"text/plain"},"url":{"path":["organization","logo"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/octet-stream"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/get-profile.api.mdx b/network/stellar-disbursement-platform/resources/get-profile.api.mdx index d035900f9..9e58a1af0 100644 --- a/network/stellar-disbursement-platform/resources/get-profile.api.mdx +++ b/network/stellar-disbursement-platform/resources/get-profile.api.mdx @@ -5,7 +5,7 @@ description: "Fetches the individual information of the logged in user to popula sidebar_label: "Get Profile" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Returns user profile","content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","example":"Jane"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string","example":"jdoe@mail.org"},"roles":{"type":"array","items":{"type":"string"}},"organization_name":{"type":"string"}},"example":{"first_name":"Jane","last_name":"Doe","email":"jdoe@mail.org","roles":["developer"],"organization_name":"Stellar Aid"}}}}}},"operationId":"Get Profile","description":"Fetches the individual information of the logged in user to populate the Profile page.","tags":["Profile"],"security":[{"BearerAuth":[]}],"method":"get","path":"/profile","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get Profile","description":{"content":"Fetches the individual information of the logged in user to populate the Profile page.","type":"text/plain"},"url":{"path":["profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Returns user profile","content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","example":"Jane"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string","example":"jdoe@mail.org"},"roles":{"type":"array","items":{"type":"string"}},"organization_name":{"type":"string"}},"example":{"first_name":"Jane","last_name":"Doe","email":"jdoe@mail.org","roles":["developer"],"organization_name":"Stellar Aid"}}}}}},"operationId":"Get Profile","description":"Fetches the individual information of the logged in user to populate the Profile page.","tags":["Profile"],"security":[{"BearerAuth":[]}],"method":"get","path":"/profile","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get Profile","description":{"content":"Fetches the individual information of the logged in user to populate the Profile page.","type":"text/plain"},"url":{"path":["profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx b/network/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx index a020f23f1..6ec325502 100644 --- a/network/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx +++ b/network/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx @@ -5,7 +5,7 @@ description: "Fetches a list of receivers within a specific disbursement using t sidebar_label: "List All Disbursement Receivers" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"A list of Disbursement Receivers","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec3a57c0-5660-4b5a-af76-acadc7b09b93"},"email":{"type":"string","example":"receiver@mail.org"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr129001"},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}},"payment":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"List All Disbursement Receivers","description":"Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page number to fetch.","required":false,"schema":{"type":"number"}},{"name":"page_limit","in":"query","description":"The number of records to return per page.","required":false,"schema":{"type":"number"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}/receivers","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Disbursement Receivers","description":{"content":"Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination.","type":"text/plain"},"url":{"path":["disbursements",":id","receivers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page number to fetch.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"The number of records to return per page.","type":"text/plain"},"key":"page_limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"A list of Disbursement Receivers","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec3a57c0-5660-4b5a-af76-acadc7b09b93"},"email":{"type":"string","example":"receiver@mail.org"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr129001"},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}},"payment":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"List All Disbursement Receivers","description":"Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page number to fetch.","required":false,"schema":{"type":"number"}},{"name":"page_limit","in":"query","description":"The number of records to return per page.","required":false,"schema":{"type":"number"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}/receivers","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Disbursement Receivers","description":{"content":"Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination.","type":"text/plain"},"url":{"path":["disbursements",":id","receivers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page number to fetch.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"The number of records to return per page.","type":"text/plain"},"key":"page_limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx b/network/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx index 42bfbc75e..5c8c8ad88 100644 --- a/network/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx +++ b/network/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx @@ -5,7 +5,7 @@ description: "Fetches all disbursements the organization has created. This endpo sidebar_label: "List All Disbursements" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"A list of Disbursement details","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Three-character ISO 3166 code","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}},"example":{"pagination":{"next":"/disbursements?page=3&page_limit=1","prev":"/disbursements?page=1&page_limit=1","pages":4,"total":4},"data":{"id":"619da857-8725-4c58-933d-c120a458e0f5","name":"Disbursement Name","country":{"code":"UKR","name":"Ukraine","created_at":"2023-02-03T10:45:51.000Z","updated_at":"2023-02-03T10:45:51.000Z"},"wallet":{"id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","name":"Vibrant","homepage":"https://vibrantapp.com"},"asset":{"id":"25923001-508a-4629-9186-c41211b2a3d0","code":"USDC","issuer":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"status":"READY","verification_field":"DATE_OF_BIRTH","status_history":[{"user_id":null,"status":"DRAFT","timestamp":"2023-02-03T10:45:51.000Z"},{"user_id":"2ec7f1f9-add3-4e6d-9d14-bd8ac5e88872","status":"READY","timestamp":"2023-02-03T10:45:51.000Z"}],"file_name":"disbursement-february-03-2023.csv","created_at":"2023-02-03T10:45:51.000Z","updated_at":"2023-02-03T10:45:51.000Z","total_payments":10,"total_payments_sent":8,"total_payments_failed":1,"total_payments_remaining":1,"amount_disbursed":"800.00","total_amount":"1000.00","average_amount":"100.00"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Disbursements","description":"Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.","tags":["Disbursements"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"q","in":"query","description":"A search term used to query through the disbursement names.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Exact match on the status of the disbursement.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]}},{"name":"created_at_after","in":"query","description":"Only return disbursements that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return disbursements that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort disbursements","required":false,"schema":{"type":"string","enum":["name","created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting disbursements.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Disbursements","description":{"content":"Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.","type":"text/plain"},"url":{"path":["disbursements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"A search term used to query through the disbursement names.","type":"text/plain"},"key":"q","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the disbursement.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Only return disbursements that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return disbursements that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort disbursements","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting disbursements.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"A list of Disbursement details","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Three-character ISO 3166 code","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}},"example":{"pagination":{"next":"/disbursements?page=3&page_limit=1","prev":"/disbursements?page=1&page_limit=1","pages":4,"total":4},"data":{"id":"619da857-8725-4c58-933d-c120a458e0f5","name":"Disbursement Name","country":{"code":"UKR","name":"Ukraine","created_at":"2023-02-03T10:45:51.000Z","updated_at":"2023-02-03T10:45:51.000Z"},"wallet":{"id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","name":"Vibrant","homepage":"https://vibrantapp.com"},"asset":{"id":"25923001-508a-4629-9186-c41211b2a3d0","code":"USDC","issuer":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"status":"READY","verification_field":"DATE_OF_BIRTH","status_history":[{"user_id":null,"status":"DRAFT","timestamp":"2023-02-03T10:45:51.000Z"},{"user_id":"2ec7f1f9-add3-4e6d-9d14-bd8ac5e88872","status":"READY","timestamp":"2023-02-03T10:45:51.000Z"}],"file_name":"disbursement-february-03-2023.csv","created_at":"2023-02-03T10:45:51.000Z","updated_at":"2023-02-03T10:45:51.000Z","total_payments":10,"total_payments_sent":8,"total_payments_failed":1,"total_payments_remaining":1,"amount_disbursed":"800.00","total_amount":"1000.00","average_amount":"100.00"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Disbursements","description":"Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.","tags":["Disbursements"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"q","in":"query","description":"A search term used to query through the disbursement names.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Exact match on the status of the disbursement.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]}},{"name":"created_at_after","in":"query","description":"Only return disbursements that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return disbursements that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort disbursements","required":false,"schema":{"type":"string","enum":["name","created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting disbursements.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Disbursements","description":{"content":"Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.","type":"text/plain"},"url":{"path":["disbursements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"A search term used to query through the disbursement names.","type":"text/plain"},"key":"q","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the disbursement.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Only return disbursements that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return disbursements that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort disbursements","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting disbursements.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/list-all-payments.api.mdx b/network/stellar-disbursement-platform/resources/list-all-payments.api.mdx index 1b1c34aa1..4a9d08425 100644 --- a/network/stellar-disbursement-platform/resources/list-all-payments.api.mdx +++ b/network/stellar-disbursement-platform/resources/list-all-payments.api.mdx @@ -5,7 +5,7 @@ description: "Returns all individual payments matching the request criteria. Thi sidebar_label: "List All Payments" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"A paginated list of payments","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Payments","description":"Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.","tags":["Payments"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"status","in":"query","description":"Exact match on the status of the payment.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]}},{"name":"receiver_id","in":"query","description":"UUID that represents a receiver in the database","required":false,"example":"b6b667ad-6cc2-46cf-9be7-561daace7d48","schema":{"type":"string"}},{"name":"created_at_after","in":"query","description":"Only return payments that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return payments that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort payments","required":false,"schema":{"type":"string","enum":["created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting payments.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/payments","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Payments","description":{"content":"Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.","type":"text/plain"},"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the payment.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"UUID that represents a receiver in the database","type":"text/plain"},"key":"receiver_id","value":""},{"disabled":false,"description":{"content":"Only return payments that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return payments that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort payments","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting payments.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"A paginated list of payments","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Payments","description":"Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.","tags":["Payments"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"status","in":"query","description":"Exact match on the status of the payment.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]}},{"name":"receiver_id","in":"query","description":"UUID that represents a receiver in the database","required":false,"example":"b6b667ad-6cc2-46cf-9be7-561daace7d48","schema":{"type":"string"}},{"name":"created_at_after","in":"query","description":"Only return payments that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return payments that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort payments","required":false,"schema":{"type":"string","enum":["created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting payments.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/payments","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Payments","description":{"content":"Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.","type":"text/plain"},"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the payment.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"UUID that represents a receiver in the database","type":"text/plain"},"key":"receiver_id","value":""},{"disabled":false,"description":{"content":"Only return payments that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return payments that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort payments","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting payments.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/list-all-receivers.api.mdx b/network/stellar-disbursement-platform/resources/list-all-receivers.api.mdx index bb41824a8..792eb182d 100644 --- a/network/stellar-disbursement-platform/resources/list-all-receivers.api.mdx +++ b/network/stellar-disbursement-platform/resources/list-all-receivers.api.mdx @@ -5,7 +5,7 @@ description: "Returns all receivers matching the request criteria. This endpoint sidebar_label: "List All Receivers" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"A paginated list of Receiver details","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Receivers","description":"Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver.","tags":["Receivers"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"q","in":"query","description":"A search term used to query through the receiver phone_number, email, and ID.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Exact match on the status of the receiver wallet.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}},{"name":"created_at_after","in":"query","description":"Only return receivers that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return receivers that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort receivers","required":false,"schema":{"type":"string","enum":["created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting receivers.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/receivers","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Receivers","description":{"content":"Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver.","type":"text/plain"},"url":{"path":["receivers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"A search term used to query through the receiver phone_number, email, and ID.","type":"text/plain"},"key":"q","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the receiver wallet.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Only return receivers that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return receivers that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort receivers","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting receivers.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"A paginated list of Receiver details","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Receivers","description":"Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver.","tags":["Receivers"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"q","in":"query","description":"A search term used to query through the receiver phone_number, email, and ID.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Exact match on the status of the receiver wallet.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}},{"name":"created_at_after","in":"query","description":"Only return receivers that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return receivers that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort receivers","required":false,"schema":{"type":"string","enum":["created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting receivers.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/receivers","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Receivers","description":{"content":"Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver.","type":"text/plain"},"url":{"path":["receivers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"A search term used to query through the receiver phone_number, email, and ID.","type":"text/plain"},"key":"q","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the receiver wallet.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Only return receivers that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return receivers that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort receivers","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting receivers.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/log-in.api.mdx b/network/stellar-disbursement-platform/resources/log-in.api.mdx index e3fe97568..224ded8ff 100644 --- a/network/stellar-disbursement-platform/resources/log-in.api.mdx +++ b/network/stellar-disbursement-platform/resources/log-in.api.mdx @@ -5,7 +5,7 @@ description: "Allows credentialed SDP users to log in to the SDP dashboard with sidebar_label: "Log In" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}},"examples":{"response":{"value":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}}}}}}},"operationId":"Log In","description":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true."}},"required":["email","password"],"example":{"email":"johndoe@mail.com","password":"mysecret"}}}}},"method":"post","path":"/login","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"email":"johndoe@mail.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Log In","description":{"content":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","type":"text/plain"},"url":{"path":["login"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}},"examples":{"response":{"value":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}}}}}}},"operationId":"Log In","description":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true."}},"required":["email","password"],"example":{"email":"johndoe@mail.com","password":"mysecret"}}}}},"method":"post","path":"/login","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"email":"johndoe@mail.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Log In","description":{"content":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","type":"text/plain"},"url":{"path":["login"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/provide-signed-challenge-transaction.api.mdx b/network/stellar-disbursement-platform/resources/provide-signed-challenge-transaction.api.mdx index d80e7098c..9b752d974 100644 --- a/network/stellar-disbursement-platform/resources/provide-signed-challenge-transaction.api.mdx +++ b/network/stellar-disbursement-platform/resources/provide-signed-challenge-transaction.api.mdx @@ -5,7 +5,7 @@ description: "Allows the wallet to post the signed SEP-10 challenge transaction. sidebar_label: "Provide Signed Challenge Transaction" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"SEP-10 handshake was successful.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"The provided transaction is not valid"}},"examples":{"response":{"value":{"error":"The provided transaction is not valid"}}}}}}},"operationId":"Provide Signed Challenge Transaction","description":"Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable.","tags":["Registration"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"string"}},"example":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAvheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3AsiYk3UAAABArIrkvqmA0V9lIZcVyCUdja6CiwkPwsV8BfI4CZOyR1Oq7ysvNJWwY0G42dpxN9OP1qz4dum8apG2hqvxVWjkDQ=="}}}}},"method":"post","path":"/WEB_AUTH_ENDPOINT","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAvheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3AsiYk3UAAABArIrkvqmA0V9lIZcVyCUdja6CiwkPwsV8BfI4CZOyR1Oq7ysvNJWwY0G42dpxN9OP1qz4dum8apG2hqvxVWjkDQ=="},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Provide Signed Challenge Transaction","description":{"content":"Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable.","type":"text/plain"},"url":{"path":["WEB_AUTH_ENDPOINT"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"responses":{"200":{"description":"SEP-10 handshake was successful.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"The provided transaction is not valid"}},"examples":{"response":{"value":{"error":"The provided transaction is not valid"}}}}}}},"operationId":"Provide Signed Challenge Transaction","description":"Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable.","tags":["Registration"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"string"}},"example":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAvheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3AsiYk3UAAABArIrkvqmA0V9lIZcVyCUdja6CiwkPwsV8BfI4CZOyR1Oq7ysvNJWwY0G42dpxN9OP1qz4dum8apG2hqvxVWjkDQ=="}}}}},"method":"post","path":"/WEB_AUTH_ENDPOINT","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAvheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3AsiYk3UAAABArIrkvqmA0V9lIZcVyCUdja6CiwkPwsV8BfI4CZOyR1Oq7ysvNJWwY0G42dpxN9OP1qz4dum8apG2hqvxVWjkDQ=="},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Provide Signed Challenge Transaction","description":{"content":"Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable.","type":"text/plain"},"url":{"path":["WEB_AUTH_ENDPOINT"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/refresh-token.api.mdx b/network/stellar-disbursement-platform/resources/refresh-token.api.mdx index 98c24d085..86144b0a1 100644 --- a/network/stellar-disbursement-platform/resources/refresh-token.api.mdx +++ b/network/stellar-disbursement-platform/resources/refresh-token.api.mdx @@ -5,7 +5,7 @@ description: "A user’s token expires after 15 minutes. This endpoint handles r sidebar_label: "Refresh Token" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Returns a new access token","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"operationId":"Refresh Token","description":"A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires.","tags":["Authentication"],"security":[{"BearerAuth":[]}],"method":"post","path":"/refresh-token","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Refresh Token","description":{"content":"A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires.","type":"text/plain"},"url":{"path":["refresh-token"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Returns a new access token","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"operationId":"Refresh Token","description":"A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires.","tags":["Authentication"],"security":[{"BearerAuth":[]}],"method":"post","path":"/refresh-token","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Refresh Token","description":{"content":"A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires.","type":"text/plain"},"url":{"path":["refresh-token"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/request-challenge-transaction.api.mdx b/network/stellar-disbursement-platform/resources/request-challenge-transaction.api.mdx index ce1228ddb..0c36da424 100644 --- a/network/stellar-disbursement-platform/resources/request-challenge-transaction.api.mdx +++ b/network/stellar-disbursement-platform/resources/request-challenge-transaction.api.mdx @@ -5,7 +5,7 @@ description: "Allows the wallet to get the SEP-10 challenge transaction to be si sidebar_label: "Request Challenge Transaction" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"string"},"network_passphrase":{"type":"string"}},"example":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag==","network_passphrase":"Test SDF Network ; September 2015"}},"examples":{"response":{"value":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag==","network_passphrase":"Test SDF Network ; September 2015"}}}}}},"400":{"description":"If some information was missing or invalid.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"account":{"type":"string"}}}},"example":{"error":"Bad request.","extras":{"account":"account cannot be empty"}}},"examples":{"response":{"value":{"error":"Bad request.","extras":{"account":"account cannot be empty"}}}}}}}},"operationId":"Request Challenge Transaction","description":"Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable.","tags":["Registration"],"parameters":[{"name":"account","in":"query","description":"The Client Account, which can be a stellar account (G...) or muxed account (M...) that the Client wishes to authenticate with the Server..","required":true,"schema":{"type":"string"}},{"name":"memo","in":"query","description":"The memo to attach to the challenge transaction. Only permitted if a Stellar account (G...) is used. The memo must be of type id. Other memo types are not supported.","required":false,"schema":{"type":"string"}},{"name":"client_domain","in":"query","description":"a Client Domain. Need to be supplied by all Clients/Wallets.","required":true,"schema":{"type":"string"}}],"method":"get","path":"/WEB_AUTH_ENDPOINT","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Request Challenge Transaction","description":{"content":"Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable.","type":"text/plain"},"url":{"path":["WEB_AUTH_ENDPOINT"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The Client Account, which can be a stellar account (G...) or muxed account (M...) that the Client wishes to authenticate with the Server..","type":"text/plain"},"key":"account","value":""},{"disabled":false,"description":{"content":"The memo to attach to the challenge transaction. Only permitted if a Stellar account (G...) is used. The memo must be of type id. Other memo types are not supported.","type":"text/plain"},"key":"memo","value":""},{"disabled":false,"description":{"content":"(Required) a Client Domain. Need to be supplied by all Clients/Wallets.","type":"text/plain"},"key":"client_domain","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"string"},"network_passphrase":{"type":"string"}},"example":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag==","network_passphrase":"Test SDF Network ; September 2015"}},"examples":{"response":{"value":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag==","network_passphrase":"Test SDF Network ; September 2015"}}}}}},"400":{"description":"If some information was missing or invalid.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"account":{"type":"string"}}}},"example":{"error":"Bad request.","extras":{"account":"account cannot be empty"}}},"examples":{"response":{"value":{"error":"Bad request.","extras":{"account":"account cannot be empty"}}}}}}}},"operationId":"Request Challenge Transaction","description":"Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable.","tags":["Registration"],"parameters":[{"name":"account","in":"query","description":"The Client Account, which can be a stellar account (G...) or muxed account (M...) that the Client wishes to authenticate with the Server..","required":true,"schema":{"type":"string"}},{"name":"memo","in":"query","description":"The memo to attach to the challenge transaction. Only permitted if a Stellar account (G...) is used. The memo must be of type id. Other memo types are not supported.","required":false,"schema":{"type":"string"}},{"name":"client_domain","in":"query","description":"a Client Domain. Need to be supplied by all Clients/Wallets.","required":true,"schema":{"type":"string"}}],"method":"get","path":"/WEB_AUTH_ENDPOINT","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Request Challenge Transaction","description":{"content":"Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable.","type":"text/plain"},"url":{"path":["WEB_AUTH_ENDPOINT"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The Client Account, which can be a stellar account (G...) or muxed account (M...) that the Client wishes to authenticate with the Server..","type":"text/plain"},"key":"account","value":""},{"disabled":false,"description":{"content":"The memo to attach to the challenge transaction. Only permitted if a Stellar account (G...) is used. The memo must be of type id. Other memo types are not supported.","type":"text/plain"},"key":"memo","value":""},{"disabled":false,"description":{"content":"(Required) a Client Domain. Need to be supplied by all Clients/Wallets.","type":"text/plain"},"key":"client_domain","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/request-registration-url.api.mdx b/network/stellar-disbursement-platform/resources/request-registration-url.api.mdx index 2be62605d..ccd9203a6 100644 --- a/network/stellar-disbursement-platform/resources/request-registration-url.api.mdx +++ b/network/stellar-disbursement-platform/resources/request-registration-url.api.mdx @@ -5,7 +5,7 @@ description: "The deposit endpoint allows a wallet to get deposit information fr sidebar_label: "Request Registration URL" hide_title: true hide_table_of_contents: true -api: {"description":"The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. \nIt also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2).\n","externalDocs":{"description":"Find more info here","url":"https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2"},"tags":["Registration"],"responses":{"200":{"description":"An anchor requires the user to fill out information on a webpage hosted by the anchor.","content":{"*/*":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Always set to interactive_customer_info_needed.","example":"interactive_customer_info_needed"},"url":{"type":"string","description":"URL hosted by the anchor. The wallet should show this URL to the user as a popup.","example":"https://api.example.com/kycflow?account=GACW7NONV43MZIFHCOKCQJAKSJSISSICFVUJ2C6EZIW5773OU3HD64VI"},"id":{"type":"string","description":"The anchor's internal ID for this deposit / withdrawal request. The wallet will use this ID to query the /transaction endpoint to check status of the request.","example":"82fhs729f63dh0v4"}}}}}}},"method":"post","path":"/TRANSFER_SERVER_SEP0024/transactions/deposit/interactive","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Request Registration URL","description":{"content":"The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. \nIt also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2).\n","type":"text/plain"},"url":{"path":["TRANSFER_SERVER_SEP0024","transactions","deposit","interactive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"POST"}} +api: {"description":"The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. \nIt also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2).\n","externalDocs":{"description":"Find more info here","url":"https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2"},"tags":["Registration"],"responses":{"200":{"description":"An anchor requires the user to fill out information on a webpage hosted by the anchor.","content":{"*/*":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Always set to interactive_customer_info_needed.","example":"interactive_customer_info_needed"},"url":{"type":"string","description":"URL hosted by the anchor. The wallet should show this URL to the user as a popup.","example":"https://api.example.com/kycflow?account=GACW7NONV43MZIFHCOKCQJAKSJSISSICFVUJ2C6EZIW5773OU3HD64VI"},"id":{"type":"string","description":"The anchor's internal ID for this deposit / withdrawal request. The wallet will use this ID to query the /transaction endpoint to check status of the request.","example":"82fhs729f63dh0v4"}}}}}}},"method":"post","path":"/TRANSFER_SERVER_SEP0024/transactions/deposit/interactive","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Request Registration URL","description":{"content":"The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. \nIt also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2).\n","type":"text/plain"},"url":{"path":["TRANSFER_SERVER_SEP0024","transactions","deposit","interactive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"POST"}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/reset-password.api.mdx b/network/stellar-disbursement-platform/resources/reset-password.api.mdx index b685ff450..d0711636a 100644 --- a/network/stellar-disbursement-platform/resources/reset-password.api.mdx +++ b/network/stellar-disbursement-platform/resources/reset-password.api.mdx @@ -5,7 +5,7 @@ description: "Allows an SDP user who has gone through the Forgot Password proces sidebar_label: "Reset Rassword" hide_title: true hide_table_of_contents: true -api: {"description":"Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email.","operationId":"resetPassword","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New password for the user"},"reset_token":{"type":"string","description":"Token used to identify a valid password reset request"}},"required":["password","reset_token"]}}},"description":"Reset password request data","required":true},"responses":{"200":{"description":"Password reset successfully"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}}},"method":"post","path":"/reset-password","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"password":"string","reset_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Reset Rassword","description":{"content":"Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email.","type":"text/plain"},"url":{"path":["reset-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email.","operationId":"resetPassword","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New password for the user"},"reset_token":{"type":"string","description":"Token used to identify a valid password reset request"}},"required":["password","reset_token"]}}},"description":"Reset password request data","required":true},"responses":{"200":{"description":"Password reset successfully"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}}},"method":"post","path":"/reset-password","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"password":"string","reset_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Reset Rassword","description":{"content":"Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email.","type":"text/plain"},"url":{"path":["reset-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx b/network/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx index c37bfebf9..4f44c2556 100644 --- a/network/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx +++ b/network/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx @@ -5,7 +5,7 @@ description: "Fetches information on a specific disbursement by ```id```." sidebar_label: "Retrieve a Disbursement" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Disbursement details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Three-character ISO 3166 code","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Retrieve a Disbursement","description":"Fetches information on a specific disbursement by ```id```.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the `Disbursement`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Disbursement","description":{"content":"Fetches information on a specific disbursement by ```id```.","type":"text/plain"},"url":{"path":["disbursements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Disbursement`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Disbursement details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Three-character ISO 3166 code","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Retrieve a Disbursement","description":"Fetches information on a specific disbursement by ```id```.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the `Disbursement`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Disbursement","description":{"content":"Fetches information on a specific disbursement by ```id```.","type":"text/plain"},"url":{"path":["disbursements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Disbursement`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx b/network/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx index 25b8242a2..85e559993 100644 --- a/network/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx +++ b/network/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx @@ -5,7 +5,7 @@ description: "Fetches detailed information on a specific payment by ```id```." sidebar_label: "Retrieve a Payment" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Payment details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Payment not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Payment not found"}}}}}}}},"operationId":"Retrieve a Payment","description":"Fetches detailed information on a specific payment by ```id```.","tags":["Payments"],"parameters":[{"name":"id","in":"path","description":"ID of the `Payment`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/payments/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Payment","description":{"content":"Fetches detailed information on a specific payment by ```id```.","type":"text/plain"},"url":{"path":["payments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Payment`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Payment details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Payment not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Payment not found"}}}}}}}},"operationId":"Retrieve a Payment","description":"Fetches detailed information on a specific payment by ```id```.","tags":["Payments"],"parameters":[{"name":"id","in":"path","description":"ID of the `Payment`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/payments/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Payment","description":{"content":"Fetches detailed information on a specific payment by ```id```.","type":"text/plain"},"url":{"path":["payments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Payment`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx b/network/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx index 3e0ca29c1..f98d51702 100644 --- a/network/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx +++ b/network/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx @@ -5,7 +5,7 @@ description: "Fetches detailed information on a specific receiver by ```id```, i sidebar_label: "Retrieve a Receiver" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Receiver Details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Resource not found"}}}}}}}},"operationId":"Retrieve a Receiver","description":"Fetches detailed information on a specific receiver by ```id```, including all associated wallets.","tags":["Receivers"],"parameters":[{"name":"id","in":"path","description":"ID of the `Receiver`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/receivers/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Receiver","description":{"content":"Fetches detailed information on a specific receiver by ```id```, including all associated wallets.","type":"text/plain"},"url":{"path":["receivers",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Receiver`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Receiver Details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Resource not found"}}}}}}}},"operationId":"Retrieve a Receiver","description":"Fetches detailed information on a specific receiver by ```id```, including all associated wallets.","tags":["Receivers"],"parameters":[{"name":"id","in":"path","description":"ID of the `Receiver`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/receivers/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Receiver","description":{"content":"Fetches detailed information on a specific receiver by ```id```, including all associated wallets.","type":"text/plain"},"url":{"path":["receivers",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Receiver`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/retrieve-all-statistics.api.mdx b/network/stellar-disbursement-platform/resources/retrieve-all-statistics.api.mdx index e6f1cf940..db2362d17 100644 --- a/network/stellar-disbursement-platform/resources/retrieve-all-statistics.api.mdx +++ b/network/stellar-disbursement-platform/resources/retrieve-all-statistics.api.mdx @@ -5,7 +5,7 @@ description: "Fetches all metrics on all disbursements the organization has crea sidebar_label: "Retrieve All Statistics" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"General Statistics response","content":{"application/json":{"schema":{"type":"object","properties":{"total_disbursements":{"type":"integer","description":"Total number of disbursements","format":"int64","example":20},"payment_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":2},"pending":{"type":"integer","format":"int64","example":3},"paused":{"type":"integer","format":"int64","example":1},"success":{"type":"integer","format":"int64","example":5},"failed":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":14}}},"payment_amounts_by_asset":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"payment_amounts":{"type":"object","properties":{"draft":{"type":"string","example":"100.00"},"ready":{"type":"string","example":"200.00"},"pending":{"type":"string","example":"300.00"},"paused":{"type":"string","example":"100.00"},"success":{"type":"string","example":"500.00"},"failed":{"type":"string","example":"100.00"},"average":{"type":"string","example":"100.00"},"total":{"type":"string","example":"1400.00"}}}}}},"receiver_wallets_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":1},"registered":{"type":"integer","format":"int64","example":1},"flagged":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":4}}},"total_receivers":{"type":"integer","description":"Total number of receivers","format":"int64","example":1000}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"operationId":"Retrieve All Statistics","description":"Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.","tags":["Statistics"],"security":[{"BearerAuth":[]}],"method":"get","path":"/statistics","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve All Statistics","description":{"content":"Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.","type":"text/plain"},"url":{"path":["statistics"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"General Statistics response","content":{"application/json":{"schema":{"type":"object","properties":{"total_disbursements":{"type":"integer","description":"Total number of disbursements","format":"int64","example":20},"payment_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":2},"pending":{"type":"integer","format":"int64","example":3},"paused":{"type":"integer","format":"int64","example":1},"success":{"type":"integer","format":"int64","example":5},"failed":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":14}}},"payment_amounts_by_asset":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"payment_amounts":{"type":"object","properties":{"draft":{"type":"string","example":"100.00"},"ready":{"type":"string","example":"200.00"},"pending":{"type":"string","example":"300.00"},"paused":{"type":"string","example":"100.00"},"success":{"type":"string","example":"500.00"},"failed":{"type":"string","example":"100.00"},"average":{"type":"string","example":"100.00"},"total":{"type":"string","example":"1400.00"}}}}}},"receiver_wallets_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":1},"registered":{"type":"integer","format":"int64","example":1},"flagged":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":4}}},"total_receivers":{"type":"integer","description":"Total number of receivers","format":"int64","example":1000}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"operationId":"Retrieve All Statistics","description":"Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.","tags":["Statistics"],"security":[{"BearerAuth":[]}],"method":"get","path":"/statistics","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve All Statistics","description":{"content":"Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.","type":"text/plain"},"url":{"path":["statistics"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/retrieve-disbursement-statistics.api.mdx b/network/stellar-disbursement-platform/resources/retrieve-disbursement-statistics.api.mdx index 8c41ab78d..cc918a499 100644 --- a/network/stellar-disbursement-platform/resources/retrieve-disbursement-statistics.api.mdx +++ b/network/stellar-disbursement-platform/resources/retrieve-disbursement-statistics.api.mdx @@ -5,7 +5,7 @@ description: "Fetches metrics on a specific disbursement by ```id```." sidebar_label: "Retrieve Disbursement Statistics" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Returns statistics for disbursement","content":{"application/json":{"schema":{"type":"object","properties":{"payment_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":2},"pending":{"type":"integer","format":"int64","example":3},"paused":{"type":"integer","format":"int64","example":1},"success":{"type":"integer","format":"int64","example":5},"failed":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":14}}},"payment_amounts_by_asset":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"payment_amounts":{"type":"object","properties":{"draft":{"type":"string","example":"100.00"},"ready":{"type":"string","example":"200.00"},"pending":{"type":"string","example":"300.00"},"paused":{"type":"string","example":"100.00"},"success":{"type":"string","example":"500.00"},"failed":{"type":"string","example":"100.00"},"average":{"type":"string","example":"100.00"},"total":{"type":"string","example":"1400.00"}}}}}},"receiver_wallets_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":1},"registered":{"type":"integer","format":"int64","example":1},"flagged":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":4}}},"total_receivers":{"type":"integer","description":"Total number of receivers","format":"int64","example":100}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Retrieve Disbursement Statistics","description":"Fetches metrics on a specific disbursement by ```id```.","tags":["Statistics"],"parameters":[{"name":"id","in":"path","description":"ID of the `Disbursement`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/statistics/disbursements/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Disbursement Statistics","description":{"content":"Fetches metrics on a specific disbursement by ```id```.","type":"text/plain"},"url":{"path":["statistics","disbursements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Disbursement`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Returns statistics for disbursement","content":{"application/json":{"schema":{"type":"object","properties":{"payment_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":2},"pending":{"type":"integer","format":"int64","example":3},"paused":{"type":"integer","format":"int64","example":1},"success":{"type":"integer","format":"int64","example":5},"failed":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":14}}},"payment_amounts_by_asset":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"payment_amounts":{"type":"object","properties":{"draft":{"type":"string","example":"100.00"},"ready":{"type":"string","example":"200.00"},"pending":{"type":"string","example":"300.00"},"paused":{"type":"string","example":"100.00"},"success":{"type":"string","example":"500.00"},"failed":{"type":"string","example":"100.00"},"average":{"type":"string","example":"100.00"},"total":{"type":"string","example":"1400.00"}}}}}},"receiver_wallets_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":1},"registered":{"type":"integer","format":"int64","example":1},"flagged":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":4}}},"total_receivers":{"type":"integer","description":"Total number of receivers","format":"int64","example":100}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Retrieve Disbursement Statistics","description":"Fetches metrics on a specific disbursement by ```id```.","tags":["Statistics"],"parameters":[{"name":"id","in":"path","description":"ID of the `Disbursement`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/statistics/disbursements/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Disbursement Statistics","description":{"content":"Fetches metrics on a specific disbursement by ```id```.","type":"text/plain"},"url":{"path":["statistics","disbursements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Disbursement`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/retrieve-stellar-info-file.api.mdx b/network/stellar-disbursement-platform/resources/retrieve-stellar-info-file.api.mdx index 342f7a593..8512678a1 100644 --- a/network/stellar-disbursement-platform/resources/retrieve-stellar-info-file.api.mdx +++ b/network/stellar-disbursement-platform/resources/retrieve-stellar-info-file.api.mdx @@ -5,7 +5,7 @@ description: "Allows the wallet to fetch the SEP-10 server url, SEP-10 signing p sidebar_label: "Retrieve Stellar Info File" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Token is valid and the webpage will be loaded normally.","headers":{},"content":{"text/toml":{"examples":{"response":{"value":"ACCOUNTS=[\"GBC2HVWFIFN7WJHFORVBCDKJORXXXXXXXXXXXXXXXXXXXXXXXX\", \"GDA34JZ26FZY64XCSY46CUNSHLX762LHJXQXXXXXXXXXXXXXXXXXXXXXXXX\"] SIGNING_KEY=\"GDA34JZ26FZY64XCSY46XXXXXXXXXXXXXXXXXXXXXXXX\" NETWORK_PASSPHRASE=\"Test SDF Network ; September 2015\" HORIZON_URL=\"https://horizon-testnet.stellar.org\" WEB_AUTH_ENDPOINT=\"https://ap-stellar-disbursement-platform-backend-dev.stellar.org/auth\" TRANSFER_SERVER_SEP0024=\"https://ap-stellar-disbursement-platform-backend-dev.stellar.org/sep24\"\n[[DOCUMENTATION]] ORG_NAME=\"Stellar Aid\"\n[[CURRENCIES]] code = \"EUROC\" issuer = \"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5\" is_asset_anchored = true anchor_asset_type = \"fiat\" status = \"live\" desc = \"EUROC\"\n[[CURRENCIES]] code = \"USDC\" issuer = \"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5\" is_asset_anchored = true anchor_asset_type = \"fiat\" status = \"live\" desc = \"USDC\"\n"}}}}}},"operationId":"Retrieve Stellar Info File","description":"Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url.","tags":["Registration"],"method":"get","path":"/.well-known/stellar.toml","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Stellar Info File","description":{"content":"Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url.","type":"text/plain"},"url":{"path":[".well-known","stellar.toml"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"text/toml"}],"method":"GET"}} +api: {"responses":{"200":{"description":"Token is valid and the webpage will be loaded normally.","headers":{},"content":{"text/toml":{"examples":{"response":{"value":"ACCOUNTS=[\"GBC2HVWFIFN7WJHFORVBCDKJORXXXXXXXXXXXXXXXXXXXXXXXX\", \"GDA34JZ26FZY64XCSY46CUNSHLX762LHJXQXXXXXXXXXXXXXXXXXXXXXXXX\"] SIGNING_KEY=\"GDA34JZ26FZY64XCSY46XXXXXXXXXXXXXXXXXXXXXXXX\" NETWORK_PASSPHRASE=\"Test SDF Network ; September 2015\" HORIZON_URL=\"https://horizon-testnet.stellar.org\" WEB_AUTH_ENDPOINT=\"https://ap-stellar-disbursement-platform-backend-dev.stellar.org/auth\" TRANSFER_SERVER_SEP0024=\"https://ap-stellar-disbursement-platform-backend-dev.stellar.org/sep24\"\n[[DOCUMENTATION]] ORG_NAME=\"Stellar Aid\"\n[[CURRENCIES]] code = \"EUROC\" issuer = \"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5\" is_asset_anchored = true anchor_asset_type = \"fiat\" status = \"live\" desc = \"EUROC\"\n[[CURRENCIES]] code = \"USDC\" issuer = \"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5\" is_asset_anchored = true anchor_asset_type = \"fiat\" status = \"live\" desc = \"USDC\"\n"}}}}}},"operationId":"Retrieve Stellar Info File","description":"Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url.","tags":["Registration"],"method":"get","path":"/.well-known/stellar.toml","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Stellar Info File","description":{"content":"Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url.","type":"text/plain"},"url":{"path":[".well-known","stellar.toml"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"text/toml"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/send-one-time-passcode.api.mdx b/network/stellar-disbursement-platform/resources/send-one-time-passcode.api.mdx index 5a3f8a401..68987265d 100644 --- a/network/stellar-disbursement-platform/resources/send-one-time-passcode.api.mdx +++ b/network/stellar-disbursement-platform/resources/send-one-time-passcode.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint generates a 6-digit OTP and sends it via SMS to the sidebar_label: "Send One-Time Passcode" hide_title: true hide_table_of_contents: true -api: {"operationId":"Send One-Time Passcode","description":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). A valid SEP-24 token should be included in the Authorization header of the request.","tags":["Registration"],"parameters":[{"name":"Authorization","in":"header","description":"SEP-24 token for authorization (Format: 'Bearer {token}')","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number to which the OTP will be sent"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation"}},"required":["phone_number","recaptcha_token"]}}},"description":"Object containing phone number","required":true},"responses":{"200":{"description":"OTP sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"429":{"description":"An OTP was sent to the given user recently and hasn't expired yet. Only after expired it will be sent to the user again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"code":{"type":"string"},"details":{"type":"string"}}}}}}}}},"method":"post","path":"/wallet-registration/otp","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"phone_number":"string","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Send One-Time Passcode","description":{"content":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). A valid SEP-24 token should be included in the Authorization header of the request.","type":"text/plain"},"url":{"path":["wallet-registration","otp"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"Send One-Time Passcode","description":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). A valid SEP-24 token should be included in the Authorization header of the request.","tags":["Registration"],"parameters":[{"name":"Authorization","in":"header","description":"SEP-24 token for authorization (Format: 'Bearer {token}')","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number to which the OTP will be sent"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation"}},"required":["phone_number","recaptcha_token"]}}},"description":"Object containing phone number","required":true},"responses":{"200":{"description":"OTP sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"429":{"description":"An OTP was sent to the given user recently and hasn't expired yet. Only after expired it will be sent to the user again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"code":{"type":"string"},"details":{"type":"string"}}}}}}}}},"method":"post","path":"/wallet-registration/otp","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"phone_number":"string","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Send One-Time Passcode","description":{"content":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). A valid SEP-24 token should be included in the Authorization header of the request.","type":"text/plain"},"url":{"path":["wallet-registration","otp"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/start-wallet-registration.api.mdx b/network/stellar-disbursement-platform/resources/start-wallet-registration.api.mdx index bbcff88dc..dab21936c 100644 --- a/network/stellar-disbursement-platform/resources/start-wallet-registration.api.mdx +++ b/network/stellar-disbursement-platform/resources/start-wallet-registration.api.mdx @@ -5,7 +5,7 @@ description: "This is the endpoint the browser reaches with the first token so t sidebar_label: "Start Wallet Registration" hide_title: true hide_table_of_contents: true -api: {"operationId":"Start Wallet Registration","description":"This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. Requires a valid SEP-24 token in the request.","tags":["Registration"],"parameters":[{"name":"token","in":"query","description":"The SEP-24 token used for authentication","required":true,"schema":{"type":"string"}},{"name":"transaction_id","in":"query","description":"The transaction id associated with the SEP-24 token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token is valid and the webpage will be loaded normally.","content":{"text/html":{"schema":{"type":"string","description":"HTML page content"}}}},"400":{"description":"Bad Request","content":{"text/html":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"text/html":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}},"application/json":{"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"get","path":"/wallet-registration/start","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Start Wallet Registration","description":{"content":"This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. Requires a valid SEP-24 token in the request.","type":"text/plain"},"url":{"path":["wallet-registration","start"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The SEP-24 token used for authentication","type":"text/plain"},"key":"token","value":""},{"disabled":false,"description":{"content":"(Required) The transaction id associated with the SEP-24 token","type":"text/plain"},"key":"transaction_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"text/html"}],"method":"GET"}} +api: {"operationId":"Start Wallet Registration","description":"This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. Requires a valid SEP-24 token in the request.","tags":["Registration"],"parameters":[{"name":"token","in":"query","description":"The SEP-24 token used for authentication","required":true,"schema":{"type":"string"}},{"name":"transaction_id","in":"query","description":"The transaction id associated with the SEP-24 token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token is valid and the webpage will be loaded normally.","content":{"text/html":{"schema":{"type":"string","description":"HTML page content"}}}},"400":{"description":"Bad Request","content":{"text/html":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"text/html":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}},"application/json":{"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"get","path":"/wallet-registration/start","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Start Wallet Registration","description":{"content":"This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. Requires a valid SEP-24 token in the request.","type":"text/plain"},"url":{"path":["wallet-registration","start"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The SEP-24 token used for authentication","type":"text/plain"},"key":"token","value":""},{"disabled":false,"description":{"content":"(Required) The transaction id associated with the SEP-24 token","type":"text/plain"},"key":"transaction_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"text/html"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/update-a-disbursement-status.api.mdx b/network/stellar-disbursement-platform/resources/update-a-disbursement-status.api.mdx index f9ca190ce..659d98746 100644 --- a/network/stellar-disbursement-platform/resources/update-a-disbursement-status.api.mdx +++ b/network/stellar-disbursement-platform/resources/update-a-disbursement-status.api.mdx @@ -5,7 +5,7 @@ description: "Updates the status of a disbursement according to the state machin sidebar_label: "Update a Disbursement Status" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Message Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"Disbursement started"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Bad request","extras":{"status":400,"message":"Disbursement is not ready to be started"}}},"examples":{"response":{"value":{"error":"Bad request","extras":{"status":400,"message":"Disbursement is not ready to be started"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Update a Disbursement Status","description":"Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the disbursement","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"patch","path":"/disbursements/{id}/status","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update a Disbursement Status","description":{"content":"Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready.","type":"text/plain"},"url":{"path":["disbursements",":id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Message Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"Disbursement started"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Bad request","extras":{"status":400,"message":"Disbursement is not ready to be started"}}},"examples":{"response":{"value":{"error":"Bad request","extras":{"status":400,"message":"Disbursement is not ready to be started"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Update a Disbursement Status","description":"Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the disbursement","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"patch","path":"/disbursements/{id}/status","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update a Disbursement Status","description":{"content":"Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready.","type":"text/plain"},"url":{"path":["disbursements",":id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/update-a-receiver.api.mdx b/network/stellar-disbursement-platform/resources/update-a-receiver.api.mdx index 66c7e5b39..b4c1c274f 100644 --- a/network/stellar-disbursement-platform/resources/update-a-receiver.api.mdx +++ b/network/stellar-disbursement-platform/resources/update-a-receiver.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint allows an organization to add and update information sidebar_label: "Update a Receiver" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Updated Receiver Details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Resource not found"}}}}}}}},"operationId":"Update a Receiver","description":"This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver.","tags":["Receivers"],"parameters":[{"name":"id","in":"path","description":"ID of the `Receiver`.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"date_of_birth":{"type":"string","description":"Date of birth of the receiver"},"pin":{"type":"string","description":"Personal identification number of the receiver"},"national_id":{"type":"string","description":"National ID of the receiver"},"email":{"type":"string","description":"Email of the receiver"},"external_id":{"type":"string","description":"External ID of the receiver"}},"example":{"date_of_birth":"1980-01-01","pin":"1234","national_id":"123456789","email":"john@example.com","external_id":"external123"}}}},"description":"List of fields to patch for the receiver","required":true},"security":[{"BearerAuth":[]}],"method":"patch","path":"/receivers/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"date_of_birth":"1980-01-01","pin":"1234","national_id":"123456789","email":"john@example.com","external_id":"external123"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update a Receiver","description":{"content":"This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver.","type":"text/plain"},"url":{"path":["receivers",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Receiver`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Updated Receiver Details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Resource not found"}}}}}}}},"operationId":"Update a Receiver","description":"This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver.","tags":["Receivers"],"parameters":[{"name":"id","in":"path","description":"ID of the `Receiver`.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"date_of_birth":{"type":"string","description":"Date of birth of the receiver"},"pin":{"type":"string","description":"Personal identification number of the receiver"},"national_id":{"type":"string","description":"National ID of the receiver"},"email":{"type":"string","description":"Email of the receiver"},"external_id":{"type":"string","description":"External ID of the receiver"}},"example":{"date_of_birth":"1980-01-01","pin":"1234","national_id":"123456789","email":"john@example.com","external_id":"external123"}}}},"description":"List of fields to patch for the receiver","required":true},"security":[{"BearerAuth":[]}],"method":"patch","path":"/receivers/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"date_of_birth":"1980-01-01","pin":"1234","national_id":"123456789","email":"john@example.com","external_id":"external123"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update a Receiver","description":{"content":"This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver.","type":"text/plain"},"url":{"path":["receivers",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Receiver`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/update-organization-profile.api.mdx b/network/stellar-disbursement-platform/resources/update-organization-profile.api.mdx index 1bcf7451a..bc70963a4 100644 --- a/network/stellar-disbursement-platform/resources/update-organization-profile.api.mdx +++ b/network/stellar-disbursement-platform/resources/update-organization-profile.api.mdx @@ -5,7 +5,7 @@ description: "Updates the organization profile details. Only account owners have sidebar_label: "Update Organization Profile" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"organization profile updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update Organization Profile","description":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","tags":["Organization"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"logo":{"description":"The logo of the organization, file type must be png or jpeg.","type":"string","format":"binary"},"data":{"description":"A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_required` (boolean): whether the approval workflow is enabled or not. `sms_registration_message_template` (string): the SMS message template sent to the receivers inviting them to registration. Sending this field empty sets the `default` value for it. `otp_message_template` (string): the SMS message template sent to the receivers sending the OTP to complete the registration flow. Sending this field empty sets the `default` value for it. For example: '{\"organization_name\": \"NewOrgName\", \"timezone_utc_offset\": \"+02:00\", \"is_approval_required\": true, \"sms_registration_message_template\": \"You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.\", \"otp_message_template\": \"{{.OTP}} is your {{.OrganizationName}} phone verification code.\"}'\n","type":"string","format":"json"}}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/organization","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update Organization Profile","description":{"content":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","type":"text/plain"},"url":{"path":["organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"formdata","formdata":[]},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"organization profile updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update Organization Profile","description":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","tags":["Organization"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"logo":{"description":"The logo of the organization, file type must be png or jpeg.","type":"string","format":"binary"},"data":{"description":"A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_required` (boolean): whether the approval workflow is enabled or not. `sms_registration_message_template` (string): the SMS message template sent to the receivers inviting them to registration. Sending this field empty sets the `default` value for it. `otp_message_template` (string): the SMS message template sent to the receivers sending the OTP to complete the registration flow. Sending this field empty sets the `default` value for it. For example: '{\"organization_name\": \"NewOrgName\", \"timezone_utc_offset\": \"+02:00\", \"is_approval_required\": true, \"sms_registration_message_template\": \"You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.\", \"otp_message_template\": \"{{.OTP}} is your {{.OrganizationName}} phone verification code.\"}'\n","type":"string","format":"json"}}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/organization","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update Organization Profile","description":{"content":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","type":"text/plain"},"url":{"path":["organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"formdata","formdata":[]},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/update-user-activation-status.api.mdx b/network/stellar-disbursement-platform/resources/update-user-activation-status.api.mdx index 51e65da2a..b398ea9df 100644 --- a/network/stellar-disbursement-platform/resources/update-user-activation-status.api.mdx +++ b/network/stellar-disbursement-platform/resources/update-user-activation-status.api.mdx @@ -5,7 +5,7 @@ description: "Updates the SDP user’s activation status. This endpoint is prima sidebar_label: "Update User Activation Status" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]},"examples":{"response":{"value":{"message":"user activation was updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Activation Status","description":"Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"is_active":{"type":"boolean"}},"example":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","is_active":false}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/users/activation","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","is_active":false},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Activation Status","description":{"content":"Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password.","type":"text/plain"},"url":{"path":["users","activation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]},"examples":{"response":{"value":{"message":"user activation was updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Activation Status","description":"Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"is_active":{"type":"boolean"}},"example":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","is_active":false}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/users/activation","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","is_active":false},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Activation Status","description":{"content":"Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password.","type":"text/plain"},"url":{"path":["users","activation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/update-user-profile.api.mdx b/network/stellar-disbursement-platform/resources/update-user-profile.api.mdx index 9917c0998..8e73aacf9 100644 --- a/network/stellar-disbursement-platform/resources/update-user-profile.api.mdx +++ b/network/stellar-disbursement-platform/resources/update-user-profile.api.mdx @@ -5,7 +5,7 @@ description: "Updates the profile details of the logged in user, including chang sidebar_label: "Update User Profile" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"user profile updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Profile","description":"Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request.","tags":["Profile"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"}},"example":{"first_name":"FirstName","last_name":"LastName","email":"email@email.com","password":"mysecret"}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/profile","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"first_name":"FirstName","last_name":"LastName","email":"email@email.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Profile","description":{"content":"Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request.","type":"text/plain"},"url":{"path":["profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"user profile updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Profile","description":"Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request.","tags":["Profile"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"}},"example":{"first_name":"FirstName","last_name":"LastName","email":"email@email.com","password":"mysecret"}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/profile","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"first_name":"FirstName","last_name":"LastName","email":"email@email.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Profile","description":{"content":"Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request.","type":"text/plain"},"url":{"path":["profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/update-user-role.api.mdx b/network/stellar-disbursement-platform/resources/update-user-role.api.mdx index 89c5f23c4..42f3c297c 100644 --- a/network/stellar-disbursement-platform/resources/update-user-role.api.mdx +++ b/network/stellar-disbursement-platform/resources/update-user-role.api.mdx @@ -5,7 +5,7 @@ description: "Updates an SDP user’s role by ```user_ID```." sidebar_label: "Update User Role" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"user roles were updated successfully"}},"examples":{"response":{"value":{"message":"user roles were updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Role","description":"Updates an SDP user’s role by ```user_ID```.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"example":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","roles":["developer"]}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/users/roles","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","roles":["developer"]},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Role","description":{"content":"Updates an SDP user’s role by ```user_ID```.","type":"text/plain"},"url":{"path":["users","roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"user roles were updated successfully"}},"examples":{"response":{"value":{"message":"user roles were updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Role","description":"Updates an SDP user’s role by ```user_ID```.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"example":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","roles":["developer"]}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/users/roles","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","roles":["developer"]},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Role","description":{"content":"Updates an SDP user’s role by ```user_ID```.","type":"text/plain"},"url":{"path":["users","roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/upload-disbursement-instructions.api.mdx b/network/stellar-disbursement-platform/resources/upload-disbursement-instructions.api.mdx index 83bd877bb..d6b73f355 100644 --- a/network/stellar-disbursement-platform/resources/upload-disbursement-instructions.api.mdx +++ b/network/stellar-disbursement-platform/resources/upload-disbursement-instructions.api.mdx @@ -5,7 +5,7 @@ description: "Adds a file containing a list of receivers to a ```draft``` disbur sidebar_label: "Upload Disbursement Instructions" hide_title: true hide_table_of_contents: true -api: {"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"File uploaded succesfully"}},"examples":{"response":{"value":{"message":"File uploaded succesfully"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"foo":{"type":"string"},"message":{"type":"string"}}}},"example":{"error":"Invalid file format *.xyz","extras":{"foo":"bar","message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Invalid file format *.xyz","extras":{"foo":"bar","message":"Not authorized"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Upload Disbursement Instructions","description":"Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"Disbursement instructions file to upload. The CSV file should be in the following format: `phone,id,amount,verification`","type":"string","format":"binary"}},"required":["file"]}}},"required":true},"security":[{"BearerAuth":[]}],"method":"post","path":"/disbursements/{id}/instructions","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Upload Disbursement Instructions","description":{"content":"Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called.","type":"text/plain"},"url":{"path":["disbursements",":id","instructions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"File uploaded succesfully"}},"examples":{"response":{"value":{"message":"File uploaded succesfully"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"foo":{"type":"string"},"message":{"type":"string"}}}},"example":{"error":"Invalid file format *.xyz","extras":{"foo":"bar","message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Invalid file format *.xyz","extras":{"foo":"bar","message":"Not authorized"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Upload Disbursement Instructions","description":"Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"Disbursement instructions file to upload. The CSV file should be in the following format: `phone,id,amount,verification`","type":"string","format":"binary"}},"required":["file"]}}},"required":true},"security":[{"BearerAuth":[]}],"method":"post","path":"/disbursements/{id}/instructions","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Upload Disbursement Instructions","description":{"content":"Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called.","type":"text/plain"},"url":{"path":["disbursements",":id","instructions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null diff --git a/network/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx b/network/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx index e5a3518a5..9433a8230 100644 --- a/network/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx +++ b/network/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint verifies the receiver's registration by validating t sidebar_label: "Verify Receiver Registration" hide_title: true hide_table_of_contents: true -api: {"operationId":"Verify Receiver Registration","description":"This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","tags":["Registration"],"parameters":[{"name":"Authorization","in":"header","description":"SEP-24 token for authorization (Format: 'Bearer {token}')","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number used in registration"},"otp":{"type":"string","description":"One-Time Password received for verification"},"verification":{"type":"string","description":"Verification value provided by the user"},"verification_type":{"type":"string","description":"Type of verification value","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"recaptcha_token":{"type":"string","description":"Token received from Google reCAPTCHA"}}}}},"description":"Verification data including phone number, OTP, verification value, and reCAPTCHA token","required":true},"responses":{"200":{"description":"Verification successful","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"ok"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"post","path":"/wallet-registration/verification","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"phone_number":"string","otp":"string","verification":"string","verification_type":"DATE_OF_BIRTH","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Verify Receiver Registration","description":{"content":"This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","type":"text/plain"},"url":{"path":["wallet-registration","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"Verify Receiver Registration","description":"This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","tags":["Registration"],"parameters":[{"name":"Authorization","in":"header","description":"SEP-24 token for authorization (Format: 'Bearer {token}')","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number used in registration"},"otp":{"type":"string","description":"One-Time Password received for verification"},"verification":{"type":"string","description":"Verification value provided by the user"},"verification_type":{"type":"string","description":"Type of verification value","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"recaptcha_token":{"type":"string","description":"Token received from Google reCAPTCHA"}}}}},"description":"Verification data including phone number, OTP, verification value, and reCAPTCHA token","required":true},"responses":{"200":{"description":"Verification successful","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"ok"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"post","path":"/wallet-registration/verification","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."},"BasicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP Authentication with a base64-encoded string of 'ADMIN_ACCOUNT:ADMIN_API_KEY'."}},"jsonRequestBodyExample":{"phone_number":"string","otp":"string","verification":"string","verification_type":"DATE_OF_BIRTH","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Verify Receiver Registration","description":{"content":"This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","type":"text/plain"},"url":{"path":["wallet-registration","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: network/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null