{ "openapi": "3.1.0", "info": { "title": "Yuno Payments API", "version": "1.0.0", "description": "Yuno is a payment orchestration platform that connects merchants to multiple\npayment providers through a single API. Process payments, manage customers,\nhandle subscriptions, and disburse payouts across Latin America, Asia, and beyond.\n", "contact": { "name": "Yuno Support", "url": "https://docs.y.uno", "email": "support@y.uno" } }, "servers": [ { "url": "https://api-sandbox.y.uno/v1", "description": "Sandbox" }, { "url": "https://api.y.uno/v1", "description": "Production (US)" }, { "url": "https://api.eu.y.uno/v1", "description": "Production (EMEA)" } ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [] } ], "tags": [ { "name": "AI Caller" }, { "name": "Accounts (Banking Connectivity)" }, { "name": "Checkout Builder" }, { "name": "Checkout Sessions" }, { "name": "Communications Campaigns" }, { "name": "Conversion Rate" }, { "name": "Customer Sessions Enrollment" }, { "name": "Customers" }, { "name": "Dry Run" }, { "name": "Entities (Banking Connectivity)" }, { "name": "Entity Onboarding (Banking Connectivity)" }, { "name": "Entity Transfers (Banking Connectivity)" }, { "name": "Installments" }, { "name": "Network Tokens" }, { "name": "Organizations" }, { "name": "Payment Links" }, { "name": "Payment Methods Checkout" }, { "name": "Payment Methods Direct Workflow" }, { "name": "Payments" }, { "name": "Payouts" }, { "name": "Pci Proxy" }, { "name": "Plans" }, { "name": "Pre Debit Notifications" }, { "name": "Recipients For Marketplace" }, { "name": "Reporting" }, { "name": "Reports" }, { "name": "Sellers" }, { "name": "Subscriptions" }, { "name": "Three D Secure Setups" }, { "name": "Transfers" }, { "name": "Webhooks" } ], "paths": { "/banking/accounts": { "post": { "description": "", "responses": { "200": { "description": "" }, "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the Banking Connectivity account (prefixed `acct_`).", "example": "acct_aa0e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "description": "The `id` of the entity associated with this account.", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "onboarding_id": { "type": "string", "description": "The `id` of the onboarding used to create this account.", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "account_id": { "type": "string", "description": "The merchant's Yuno account identifier.", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "description": "Provider-side identifiers for the account.", "properties": { "account_id": { "type": "string", "description": "The provider's internal account identifier.", "example": "col_bank_account_789" } } }, "account_type": { "type": "string", "description": "The type of bank account.", "enum": [ "CHECKING", "SAVINGS", "INVESTMENT" ], "example": "CHECKING" }, "status": { "type": "string", "description": "The current status of the account.", "enum": [ "ACTIVE", "PENDING", "INACTIVE" ], "example": "ACTIVE" }, "account_number": { "type": "string", "description": "The bank account number.", "example": "1234567890" }, "routing_number": { "type": [ "string", "null" ], "description": "The US routing number. Present for US-based accounts.", "example": "123456789" }, "iban": { "type": [ "string", "null" ], "description": "The International Bank Account Number. Present for UK and EU accounts.", "example": null }, "currency": { "type": "string", "description": "The account currency ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).", "example": "USD" }, "balance": { "type": "object", "description": "The current balance information for the account.", "properties": { "available": { "type": "number", "description": "The available balance that can be used for transfers.", "example": 0 }, "current": { "type": "number", "description": "The current total balance including pending transactions.", "example": 0 }, "pending": { "type": "number", "description": "The amount currently in pending transactions.", "example": 0 } } }, "account_details": { "type": "object", "description": "Additional account details and region-specific identifiers.", "properties": { "account_name": { "type": "string", "description": "The display name for the account.", "example": "John Doe - Checking" }, "sort_code": { "type": [ "string", "null" ], "description": "The UK sort code. Present for UK-based accounts.", "example": null }, "bsb": { "type": [ "string", "null" ], "description": "The Australian BSB number. Present for Australia-based accounts.", "example": null }, "swift": { "type": [ "string", "null" ], "description": "The SWIFT/BIC code for international transfers.", "example": null } } }, "payment_rails": { "type": "object", "description": "The payment rails supported by this account.", "properties": { "incoming": { "type": "array", "description": "Payment rails available for receiving funds.", "items": { "type": "string" }, "example": [ "ACH", "WIRE" ] }, "outgoing": { "type": "array", "description": "Payment rails available for sending funds.", "items": { "type": "string" }, "example": [ "ACH", "WIRE" ] } } }, "supports_book_transfers": { "type": "boolean", "description": "Whether the account supports internal (book) transfers between accounts on the same provider.", "example": true }, "created_at": { "type": "string", "description": "The timestamp when the account was created (ISO 8601).", "example": "2026-02-01T10:10:00Z" }, "updated_at": { "type": "string", "description": "The timestamp when the account was last updated (ISO 8601).", "example": "2026-02-01T10:10:00Z" } } }, "examples": { "Created (Account)": { "summary": "Created (Account)", "value": { "id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "onboarding_id": "onb_990e8400-e29b-41d4-a716-446655440000", "account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "account_id": "col_bank_account_789" }, "account_type": "CHECKING", "status": "ACTIVE", "account_number": "1234567890", "routing_number": "123456789", "iban": null, "currency": "USD", "balance": { "available": 0, "current": 0, "pending": 0 }, "account_details": { "account_name": "John Doe - Checking", "sort_code": null, "bsb": null, "swift": null }, "payment_rails": { "incoming": [ "ACH", "WIRE" ], "outgoing": [ "ACH", "WIRE" ] }, "supports_book_transfers": true, "created_at": "2026-02-01T10:10:00Z", "updated_at": "2026-02-01T10:10:00Z" } } } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "Onboarding status must be SUCCEEDED to create an account" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "Onboarding status must be SUCCEEDED to create an account" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ONBOARDING_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Onboarding not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ONBOARDING_NOT_FOUND", "messages": [ "Onboarding not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "header", "name": "x-idempotency-key", "schema": { "type": "string" }, "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts. See [authentication](/reference/authentication#idempotency) for details (UUID).", "required": true } ], "operationId": "post_v1-banking-connectivity-accounts", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "onboarding_id", "account_type", "currency" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the merchant's Yuno account. Found on the [Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 characters).", "example": "550e8400-e29b-41d4-a716-446655440000" }, "onboarding_id": { "type": "string", "description": "The `id` of a successful onboarding obtained from [Create Entity Onboarding](/reference/create-entity-onboarding). The onboarding must have `status: SUCCEEDED`.", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "account_type": { "type": "string", "description": "The type of bank account to create.", "enum": [ "CHECKING", "SAVINGS", "INVESTMENT" ], "example": "CHECKING" }, "currency": { "type": "string", "description": "The currency for the account ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217), 3 characters). Supported values depend on the provider region: `USD` (US), `GBP` (UK), `AUD` (Australia), `EUR` (EU).", "example": "USD" } } }, "examples": { "Create Account": { "summary": "Create Account", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "onboarding_id": "onb_990e8400-e29b-41d4-a716-446655440000", "account_type": "CHECKING", "currency": "USD" } } } } } }, "summary": "Create Account (Banking Connectivity)", "tags": [ "Accounts (Banking Connectivity)" ] } }, "/banking/accounts/{account_id}": { "get": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "onboarding_id": "onb_990e8400-e29b-41d4-a716-446655440000", "account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "account_id": "col_bank_account_789" }, "account_type": "CHECKING", "status": "ACTIVE", "account_number": "1234567890", "routing_number": "123456789", "iban": null, "currency": "USD", "balance": { "available": 0, "current": 0, "pending": 0 }, "account_details": { "account_name": "John Doe - Checking", "sort_code": null, "bsb": null, "swift": null }, "payment_rails": { "incoming": [ "ACH", "WIRE" ], "outgoing": [ "ACH", "WIRE" ] }, "supports_book_transfers": true, "created_at": "2026-02-01T10:10:00Z", "updated_at": "2026-02-01T10:10:00Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "acct_aa0e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "onboarding_id": { "type": "string", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "properties": { "account_id": { "type": "string", "example": "col_bank_account_789" } } }, "account_type": { "type": "string", "example": "CHECKING" }, "status": { "type": "string", "example": "ACTIVE" }, "account_number": { "type": "string", "example": "1234567890" }, "routing_number": { "type": "string", "example": "123456789" }, "iban": {}, "currency": { "type": "string", "example": "USD" }, "balance": { "type": "object", "properties": { "available": { "type": "integer", "example": 0, "default": 0 }, "current": { "type": "integer", "example": 0, "default": 0 }, "pending": { "type": "integer", "example": 0, "default": 0 } } }, "account_details": { "type": "object", "properties": { "account_name": { "type": "string", "example": "John Doe - Checking" }, "sort_code": {}, "bsb": {}, "swift": {} } }, "payment_rails": { "type": "object", "properties": { "incoming": { "type": "array", "items": { "type": "string", "example": "ACH" } }, "outgoing": { "type": "array", "items": { "type": "string", "example": "ACH" } } } }, "supports_book_transfers": { "type": "boolean", "example": true, "default": true }, "created_at": { "type": "string", "example": "2026-02-01T10:10:00Z" }, "updated_at": { "type": "string", "example": "2026-02-01T10:10:00Z" } } } } } }, "401": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "NOT_AUTHENTICATED" }, "messages": { "type": "array", "items": { "type": "string", "example": "Missing required authentication headers" } }, "http_code": { "type": "integer", "example": 401, "default": 0 } } }, "examples": { "Unauthorized": { "summary": "Unauthorized", "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Missing required authentication headers" ], "http_code": 401 } } } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ACCOUNT_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Account not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ACCOUNT_NOT_FOUND", "messages": [ "Account not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "account_id", "schema": { "type": "string" }, "required": true, "description": "The unique identifier of the account. Found on the [Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars)." } ], "operationId": "get_v1-banking-connectivity-accounts-account-id", "summary": "Get Account Details (Banking Connectivity)", "tags": [ "Accounts (Banking Connectivity)" ] }, "patch": { "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the Banking Connectivity account (prefixed `acct_`).", "example": "acct_aa0e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "description": "The `id` of the entity associated with this account.", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "onboarding_id": { "type": "string", "description": "The `id` of the onboarding used to create this account.", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "account_id": { "type": "string", "description": "The merchant's Yuno account identifier.", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "properties": { "account_id": { "type": "string", "example": "col_bank_account_789" } } }, "account_type": { "type": "string", "enum": [ "CHECKING", "SAVINGS", "INVESTMENT" ], "example": "CHECKING" }, "status": { "type": "string", "enum": [ "ACTIVE", "PENDING", "INACTIVE" ], "example": "ACTIVE" }, "account_number": { "type": "string", "example": "1234567890" }, "routing_number": { "type": [ "string", "null" ], "example": "123456789" }, "iban": { "type": [ "string", "null" ], "example": null }, "currency": { "type": "string", "example": "USD" }, "balance": { "type": "object", "properties": { "available": { "type": "number", "example": 5000 }, "current": { "type": "number", "example": 5000 }, "pending": { "type": "number", "example": 0 } } }, "account_details": { "type": "object", "properties": { "account_name": { "type": "string", "example": "John Doe - Primary Checking" }, "sort_code": { "type": [ "string", "null" ], "example": null }, "bsb": { "type": [ "string", "null" ], "example": null }, "swift": { "type": [ "string", "null" ], "example": null } } }, "payment_rails": { "type": "object", "properties": { "incoming": { "type": "array", "items": { "type": "string" }, "example": [ "ACH", "WIRE" ] }, "outgoing": { "type": "array", "items": { "type": "string" }, "example": [ "ACH", "WIRE" ] } } }, "supports_book_transfers": { "type": "boolean", "example": true }, "created_at": { "type": "string", "example": "2026-02-01T10:10:00Z" }, "updated_at": { "type": "string", "example": "2026-02-01T12:00:00Z" } } }, "examples": { "OK (Updated Account)": { "summary": "OK (Updated Account)", "value": { "id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "onboarding_id": "onb_990e8400-e29b-41d4-a716-446655440000", "account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "account_id": "col_bank_account_789" }, "account_type": "CHECKING", "status": "ACTIVE", "account_number": "1234567890", "routing_number": "123456789", "iban": null, "currency": "USD", "balance": { "available": 5000, "current": 5000, "pending": 0 }, "account_details": { "account_name": "John Doe - Primary Checking", "sort_code": null, "bsb": null, "swift": null }, "payment_rails": { "incoming": [ "ACH", "WIRE" ], "outgoing": [ "ACH", "WIRE" ] }, "supports_book_transfers": true, "created_at": "2026-02-01T10:10:00Z", "updated_at": "2026-02-01T12:00:00Z" } } } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "Request validation failed" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "Request validation failed" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ACCOUNT_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Account not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ACCOUNT_NOT_FOUND", "messages": [ "Account not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "account_id", "schema": { "type": "string" }, "required": true, "description": "The unique identifier of the account. Found on the [Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars)." } ], "operationId": "patch_v1-banking-connectivity-accounts-account-id", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the merchant's Yuno account (UUID, 36 characters).", "example": "550e8400-e29b-41d4-a716-446655440000" }, "account_type": { "type": "string", "description": "The updated account type.", "enum": [ "CHECKING", "SAVINGS", "INVESTMENT" ], "example": "CHECKING" } } }, "examples": { "Update Account": { "summary": "Update Account", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "account_type": "CHECKING" } } } } } }, "summary": "Update Account (Banking Connectivity)", "tags": [ "Accounts (Banking Connectivity)" ] }, "delete": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "onboarding_id": "onb_990e8400-e29b-41d4-a716-446655440000", "account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "account_id": "col_bank_account_789" }, "account_type": "CHECKING", "status": "CLOSED", "account_number": "1234567890", "routing_number": "123456789", "iban": null, "currency": "USD", "balance": { "available": 0, "current": 0, "pending": 0 }, "account_details": { "account_name": "John Doe - Checking", "sort_code": null, "bsb": null, "swift": null }, "payment_rails": { "incoming": [ "ACH", "WIRE" ], "outgoing": [ "ACH", "WIRE" ] }, "supports_book_transfers": true, "created_at": "2026-02-01T10:10:00Z", "updated_at": "2026-02-25T14:30:00Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "acct_aa0e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "onboarding_id": { "type": "string", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "properties": { "account_id": { "type": "string", "example": "col_bank_account_789" } } }, "account_type": { "type": "string", "example": "CHECKING" }, "status": { "type": "string", "example": "CLOSED" }, "account_number": { "type": "string", "example": "1234567890" }, "routing_number": { "type": "string", "example": "123456789" }, "iban": {}, "currency": { "type": "string", "example": "USD" }, "balance": { "type": "object", "properties": { "available": { "type": "integer", "example": 0, "default": 0 }, "current": { "type": "integer", "example": 0, "default": 0 }, "pending": { "type": "integer", "example": 0, "default": 0 } } }, "account_details": { "type": "object", "properties": { "account_name": { "type": "string", "example": "John Doe - Checking" }, "sort_code": {}, "bsb": {}, "swift": {} } }, "payment_rails": { "type": "object", "properties": { "incoming": { "type": "array", "items": { "type": "string", "example": "ACH" } }, "outgoing": { "type": "array", "items": { "type": "string", "example": "ACH" } } } }, "supports_book_transfers": { "type": "boolean", "example": true, "default": true }, "created_at": { "type": "string", "example": "2026-02-01T10:10:00Z" }, "updated_at": { "type": "string", "example": "2026-02-25T14:30:00Z" } } } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "Account must have a zero balance before it can be closed" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "Account must have a zero balance before it can be closed" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ACCOUNT_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Account not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ACCOUNT_NOT_FOUND", "messages": [ "Account not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "account_id", "schema": { "type": "string" }, "required": true, "description": "The unique identifier of the account. Found on the [Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars)." } ], "operationId": "delete_v1-banking-connectivity-accounts-account-id", "summary": "Close Account (Banking Connectivity)", "tags": [ "Accounts (Banking Connectivity)" ] } }, "/banking/accounts/{account_id}/transfers/{transfer_id}": { "get": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "Pending": { "summary": "Pending", "value": { "id": "xfer_bb0e8400-e29b-41d4-a716-446655440000", "source_account_id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "destination_account_id": null, "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_transfer_id": "merchant_txn_12345", "provider": { "account_id": "col_bank_account_789", "transfer_id": "col_transfer_xyz123" }, "status": "PENDING", "direction": "OUTGOING", "destination_account": { "account_number_last_4": "3210", "routing_number": "987654321", "iban": null, "bsb": null, "swift": null, "sort_code": null, "account_name": "Jane Smith", "bank_name": "Chase Bank" }, "amount": { "value": 1000, "currency": "USD" }, "payment_rail": "ACH_STANDARD", "description": "Payment to vendor", "created_at": "2026-02-01T10:15:00Z", "updated_at": "2026-02-01T10:15:00Z" } }, "Completed": { "summary": "Completed", "value": { "id": "xfer_bb0e8400-e29b-41d4-a716-446655440000", "source_account_id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "destination_account_id": null, "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_transfer_id": "merchant_txn_12345", "provider": { "account_id": "col_bank_account_789", "transfer_id": "col_transfer_xyz123" }, "status": "COMPLETED", "direction": "OUTGOING", "destination_account": { "account_number_last_4": "3210", "routing_number": "987654321", "iban": null, "bsb": null, "swift": null, "sort_code": null, "account_name": "Jane Smith", "bank_name": "Chase Bank" }, "amount": { "value": 1000, "currency": "USD" }, "payment_rail": "ACH_STANDARD", "description": "Payment to vendor", "created_at": "2026-02-01T10:15:00Z", "updated_at": "2026-02-02T14:30:00Z" } } } } } }, "401": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "NOT_AUTHENTICATED" }, "messages": { "type": "array", "items": { "type": "string", "example": "Missing required authentication headers" } }, "http_code": { "type": "integer", "example": 401, "default": 0 } } }, "examples": { "Unauthorized": { "summary": "Unauthorized", "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Missing required authentication headers" ], "http_code": 401 } } } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ACCOUNT_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Account not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ACCOUNT_NOT_FOUND", "messages": [ "Account not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "account_id", "schema": { "type": "string" }, "required": true, "description": "The unique identifier of the account. Found on the [Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars)." }, { "in": "path", "name": "transfer_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the transfer obtained from [Initiate Entity Transfer](/reference/initiate-entity-transfer) (UUID, 36 chars)." } ], "operationId": "get_v1-banking-connectivity-accounts-account-id-transfers-transfer-id", "summary": "Get Entity Transfer Status (Banking Connectivity)", "tags": [ "Entity Transfers (Banking Connectivity)" ] } }, "/banking/accounts/{account_id}/transfers/{transfer_id}/cancel": { "post": { "description": "", "responses": { "200": { "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "Only transfers in PENDING status can be cancelled" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "Only transfers in PENDING status can be cancelled" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ACCOUNT_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Account not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ACCOUNT_NOT_FOUND", "messages": [ "Account not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "account_id", "schema": { "type": "string" }, "required": true, "description": "The unique identifier of the account. Found on the [Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars)." }, { "in": "path", "name": "transfer_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the transfer obtained from [Initiate Entity Transfer](/reference/initiate-entity-transfer) (UUID, 36 chars)." } ], "operationId": "post_v1-banking-connectivity-accounts-account-id-transfers-transfer-id-cancel", "summary": "Cancel Entity Transfer (Banking Connectivity)", "tags": [ "Entity Transfers (Banking Connectivity)" ] } }, "/banking/entities": { "post": { "description": "", "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "ent_770e8400-e29b-41d4-a716-446655440000" }, "account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "merchant_entity_id": { "type": "string", "example": "merchant_company_789" }, "national_entity": { "type": "string", "example": "ENTITY" }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "+1" }, "number": { "type": "string", "example": "4155551234" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "456 Market St" }, "address_line_2": {}, "building_number_1": { "type": "string", "example": "456" }, "building_number_2": {}, "city": { "type": "string", "example": "San Francisco" }, "state": { "type": "string", "example": "CA" }, "zip_code": { "type": "string", "example": "94102" }, "country": { "type": "string", "example": "US" } } }, "entity_detail": { "type": "object", "properties": { "individual": {}, "entity": { "type": "object", "properties": { "name": { "type": "string", "example": "Acme Corporation Inc" }, "country": { "type": "string", "example": "US" }, "tax_information": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "example": "US" }, "tax_id_last_4": { "type": "string", "example": "6789" }, "tax_id_type": { "type": "string", "example": "EIN" }, "is_primary": { "type": "boolean", "example": true, "default": true } } } }, "entity_type": { "type": "string", "example": "CORPORATION" }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Jane" }, "last_name": { "type": "string", "example": "Smith" }, "email": { "type": "string", "example": "jane@acme.com" }, "date_of_birth": { "type": "string", "example": "1985-03-20" }, "gender": { "type": "string", "example": "F" }, "country_of_residence": { "type": "string", "example": "US" }, "tax_information": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "example": "US" }, "tax_id_last_4": { "type": "string", "example": "4321" }, "tax_id_type": { "type": "string", "example": "SSN" }, "is_primary": { "type": "boolean", "example": true, "default": true } } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number_last_4": { "type": "string", "example": "4321" }, "issuing_country": { "type": "string", "example": "US" }, "issued_at": { "type": "string", "example": "2005-03-20" }, "expires_at": {} } }, "ownership_percentage": { "type": "integer", "example": 100, "default": 0 }, "title": { "type": "string", "example": "CEO" }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "789 Oak St" }, "address_line_2": {}, "building_number_1": { "type": "string", "example": "789" }, "building_number_2": {}, "city": { "type": "string", "example": "San Francisco" }, "state": { "type": "string", "example": "CA" }, "zip_code": { "type": "string", "example": "94103" }, "country": { "type": "string", "example": "US" } } } } } } } } } }, "created_at": { "type": "string", "example": "2026-02-01T10:00:00Z" }, "updated_at": { "type": "string", "example": "2026-02-01T10:00:00Z" } } }, "examples": { "Created (Individual)": { "summary": "Created (Individual)", "value": { "id": "ent_660e8400-e29b-41d4-a716-446655440000", "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_entity_id": "merchant_user_12345", "national_entity": "INDIVIDUAL", "phone": { "country_code": "+1", "number": "2025551234" }, "address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "building_number_1": "123", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94102", "country": "US" }, "entity_detail": { "individual": { "first_name": "John", "last_name": "Doe", "email": "john@example.com", "date_of_birth": "1990-01-15", "gender": "M", "country_of_residence": "US", "tax_information": [ { "country": "US", "tax_id_last_4": "6789", "tax_id_type": "SSN", "is_primary": true } ], "document": { "document_type": "SSN", "document_number_last_4": "6789", "issuing_country": "US", "issued_at": "2010-01-15", "expires_at": "2030-01-15" } }, "entity": null }, "created_at": "2026-02-01T10:00:00Z", "updated_at": "2026-02-01T10:00:00Z" } }, "Created (Entity)": { "summary": "Created (Entity)", "value": { "id": "ent_770e8400-e29b-41d4-a716-446655440000", "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_entity_id": "merchant_company_789", "national_entity": "ENTITY", "phone": { "country_code": "+1", "number": "4155551234" }, "address": { "address_line_1": "456 Market St", "address_line_2": null, "building_number_1": "456", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94102", "country": "US" }, "entity_detail": { "individual": null, "entity": { "name": "Acme Corporation Inc", "country": "US", "tax_information": [ { "country": "US", "tax_id_last_4": "6789", "tax_id_type": "EIN", "is_primary": true } ], "entity_type": "CORPORATION", "beneficial_owners": [ { "first_name": "Jane", "last_name": "Smith", "email": "jane@acme.com", "date_of_birth": "1985-03-20", "gender": "F", "country_of_residence": "US", "tax_information": [ { "country": "US", "tax_id_last_4": "4321", "tax_id_type": "SSN", "is_primary": true } ], "document": { "document_type": "SSN", "document_number_last_4": "4321", "issuing_country": "US", "issued_at": "2005-03-20", "expires_at": null }, "ownership_percentage": 100, "title": "CEO", "address": { "address_line_1": "789 Oak St", "address_line_2": null, "building_number_1": "789", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94103", "country": "US" } } ] } }, "created_at": "2026-02-01T10:00:00Z", "updated_at": "2026-02-01T10:00:00Z" } } } } }, "description": "Created (Individual)" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "national_entity is required" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Validation Error": { "summary": "Validation Error", "value": { "code": "VALIDATION_ERROR", "messages": [ "national_entity is required" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "409": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "Duplicate Entity": { "summary": "Duplicate Entity", "value": { "code": "DUPLICATE_ENTITY", "messages": [ "Entity with merchant_entity_id 'merchant_user_12345' already exists" ], "http_code": 409 } } } } }, "description": "Conflict" } }, "parameters": [ { "in": "header", "name": "x-idempotency-key", "schema": { "type": "string" }, "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts. See [authentication](/reference/authentication#idempotency) for details (UUID).", "required": true } ], "operationId": "post_v1-banking-connectivity-entities", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "merchant_entity_id", "national_entity", "phone", "address", "entity_detail" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the merchant's Yuno account. Found on the [Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 characters).", "example": "550e8400-e29b-41d4-a716-446655440000" }, "merchant_entity_id": { "type": "string", "description": "The merchant's own identifier for this entity, used for reconciliation.", "example": "merchant_user_12345" }, "national_entity": { "type": "string", "description": "The type of entity being created.", "enum": [ "INDIVIDUAL", "ENTITY" ], "example": "INDIVIDUAL" }, "phone": { "type": "object", "description": "The entity's phone number.", "required": [ "country_code", "number" ], "properties": { "country_code": { "type": "string", "description": "The phone country code (e.g., `+1`).", "example": "+1" }, "number": { "type": "string", "description": "The phone number without the country code.", "example": "2025551234" } } }, "address": { "type": "object", "description": "The entity's primary address.", "required": [ "address_line_1", "city", "state", "zip_code", "country" ], "properties": { "address_line_1": { "type": "string", "description": "The primary street address.", "example": "123 Main St" }, "address_line_2": { "type": [ "string", "null" ], "description": "The secondary address line (apartment, suite, etc.).", "example": "Apt 4B" }, "building_number_1": { "type": [ "string", "null" ], "description": "The primary building number.", "example": "123" }, "building_number_2": { "type": [ "string", "null" ], "description": "The secondary building number.", "example": null }, "city": { "type": "string", "description": "The city name.", "example": "San Francisco" }, "state": { "type": "string", "description": "The state or province.", "example": "CA" }, "zip_code": { "type": "string", "description": "The postal or ZIP code.", "example": "94102" }, "country": { "type": "string", "description": "The country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "example": "US" } } }, "entity_detail": { "type": "object", "description": "The detailed information for the entity. Provide either `individual` or `entity` based on the `national_entity` value.", "properties": { "individual": { "type": [ "object", "null" ], "description": "Individual person details. Required when `national_entity` is `INDIVIDUAL`.", "properties": { "first_name": { "type": "string", "description": "The individual's first name.", "example": "John" }, "last_name": { "type": "string", "description": "The individual's last name.", "example": "Doe" }, "email": { "type": "string", "description": "The individual's email address.", "example": "john@example.com" }, "date_of_birth": { "type": "string", "description": "The date of birth (YYYY-MM-DD).", "example": "1990-01-15" }, "gender": { "type": "string", "description": "The individual's gender.", "enum": [ "M", "F" ], "example": "M" }, "country_of_residence": { "type": "string", "description": "The country of residence ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "example": "US" }, "tax_information": { "type": "array", "description": "Tax identification records for the individual.", "items": { "type": "object", "required": [ "country", "tax_id", "tax_id_type", "is_primary" ], "properties": { "country": { "type": "string", "description": "The tax jurisdiction country code.", "example": "US" }, "tax_id": { "type": "string", "description": "The tax identification number.", "example": "123-45-6789" }, "tax_id_type": { "type": "string", "description": "The type of tax identification.", "enum": [ "SSN", "EIN", "ITIN", "VAT", "ABN", "NIF", "TIN", "OTHER" ], "example": "SSN" }, "is_primary": { "type": "boolean", "description": "Whether this is the primary tax residency.", "example": true } } } }, "document": { "type": "object", "description": "The primary identification document.", "required": [ "document_type", "document_number", "issuing_country" ], "properties": { "document_type": { "type": "string", "description": "The type of identity document.", "example": "SSN" }, "document_number": { "type": "string", "description": "The document number.", "example": "123-45-6789" }, "issuing_country": { "type": "string", "description": "The country that issued the document ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "example": "US" }, "issued_at": { "type": [ "string", "null" ], "description": "The date the document was issued (YYYY-MM-DD).", "example": "2010-01-15" }, "expires_at": { "type": [ "string", "null" ], "description": "The document expiration date (YYYY-MM-DD).", "example": "2030-01-15" } } } } }, "entity": { "type": [ "object", "null" ], "description": "Business or organization details. Required when `national_entity` is `ENTITY`.", "properties": { "name": { "type": "string", "description": "The business or organization name.", "example": "Acme Corporation Inc" }, "country": { "type": "string", "description": "The country of incorporation ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "example": "US" }, "tax_information": { "type": "array", "description": "Business tax identification records.", "items": { "type": "object", "required": [ "country", "tax_id", "tax_id_type", "is_primary" ], "properties": { "country": { "type": "string", "description": "The tax jurisdiction country code.", "example": "US" }, "tax_id": { "type": "string", "description": "The tax identification number.", "example": "12-3456789" }, "tax_id_type": { "type": "string", "description": "The type of tax identification.", "enum": [ "SSN", "EIN", "ITIN", "VAT", "ABN", "NIF", "TIN", "OTHER" ], "example": "EIN" }, "is_primary": { "type": "boolean", "description": "Whether this is the primary tax residency.", "example": true } } } }, "entity_type": { "type": "string", "description": "The type of business entity.", "enum": [ "CORPORATION" ], "example": "CORPORATION" }, "beneficial_owners": { "type": "array", "description": "The beneficial owners of the business entity.", "items": { "type": "object", "required": [ "first_name", "last_name", "email", "date_of_birth", "country_of_residence", "ownership_percentage" ], "properties": { "first_name": { "type": "string", "description": "The owner's first name.", "example": "Jane" }, "last_name": { "type": "string", "description": "The owner's last name.", "example": "Smith" }, "email": { "type": "string", "description": "The owner's email address.", "example": "jane@acme.com" }, "date_of_birth": { "type": "string", "description": "The owner's date of birth (YYYY-MM-DD).", "example": "1985-03-20" }, "gender": { "type": "string", "description": "The owner's gender.", "enum": [ "M", "F" ], "example": "F" }, "country_of_residence": { "type": "string", "description": "The owner's country of residence ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "example": "US" }, "tax_information": { "type": "array", "description": "Tax identification records for the owner.", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "The tax jurisdiction country code.", "example": "US" }, "tax_id": { "type": "string", "description": "The tax identification number.", "example": "987-65-4321" }, "tax_id_type": { "type": "string", "description": "The type of tax identification.", "enum": [ "SSN", "EIN", "ITIN", "VAT", "ABN", "NIF", "TIN", "OTHER" ], "example": "SSN" }, "is_primary": { "type": "boolean", "description": "Whether this is the primary tax residency.", "example": true } } } }, "document": { "type": "object", "description": "The owner's primary identification document.", "properties": { "document_type": { "type": "string", "description": "The type of identity document.", "example": "SSN" }, "document_number": { "type": "string", "description": "The document number.", "example": "987-65-4321" }, "issuing_country": { "type": "string", "description": "The country that issued the document.", "example": "US" }, "issued_at": { "type": [ "string", "null" ], "description": "The date the document was issued (YYYY-MM-DD).", "example": "2005-03-20" }, "expires_at": { "type": [ "string", "null" ], "description": "The document expiration date (YYYY-MM-DD).", "example": null } } }, "ownership_percentage": { "type": "number", "description": "The percentage of ownership in the business (0-100).", "example": 100 }, "title": { "type": "string", "description": "The owner's title or role in the organization.", "example": "CEO" }, "address": { "type": "object", "description": "The owner's residential address.", "properties": { "address_line_1": { "type": "string", "description": "The primary street address.", "example": "789 Oak St" }, "address_line_2": { "type": [ "string", "null" ], "description": "The secondary address line.", "example": null }, "building_number_1": { "type": [ "string", "null" ], "description": "The primary building number.", "example": "789" }, "building_number_2": { "type": [ "string", "null" ], "description": "The secondary building number.", "example": null }, "city": { "type": "string", "description": "The city name.", "example": "San Francisco" }, "state": { "type": "string", "description": "The state or province.", "example": "CA" }, "zip_code": { "type": "string", "description": "The postal or ZIP code.", "example": "94103" }, "country": { "type": "string", "description": "The country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "example": "US" } } } } } } } } } } } }, "examples": { "Create Individual": { "summary": "Create Individual", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_entity_id": "merchant_user_12345", "national_entity": "INDIVIDUAL", "phone": { "country_code": "+1", "number": "2025551234" }, "address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "building_number_1": "123", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94102", "country": "US" }, "entity_detail": { "individual": { "first_name": "John", "last_name": "Doe", "email": "john@example.com", "date_of_birth": "1990-01-15", "gender": "M", "country_of_residence": "US", "tax_information": [ { "country": "US", "tax_id": "123-45-6789", "tax_id_type": "SSN", "is_primary": true } ], "document": { "document_type": "SSN", "document_number": "123-45-6789", "issuing_country": "US", "issued_at": "2010-01-15", "expires_at": "2030-01-15" } }, "entity": null } } }, "Create Entity": { "summary": "Create Entity", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_entity_id": "merchant_company_789", "national_entity": "ENTITY", "phone": { "country_code": "+1", "number": "4155551234" }, "address": { "address_line_1": "456 Market St", "address_line_2": null, "building_number_1": "456", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94102", "country": "US" }, "entity_detail": { "individual": null, "entity": { "name": "Acme Corporation Inc", "country": "US", "tax_information": [ { "country": "US", "tax_id": "12-3456789", "tax_id_type": "EIN", "is_primary": true } ], "entity_type": "CORPORATION", "beneficial_owners": [ { "first_name": "Jane", "last_name": "Smith", "email": "jane@acme.com", "date_of_birth": "1985-03-20", "gender": "F", "country_of_residence": "US", "tax_information": [ { "country": "US", "tax_id": "987-65-4321", "tax_id_type": "SSN", "is_primary": true } ], "document": { "document_type": "SSN", "document_number": "987-65-4321", "issuing_country": "US", "issued_at": "2005-03-20", "expires_at": null }, "ownership_percentage": 100, "title": "CEO", "address": { "address_line_1": "789 Oak St", "address_line_2": null, "building_number_1": "789", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94103", "country": "US" } } ] } } } } } } } }, "summary": "Create Entity (Banking Connectivity)", "tags": [ "Entities (Banking Connectivity)" ] } }, "/banking/entities/{entity_id}": { "get": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_entity_id": "merchant_user_12345", "national_entity": "INDIVIDUAL", "phone": { "country_code": "+1", "number": "2025551234" }, "address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "building_number_1": "123", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94102", "country": "US" }, "entity_detail": { "individual": { "first_name": "John", "last_name": "Doe", "email": "john@example.com", "date_of_birth": "1990-01-15", "gender": "M", "country_of_residence": "US", "tax_information": [ { "country": "US", "tax_id": "123-45-6789", "tax_id_type": "SSN", "is_primary": true } ], "document": { "document_type": "SSN", "document_number": "123-45-6789", "issuing_country": "US", "issued_at": "2010-01-15", "expires_at": "2030-01-15" } }, "entity": null } } } }, "schema": { "type": "object", "properties": { "account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "merchant_entity_id": { "type": "string", "example": "merchant_user_12345" }, "national_entity": { "type": "string", "example": "INDIVIDUAL" }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "+1" }, "number": { "type": "string", "example": "2025551234" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "building_number_1": { "type": "string", "example": "123" }, "building_number_2": {}, "city": { "type": "string", "example": "San Francisco" }, "state": { "type": "string", "example": "CA" }, "zip_code": { "type": "string", "example": "94102" }, "country": { "type": "string", "example": "US" } } }, "entity_detail": { "type": "object", "properties": { "individual": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john@example.com" }, "date_of_birth": { "type": "string", "example": "1990-01-15" }, "gender": { "type": "string", "example": "M" }, "country_of_residence": { "type": "string", "example": "US" }, "tax_information": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "example": "US" }, "tax_id": { "type": "string", "example": "123-45-6789" }, "tax_id_type": { "type": "string", "example": "SSN" }, "is_primary": { "type": "boolean", "example": true, "default": true } } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" }, "issuing_country": { "type": "string", "example": "US" }, "issued_at": { "type": "string", "example": "2010-01-15" }, "expires_at": { "type": "string", "example": "2030-01-15" } } } } }, "entity": {} } } } } } } }, "401": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "Unauthorized": { "summary": "Unauthorized", "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Missing required authentication headers" ], "http_code": 401 } } } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "Entity Not Found": { "summary": "Entity Not Found", "value": { "code": "ENTITY_NOT_FOUND", "messages": [ "Entity not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "entity_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the entity obtained from [Create Entity](/reference/create-entity)" } ], "operationId": "get_v1-banking-connectivity-entities-entity-id", "summary": "Get Entity Details (Banking Connectivity)", "tags": [ "Entities (Banking Connectivity)" ] }, "patch": { "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the entity (prefixed `ent_`).", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "account_id": { "type": "string", "description": "The merchant's Yuno account identifier.", "example": "550e8400-e29b-41d4-a716-446655440000" }, "merchant_entity_id": { "type": "string", "description": "The merchant's own identifier for this entity.", "example": "merchant_user_12345" }, "national_entity": { "type": "string", "description": "The type of entity.", "enum": [ "INDIVIDUAL", "ENTITY" ], "example": "INDIVIDUAL" }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "+1" }, "number": { "type": "string", "example": "2025559999" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "456 Oak Ave" }, "address_line_2": { "type": [ "string", "null" ], "example": "Suite 100" }, "building_number_1": { "type": [ "string", "null" ], "example": "456" }, "building_number_2": { "type": [ "string", "null" ], "example": null }, "city": { "type": "string", "example": "San Francisco" }, "state": { "type": "string", "example": "CA" }, "zip_code": { "type": "string", "example": "94105" }, "country": { "type": "string", "example": "US" } } }, "entity_detail": { "type": "object", "properties": { "individual": { "type": [ "object", "null" ], "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.new@example.com" }, "date_of_birth": { "type": "string", "example": "1990-01-15" }, "gender": { "type": "string", "example": "M" }, "country_of_residence": { "type": "string", "example": "US" }, "tax_information": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "example": "US" }, "tax_id_last_4": { "type": "string", "example": "6789" }, "tax_id_type": { "type": "string", "example": "SSN" }, "is_primary": { "type": "boolean", "example": true } } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number_last_4": { "type": "string", "example": "6789" }, "issuing_country": { "type": "string", "example": "US" }, "issued_at": { "type": "string", "example": "2010-01-15" }, "expires_at": { "type": [ "string", "null" ], "example": "2030-01-15" } } } } }, "entity": { "type": [ "object", "null" ] } } }, "created_at": { "type": "string", "description": "The timestamp when the entity was created (ISO 8601).", "example": "2026-02-01T10:00:00Z" }, "updated_at": { "type": "string", "description": "The timestamp when the entity was last updated (ISO 8601).", "example": "2026-02-01T12:00:00Z" } } }, "examples": { "OK (Updated Individual)": { "summary": "OK (Updated Individual)", "value": { "id": "ent_660e8400-e29b-41d4-a716-446655440000", "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_entity_id": "merchant_user_12345", "national_entity": "INDIVIDUAL", "phone": { "country_code": "+1", "number": "2025559999" }, "address": { "address_line_1": "456 Oak Ave", "address_line_2": "Suite 100", "building_number_1": "456", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94105", "country": "US" }, "entity_detail": { "individual": { "first_name": "John", "last_name": "Doe", "email": "john.new@example.com", "date_of_birth": "1990-01-15", "gender": "M", "country_of_residence": "US", "tax_information": [ { "country": "US", "tax_id_last_4": "6789", "tax_id_type": "SSN", "is_primary": true } ], "document": { "document_type": "SSN", "document_number_last_4": "6789", "issuing_country": "US", "issued_at": "2010-01-15", "expires_at": "2030-01-15" } }, "entity": null }, "created_at": "2026-02-01T10:00:00Z", "updated_at": "2026-02-01T12:00:00Z" } } } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "national_entity type cannot be changed after creation" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "national_entity type cannot be changed after creation" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ENTITY_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Entity not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ENTITY_NOT_FOUND", "messages": [ "Entity not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "entity_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the entity obtained from [Create Entity](/reference/create-entity)." } ], "operationId": "patch_v1-banking-connectivity-entities-entity-id", "summary": "Update Entity (Banking Connectivity)", "tags": [ "Entities (Banking Connectivity)" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the merchant's Yuno account (UUID, 36 characters).", "example": "550e8400-e29b-41d4-a716-446655440000" }, "merchant_entity_id": { "type": "string", "description": "The merchant's own identifier for this entity.", "example": "merchant_user_12345" }, "phone": { "type": "object", "description": "Updated phone number.", "properties": { "country_code": { "type": "string", "description": "The phone country code.", "example": "+1" }, "number": { "type": "string", "description": "The phone number without the country code.", "example": "2025559999" } } }, "address": { "type": "object", "description": "Updated address. Only include fields that need to change.", "properties": { "address_line_1": { "type": "string", "description": "The primary street address.", "example": "456 Oak Ave" }, "address_line_2": { "type": [ "string", "null" ], "description": "The secondary address line.", "example": "Suite 100" }, "building_number_1": { "type": [ "string", "null" ], "description": "The primary building number.", "example": "456" }, "building_number_2": { "type": [ "string", "null" ], "description": "The secondary building number.", "example": null }, "city": { "type": "string", "description": "The city name.", "example": "San Francisco" }, "state": { "type": "string", "description": "The state or province.", "example": "CA" }, "zip_code": { "type": "string", "description": "The postal or ZIP code.", "example": "94105" }, "country": { "type": "string", "description": "The country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "example": "US" } } }, "entity_detail": { "type": "object", "description": "Updated entity details. Only include fields that need to change.", "properties": { "individual": { "type": [ "object", "null" ], "description": "Updated individual details.", "properties": { "email": { "type": "string", "description": "Updated email address.", "example": "john.new@example.com" }, "country_of_residence": { "type": "string", "description": "Updated country of residence.", "example": "US" } } }, "entity": { "type": [ "object", "null" ], "description": "Updated business details.", "properties": { "name": { "type": "string", "description": "Updated business name.", "example": "Acme Corp LLC" } } } } } } }, "examples": { "Update Individual": { "summary": "Update Individual", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "phone": { "country_code": "+1", "number": "2025559999" }, "address": { "address_line_1": "456 Oak Ave", "address_line_2": "Suite 100", "building_number_1": "456", "building_number_2": null, "city": "San Francisco", "state": "CA", "zip_code": "94105", "country": "US" }, "entity_detail": { "individual": { "email": "john.new@example.com" } } } } } } } } } }, "/banking/entities/{entity_id}/onboardings": { "post": { "description": "", "responses": { "200": { "description": "" }, "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "yuno_account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "properties": { "entity_id": { "type": "string", "example": "col_entity_onboarded_123" }, "status": { "type": "string", "example": "verification_pending" } } }, "onboarding_type": { "type": "string", "example": "ONE_STEP" }, "status": { "type": "string", "example": "PENDING" }, "requirements": { "type": "array", "items": { "type": "object", "properties": {} } }, "created_at": { "type": "string", "example": "2026-02-01T10:00:00Z" }, "updated_at": { "type": "string", "example": "2026-02-01T10:00:00Z" }, "expires_at": { "type": "string", "example": "2026-02-08T10:00:00Z" } } }, "examples": { "Created (Entity onboarding)": { "summary": "Created (Entity onboarding)", "value": { "id": "onb_990e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "yuno_account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "entity_id": "col_entity_onboarded_123", "status": "verification_pending" }, "onboarding_type": "ONE_STEP", "status": "PENDING", "requirements": [], "created_at": "2026-02-01T10:00:00Z", "updated_at": "2026-02-01T10:00:00Z", "expires_at": "2026-02-08T10:00:00Z" } } } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "compliance_declaration is required for ONE_STEP onboarding" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "compliance_declaration is required for ONE_STEP onboarding" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ENTITY_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Entity not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ENTITY_NOT_FOUND", "messages": [ "Entity not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "entity_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the entity obtained from [Create Entity](/reference/create-entity)." }, { "in": "header", "name": "x-idempotency-key", "schema": { "type": "string" }, "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts. See [authentication](/reference/authentication#idempotency) for details (UUID).", "required": true } ], "operationId": "post_v1-banking-connectivity-entities-entity-id-onboardings", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "yuno_connection_id", "onboarding_type" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the merchant's Yuno account (UUID, 36 characters).", "example": "550e8400-e29b-41d4-a716-446655440000" }, "yuno_connection_id": { "type": "string", "description": "The pre-configured Banking Connectivity provider connection identifier.", "example": "conn_550e8400-e29b-41d4-a716-446655440001" }, "onboarding_type": { "type": "string", "description": "The onboarding workflow type. `ONE_STEP` submits all information at once for provider processing. `PREVIOUSLY_ONBOARDED` generates an internal Yuno ID without contacting the provider.", "enum": [ "ONE_STEP", "PREVIOUSLY_ONBOARDED" ], "example": "ONE_STEP" }, "compliance_declaration": { "type": "object", "description": "Legal agreements accepted by the entity. Required for `ONE_STEP` onboarding.", "properties": { "terms_of_service": { "type": "object", "description": "Terms of service acceptance record.", "required": [ "accepted", "accepted_at" ], "properties": { "accepted": { "type": "boolean", "description": "Whether the terms of service were accepted.", "example": true }, "version": { "type": "string", "description": "The version of terms accepted.", "example": "1.2.0" }, "accepted_at": { "type": "string", "description": "The timestamp when accepted (ISO 8601).", "example": "2026-02-01T10:00:00Z" }, "accepted_ip": { "type": "string", "description": "The IP address from which the terms were accepted.", "example": "192.168.1.1" } } }, "privacy_policy": { "type": "object", "description": "Privacy policy acceptance record.", "required": [ "accepted", "accepted_at" ], "properties": { "accepted": { "type": "boolean", "description": "Whether the privacy policy was accepted.", "example": true }, "version": { "type": "string", "description": "The version of the privacy policy accepted.", "example": "2.1.0" }, "accepted_at": { "type": "string", "description": "The timestamp when accepted (ISO 8601).", "example": "2026-02-01T10:00:00Z" }, "accepted_ip": { "type": "string", "description": "The IP address from which the policy was accepted.", "example": "192.168.1.1" } } } } }, "risk_assessment": { "type": "object", "description": "Pre-existing compliance screening results provided by the merchant.", "properties": { "assessed_at": { "type": "string", "description": "The timestamp when the assessment was performed (ISO 8601).", "example": "2026-02-01T10:00:00Z" }, "pep_status": { "type": "object", "description": "Politically Exposed Person (PEP) screening results.", "properties": { "is_pep": { "type": "boolean", "description": "Whether the entity is a PEP.", "example": false }, "pep_level": { "type": [ "string", "null" ], "description": "The PEP classification level.", "enum": [ "DIRECT", "CLOSE_ASSOCIATE", "FAMILY_MEMBER", null ], "example": null }, "position": { "type": [ "string", "null" ], "description": "The political role or position, if applicable.", "example": null }, "country": { "type": [ "string", "null" ], "description": "The country of PEP status.", "example": null } } }, "rca_status": { "type": "object", "description": "Risk Classification Assessment results.", "properties": { "risk_level": { "type": "string", "description": "The assessed risk level.", "enum": [ "LOW", "MEDIUM", "HIGH" ], "example": "LOW" }, "classified_at": { "type": "string", "description": "The timestamp when classified (ISO 8601).", "example": "2026-02-01T10:00:00Z" }, "assessed_by": { "type": "string", "description": "The name of the assessor or team.", "example": "Merchant Compliance Team" } } }, "sanctions_screening": { "type": "object", "description": "Sanctions list screening results.", "properties": { "appears_on_sanctions_list": { "type": "boolean", "description": "Whether the entity appears on any sanctions list.", "example": false }, "sanctions_list_name": { "type": [ "string", "null" ], "description": "The name of the sanctions list, if matched.", "example": null }, "screened_at": { "type": "string", "description": "The timestamp when the screening was performed (ISO 8601).", "example": "2026-02-01T09:00:00Z" } } } } }, "source_of_funds": { "type": "object", "description": "AML/KYC information about the source of funds.", "properties": { "primary_source": { "type": "string", "description": "The primary source of funds.", "enum": [ "EMPLOYMENT_SALARY", "BUSINESS_INCOME", "INVESTMENTS", "RENTAL_INCOME", "PENSION", "GOVERNMENT_BENEFITS", "INHERITANCE", "FAMILY_SUPPORT", "SAVINGS", "LOTTERY_GAMBLING", "SALE_OF_ASSETS", "CRYPTOCURRENCY", "FREELANCE_CONSULTING", "OTHER" ], "example": "EMPLOYMENT_SALARY" }, "secondary_sources": { "type": "array", "description": "Additional sources of funds.", "items": { "type": "string" }, "example": [ "INVESTMENTS" ] }, "description": { "type": "string", "description": "A detailed explanation of the source of funds.", "example": "Primary income from full-time employment as software engineer, supplemented by stock portfolio dividends" }, "estimated_annual_income": { "type": "object", "description": "The estimated annual income.", "properties": { "amount": { "type": "number", "description": "The annual income amount.", "example": 175000 }, "currency": { "type": "string", "description": "The currency ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).", "example": "USD" } } } } }, "documentation": { "type": "array", "description": "KYC/KYB documents. Each item uses a `type` discriminator to determine which sub-object to populate. Supported types: `IDENTITY_DOCUMENT`, `PROOF_OF_ADDRESS`, `BANK_STATEMENT`, `BUSINESS_DOCUMENT`, `TAX_INFORMATION`, `FINANCIAL_DOCUMENT`, `BIOMETRIC_VERIFICATION`, `EMPLOYMENT_INFORMATION`.", "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The document type discriminator.", "enum": [ "IDENTITY_DOCUMENT", "PROOF_OF_ADDRESS", "BANK_STATEMENT", "BUSINESS_DOCUMENT", "TAX_INFORMATION", "FINANCIAL_DOCUMENT", "BIOMETRIC_VERIFICATION", "EMPLOYMENT_INFORMATION" ], "example": "IDENTITY_DOCUMENT" }, "identity_document": { "type": "object", "description": "Identity document details. Provide when `type` is `IDENTITY_DOCUMENT`.", "properties": { "subtype": { "type": "string", "description": "The identity document subtype.", "enum": [ "PASSPORT", "DRIVERS_LICENSE", "NATIONAL_ID", "STATE_ID" ], "example": "DRIVERS_LICENSE" }, "document_number": { "type": "string", "description": "The document number.", "example": "D1234567" }, "issuing_country": { "type": "string", "description": "The issuing country ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "example": "US" }, "issuing_state": { "type": "string", "description": "The issuing state or province.", "example": "CA" }, "issued_at": { "type": "string", "description": "The issue date (YYYY-MM-DD).", "example": "2020-01-15" }, "expires_at": { "type": "string", "description": "The expiration date (YYYY-MM-DD).", "example": "2028-01-15" }, "front_image": { "type": "object", "description": "The front image of the document.", "properties": { "file_name": { "type": "string", "example": "license_front.jpg" }, "content_type": { "type": "string", "example": "image/jpeg" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } }, "back_image": { "type": "object", "description": "The back image of the document.", "properties": { "file_name": { "type": "string", "example": "license_back.jpg" }, "content_type": { "type": "string", "example": "image/jpeg" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } } } }, "proof_of_address": { "type": "object", "description": "Proof of address details. Provide when `type` is `PROOF_OF_ADDRESS`.", "properties": { "subtype": { "type": "string", "description": "The proof of address subtype.", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "LEASE_AGREEMENT", "MORTGAGE_STATEMENT", "TAX_DOCUMENT" ], "example": "UTILITY_BILL" }, "provider_name": { "type": "string", "description": "The utility or service provider name.", "example": "PG&E" }, "bill_type": { "type": "string", "description": "The type of bill.", "example": "ELECTRICITY" }, "issued_at": { "type": "string", "description": "The bill issue date (YYYY-MM-DD).", "example": "2026-01-01" }, "account_number": { "type": "string", "description": "The account number with the provider.", "example": "ACC-123456" }, "verified_address": { "type": "object", "description": "The address shown on the document.", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "city": { "type": "string", "example": "San Francisco" }, "state": { "type": "string", "example": "CA" }, "zip_code": { "type": "string", "example": "94102" }, "country": { "type": "string", "example": "US" } } }, "file": { "type": "object", "description": "The document file.", "properties": { "file_name": { "type": "string", "example": "utility_bill.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } } } }, "bank_statement": { "type": "object", "description": "Bank statement details. Provide when `type` is `BANK_STATEMENT`.", "properties": { "bank_name": { "type": "string", "description": "The bank name.", "example": "Chase Bank" }, "account_number_last_4": { "type": "string", "description": "Last 4 digits of the account number.", "example": "1234" }, "statement_period_start": { "type": "string", "description": "The statement period start date (YYYY-MM-DD).", "example": "2025-12-01" }, "statement_period_end": { "type": "string", "description": "The statement period end date (YYYY-MM-DD).", "example": "2025-12-31" }, "file": { "type": "object", "properties": { "file_name": { "type": "string", "example": "bank_statement_dec_2025.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } } } }, "business_document": { "type": "object", "description": "Business document details. Provide when `type` is `BUSINESS_DOCUMENT`.", "properties": { "subtype": { "type": "string", "enum": [ "ARTICLES_OF_INCORPORATION", "BUSINESS_LICENSE", "EIN_CONFIRMATION", "OPERATING_AGREEMENT", "CERTIFICATE_OF_GOOD_STANDING" ], "example": "ARTICLES_OF_INCORPORATION" }, "registration_number": { "type": "string", "description": "The business registration number.", "example": "REG-2020-12345" }, "registered_at": { "type": "string", "description": "The registration date (YYYY-MM-DD).", "example": "2020-01-15" }, "issuing_state": { "type": "string", "description": "The issuing state.", "example": "CA" }, "issuing_authority": { "type": "string", "description": "The issuing authority.", "example": "California Secretary of State" }, "file": { "type": "object", "properties": { "file_name": { "type": "string", "example": "articles_of_incorporation.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } } } }, "tax_information": { "type": "object", "description": "Tax information details. Provide when `type` is `TAX_INFORMATION`.", "properties": { "tax_records": { "type": "array", "description": "Tax identification records.", "items": { "type": "object", "properties": { "country": { "type": "string", "example": "US" }, "tax_id": { "type": "string", "example": "123-45-6789" }, "tax_id_type": { "type": "string", "enum": [ "SSN", "EIN", "ITIN", "VAT", "ABN", "NIF", "TIN", "OTHER" ], "example": "SSN" }, "is_primary": { "type": "boolean", "example": true } } } }, "tax_document_type": { "type": "string", "description": "The type of tax document.", "enum": [ "W9", "1099", "TAX_RETURN", "SSN_CARD", "ITIN_LETTER", "EIN_CONFIRMATION", "VAT_CERTIFICATE" ], "example": "W9" }, "tax_year": { "type": "string", "description": "The tax year.", "example": "2025" }, "issuing_authority": { "type": "string", "description": "The tax authority.", "example": "IRS" }, "file": { "type": "object", "properties": { "file_name": { "type": "string", "example": "w9_form.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } } } }, "financial_document": { "type": "object", "description": "Financial document details. Provide when `type` is `FINANCIAL_DOCUMENT`.", "properties": { "subtype": { "type": "string", "enum": [ "BALANCE_SHEET", "PROFIT_LOSS_STATEMENT", "CASH_FLOW_STATEMENT", "FINANCIAL_AUDIT" ], "example": "BALANCE_SHEET" }, "period_start": { "type": "string", "description": "Period start date (YYYY-MM-DD).", "example": "2025-01-01" }, "period_end": { "type": "string", "description": "Period end date (YYYY-MM-DD).", "example": "2025-12-31" }, "fiscal_year": { "type": "string", "example": "2025" }, "audited": { "type": "boolean", "description": "Whether the document has been audited.", "example": false }, "auditor_name": { "type": [ "string", "null" ], "description": "The auditor name, if audited.", "example": null }, "file": { "type": "object", "properties": { "file_name": { "type": "string", "example": "balance_sheet_2025.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } } } }, "biometric_verification": { "type": "object", "description": "Biometric verification details. Provide when `type` is `BIOMETRIC_VERIFICATION`.", "properties": { "verification_method": { "type": "string", "enum": [ "FACIAL_RECOGNITION", "FINGERPRINT", "VOICE", "IRIS_SCAN" ], "example": "FACIAL_RECOGNITION" }, "capture_method": { "type": "string", "enum": [ "LIVE_CAPTURE", "UPLOADED" ], "example": "LIVE_CAPTURE" }, "capture_timestamp": { "type": "string", "description": "When the biometric was captured (ISO 8601).", "example": "2026-02-01T10:00:00Z" }, "liveness_check_passed": { "type": "boolean", "description": "Whether the liveness check passed.", "example": true }, "confidence_score": { "type": "number", "description": "The verification confidence score (0-1).", "example": 0.98 }, "verification_provider": { "type": "string", "description": "The biometric verification provider.", "example": "Onfido" }, "live_image": { "type": "object", "properties": { "file_name": { "type": "string", "example": "live_capture.jpg" }, "content_type": { "type": "string", "example": "image/jpeg" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } }, "reference_image": { "type": "object", "properties": { "file_name": { "type": "string", "example": "id_photo_reference.jpg" }, "content_type": { "type": "string", "example": "image/jpeg" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } } } }, "employment_information": { "type": "object", "description": "Employment information details. Provide when `type` is `EMPLOYMENT_INFORMATION`.", "properties": { "status": { "type": "string", "description": "The employment status.", "enum": [ "EMPLOYED", "SELF_EMPLOYED", "UNEMPLOYED", "RETIRED", "STUDENT" ], "example": "EMPLOYED" }, "employer_name": { "type": "string", "description": "The employer name.", "example": "Tech Corp Inc" }, "occupation": { "type": "string", "description": "The job title or occupation.", "example": "Senior Software Engineer" }, "industry": { "type": "string", "description": "The industry sector.", "example": "TECHNOLOGY" }, "started_at": { "type": "string", "description": "The employment start date (YYYY-MM-DD).", "example": "2020-03-15" }, "annual_income": { "type": "object", "description": "The annual income from this employment.", "properties": { "amount": { "type": "number", "example": 150000 }, "currency": { "type": "string", "example": "USD" } } }, "verification_document": { "type": "object", "description": "Employment verification document.", "properties": { "file_name": { "type": "string", "example": "employment_letter.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content": { "type": "string", "description": "Base64-encoded file content.", "example": "base64_encoded_content" } } } } } } } } } }, "examples": { "Create entity onboarding": { "summary": "Create entity onboarding", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "yuno_connection_id": "conn_550e8400-e29b-41d4-a716-446655440001", "onboarding_type": "ONE_STEP", "compliance_declaration": { "terms_of_service": { "accepted": true, "version": "1.2.0", "accepted_at": "2026-02-01T10:00:00Z", "accepted_ip": "192.168.1.1" }, "privacy_policy": { "accepted": true, "version": "2.1.0", "accepted_at": "2026-02-01T10:00:00Z", "accepted_ip": "192.168.1.1" } }, "risk_assessment": { "assessed_at": "2026-02-01T10:00:00Z", "pep_status": { "is_pep": false, "pep_level": null, "position": null, "country": null }, "rca_status": { "risk_level": "LOW", "classified_at": "2026-02-01T10:00:00Z", "assessed_by": "Merchant Compliance Team" }, "sanctions_screening": { "appears_on_sanctions_list": false, "sanctions_list_name": null, "screened_at": "2026-02-01T09:00:00Z" } }, "source_of_funds": { "primary_source": "EMPLOYMENT_SALARY", "secondary_sources": [ "INVESTMENTS" ], "description": "Primary income from full-time employment as software engineer, supplemented by stock portfolio dividends", "estimated_annual_income": { "amount": 175000, "currency": "USD" } }, "documentation": [ { "type": "IDENTITY_DOCUMENT", "identity_document": { "subtype": "DRIVERS_LICENSE", "document_number": "D1234567", "issuing_country": "US", "issuing_state": "CA", "issued_at": "2020-01-15", "expires_at": "2028-01-15", "front_image": { "file_name": "license_front.jpg", "content_type": "image/jpeg", "content": "base64_encoded_content" }, "back_image": { "file_name": "license_back.jpg", "content_type": "image/jpeg", "content": "base64_encoded_content" } } }, { "type": "PROOF_OF_ADDRESS", "proof_of_address": { "subtype": "UTILITY_BILL", "provider_name": "PG&E", "bill_type": "ELECTRICITY", "issued_at": "2026-01-01", "account_number": "ACC-123456", "verified_address": { "address_line_1": "123 Main St", "city": "San Francisco", "state": "CA", "zip_code": "94102", "country": "US" }, "file": { "file_name": "utility_bill.pdf", "content_type": "application/pdf", "content": "base64_encoded_content" } } }, { "type": "BANK_STATEMENT", "bank_statement": { "bank_name": "Chase Bank", "account_number_last_4": "1234", "statement_period_start": "2025-12-01", "statement_period_end": "2025-12-31", "file": { "file_name": "bank_statement_dec_2025.pdf", "content_type": "application/pdf", "content": "base64_encoded_content" } } }, { "type": "TAX_INFORMATION", "tax_information": { "tax_records": [ { "country": "US", "tax_id": "123-45-6789", "tax_id_type": "SSN", "is_primary": true } ], "tax_document_type": "W9", "tax_year": "2025", "issuing_authority": "IRS", "file": { "file_name": "w9_form.pdf", "content_type": "application/pdf", "content": "base64_encoded_content" } } }, { "type": "BIOMETRIC_VERIFICATION", "biometric_verification": { "verification_method": "FACIAL_RECOGNITION", "capture_method": "LIVE_CAPTURE", "capture_timestamp": "2026-02-01T10:00:00Z", "liveness_check_passed": true, "confidence_score": 0.98, "verification_provider": "Onfido", "live_image": { "file_name": "live_capture.jpg", "content_type": "image/jpeg", "content": "base64_encoded_content" }, "reference_image": { "file_name": "id_photo_reference.jpg", "content_type": "image/jpeg", "content": "base64_encoded_content" } } }, { "type": "EMPLOYMENT_INFORMATION", "employment_information": { "status": "EMPLOYED", "employer_name": "Tech Corp Inc", "occupation": "Senior Software Engineer", "industry": "TECHNOLOGY", "started_at": "2020-03-15", "annual_income": { "amount": 150000, "currency": "USD" }, "verification_document": { "file_name": "employment_letter.pdf", "content_type": "application/pdf", "content": "base64_encoded_content" } } } ] } }, "Previously onboarded": { "summary": "Previously onboarded", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "yuno_connection_id": "conn_550e8400-e29b-41d4-a716-446655440001", "onboarding_type": "PREVIOUSLY_ONBOARDED" } } } } } }, "summary": "Create Entity Onboarding (Banking Connectivity)", "tags": [ "Entity Onboarding (Banking Connectivity)" ] } }, "/banking/entities/{entity_id}/onboardings/{onboarding_id}": { "get": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "Pending": { "summary": "Pending", "value": { "id": "onb_990e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "yuno_account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "entity_id": "col_entity_onboarded_123", "status": "verification_pending" }, "onboarding_type": "ONE_STEP", "status": "PENDING", "requirements": [], "created_at": "2026-02-01T10:00:00Z", "updated_at": "2026-02-01T10:00:00Z", "expires_at": "2026-02-08T10:00:00Z" } }, "Succeeded": { "summary": "Succeeded", "value": { "id": "onb_990e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "yuno_account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "entity_id": "col_entity_onboarded_123", "status": "active" }, "onboarding_type": "ONE_STEP", "status": "SUCCEEDED", "requirements": [], "created_at": "2026-02-01T10:00:00Z", "updated_at": "2026-02-03T14:30:00Z", "expires_at": "2026-02-08T10:00:00Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "yuno_account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "properties": { "entity_id": { "type": "string", "example": "col_entity_onboarded_123" }, "status": { "type": "string", "example": "verification_pending" } } }, "onboarding_type": { "type": "string", "example": "ONE_STEP" }, "status": { "type": "string", "example": "PENDING" }, "requirements": { "type": "array", "items": { "type": "object", "properties": {} } }, "created_at": { "type": "string", "example": "2026-02-01T10:00:00Z" }, "updated_at": { "type": "string", "example": "2026-02-01T10:00:00Z" }, "expires_at": { "type": "string", "example": "2026-02-08T10:00:00Z" } } } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ONBOARDING_NOT_FOUND", "messages": [ "Onboarding not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "entity_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the entity obtained from [Create Entity](/reference/create-entity)." }, { "in": "path", "name": "onboarding_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the onboarding obtained from [Create Entity Onboarding](/reference/create-entity-onboarding)." } ], "operationId": "get_v1-banking-connectivity-entities-entity-id-onboardings-onboarding-id", "summary": "Get Entity Onboarding Status (Banking Connectivity)", "tags": [ "Entity Onboarding (Banking Connectivity)" ] }, "patch": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": "onb_990e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "status": "PENDING", "provider_status": "verification_pending", "requirements": [], "updated_at": "2026-02-01T10:05:00Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "status": { "type": "string", "example": "PENDING" }, "provider_status": { "type": "string", "example": "verification_pending" }, "requirements": { "type": "array", "items": { "type": "object", "properties": {} } }, "updated_at": { "type": "string", "example": "2026-02-01T10:05:00Z" } } } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "Onboarding has reached a terminal status and cannot be updated" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "Onboarding has reached a terminal status and cannot be updated" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ONBOARDING_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Onboarding not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ONBOARDING_NOT_FOUND", "messages": [ "Onboarding not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "entity_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the entity obtained from [Create Entity](https://temp-yuno-docs.readme.io/reference/create-entity)." }, { "in": "path", "name": "onboarding_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the onboarding obtained from [Create Entity Onboarding](https://temp-yuno-docs.readme.io/reference/create-entity-onboarding)." } ], "operationId": "patch_v1-banking-connectivity-entities-entity-id-onboardings-onboarding-id", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the merchant's Yuno account (UUID, 36 characters).", "example": "550e8400-e29b-41d4-a716-446655440000" }, "compliance_declaration": { "type": "object", "description": "Updated legal agreements.", "properties": { "terms_of_service": { "type": "object", "properties": { "accepted": { "type": "boolean", "example": true }, "version": { "type": "string", "example": "1.2.0" }, "accepted_at": { "type": "string", "example": "2026-02-01T10:05:00Z" }, "accepted_ip": { "type": "string", "example": "192.168.1.1" } } }, "privacy_policy": { "type": "object", "properties": { "accepted": { "type": "boolean", "example": true }, "version": { "type": "string", "example": "2.1.0" }, "accepted_at": { "type": "string", "example": "2026-02-01T10:05:00Z" }, "accepted_ip": { "type": "string", "example": "192.168.1.1" } } } } }, "risk_assessment": { "type": "object", "description": "Updated risk assessment results.", "properties": { "assessed_at": { "type": "string", "example": "2026-02-01T10:05:00Z" }, "pep_status": { "type": "object", "properties": { "is_pep": { "type": "boolean", "example": false }, "pep_level": { "type": [ "string", "null" ], "example": null }, "position": { "type": [ "string", "null" ], "example": null }, "country": { "type": [ "string", "null" ], "example": null } } }, "rca_status": { "type": "object", "properties": { "risk_level": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ], "example": "LOW" }, "classified_at": { "type": "string", "example": "2026-02-01T10:05:00Z" }, "assessed_by": { "type": "string", "example": "Merchant Compliance Team" } } }, "sanctions_screening": { "type": "object", "properties": { "appears_on_sanctions_list": { "type": "boolean", "example": false }, "sanctions_list_name": { "type": [ "string", "null" ], "example": null }, "screened_at": { "type": "string", "example": "2026-02-01T09:00:00Z" } } } } }, "source_of_funds": { "type": "object", "description": "Updated source of funds information.", "properties": { "primary_source": { "type": "string", "enum": [ "EMPLOYMENT_SALARY", "BUSINESS_INCOME", "INVESTMENTS", "RENTAL_INCOME", "PENSION", "GOVERNMENT_BENEFITS", "INHERITANCE", "FAMILY_SUPPORT", "SAVINGS", "LOTTERY_GAMBLING", "SALE_OF_ASSETS", "CRYPTOCURRENCY", "FREELANCE_CONSULTING", "OTHER" ], "example": "EMPLOYMENT_SALARY" }, "secondary_sources": { "type": "array", "items": { "type": "string" }, "example": [ "INVESTMENTS" ] }, "description": { "type": "string", "example": "Primary income from full-time employment, supplemented by investment portfolio" }, "estimated_annual_income": { "type": "object", "properties": { "amount": { "type": "number", "example": 175000 }, "currency": { "type": "string", "example": "USD" } } } } }, "documentation": { "type": "array", "description": "Additional or updated KYC/KYB documents. Uses the same structure as [Create Entity Onboarding](https://temp-yuno-docs.readme.io/reference/create-entity-onboarding).", "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "IDENTITY_DOCUMENT", "PROOF_OF_ADDRESS", "BANK_STATEMENT", "BUSINESS_DOCUMENT", "TAX_INFORMATION", "FINANCIAL_DOCUMENT", "BIOMETRIC_VERIFICATION", "EMPLOYMENT_INFORMATION" ], "example": "BANK_STATEMENT" } } } } } }, "examples": { "Update Onboarding": { "summary": "Update Onboarding", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "compliance_declaration": { "terms_of_service": { "accepted": true, "version": "1.2.0", "accepted_at": "2026-02-01T10:05:00Z", "accepted_ip": "192.168.1.1" }, "privacy_policy": { "accepted": true, "version": "2.1.0", "accepted_at": "2026-02-01T10:05:00Z", "accepted_ip": "192.168.1.1" } }, "risk_assessment": { "assessed_at": "2026-02-01T10:05:00Z", "pep_status": { "is_pep": false, "pep_level": null, "position": null, "country": null }, "rca_status": { "risk_level": "LOW", "classified_at": "2026-02-01T10:05:00Z", "assessed_by": "Merchant Compliance Team" }, "sanctions_screening": { "appears_on_sanctions_list": false, "sanctions_list_name": null, "screened_at": "2026-02-01T09:00:00Z" } }, "source_of_funds": { "primary_source": "EMPLOYMENT_SALARY", "secondary_sources": [ "INVESTMENTS" ], "description": "Primary income from full-time employment, supplemented by investment portfolio", "estimated_annual_income": { "amount": 175000, "currency": "USD" } }, "documentation": [ { "type": "BANK_STATEMENT", "bank_statement": { "bank_name": "Chase Bank", "account_number_last_4": "1234", "statement_period_start": "2025-12-01", "statement_period_end": "2025-12-31", "file": { "file_name": "bank_statement_dec_2025.pdf", "content_type": "application/pdf", "content": "base64_encoded_content" } } }, { "type": "IDENTITY_DOCUMENT", "identity_document": { "subtype": "PASSPORT", "document_number": "X12345678", "issuing_country": "US", "issued_at": "2020-01-15", "expires_at": "2030-01-15", "front_image": { "file_name": "passport_front.jpg", "content_type": "image/jpeg", "content": "base64_encoded_content" } } } ] } } } } } }, "summary": "Update Entity Onboarding (Banking Connectivity)", "tags": [ "Entity Onboarding (Banking Connectivity)" ] } }, "/banking/entities/{entity_id}/onboardings/{onboarding_id}/cancel": { "post": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": "onb_990e8400-e29b-41d4-a716-446655440000", "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000", "yuno_account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "entity_id": "col_entity_onboarded_123", "status": "cancelled" }, "onboarding_type": "ONE_STEP", "status": "CANCELLED", "requirements": [], "created_at": "2026-02-01T10:00:00Z", "updated_at": "2026-02-02T08:45:00Z", "expires_at": "2026-02-08T10:00:00Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "yuno_account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "properties": { "entity_id": { "type": "string", "example": "col_entity_onboarded_123" }, "status": { "type": "string", "example": "cancelled" } } }, "onboarding_type": { "type": "string", "example": "ONE_STEP" }, "status": { "type": "string", "example": "CANCELLED" }, "requirements": { "type": "array", "items": { "type": "object", "properties": {} } }, "created_at": { "type": "string", "example": "2026-02-01T10:00:00Z" }, "updated_at": { "type": "string", "example": "2026-02-02T08:45:00Z" }, "expires_at": { "type": "string", "example": "2026-02-08T10:00:00Z" } } } } } }, "202": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "onb_990e8400-e29b-41d4-a716-446655440000" }, "entity_id": { "type": "string", "example": "ent_660e8400-e29b-41d4-a716-446655440000" }, "yuno_account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "properties": { "entity_id": { "type": "string", "example": "col_entity_onboarded_123" }, "status": { "type": "string", "example": "cancelled" } } }, "onboarding_type": { "type": "string", "example": "ONE_STEP" }, "status": { "type": "string", "example": "CANCELLED" }, "requirements": { "type": "array", "items": { "type": "object", "properties": {} } }, "created_at": { "type": "string", "example": "2026-02-01T10:00:00Z" }, "updated_at": { "type": "string", "example": "2026-02-02T08:45:00Z" }, "expires_at": { "type": "string", "example": "2026-02-08T10:00:00Z" } } } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "Onboarding has reached a terminal status and cannot be cancelled" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "Onboarding has reached a terminal status and cannot be cancelled" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ONBOARDING_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Onboarding not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ONBOARDING_NOT_FOUND", "messages": [ "Onboarding not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "entity_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the entity obtained from [Create Entity](/reference/create-entity)." }, { "in": "path", "name": "onboarding_id", "schema": { "type": "string" }, "required": true, "description": "The `id` of the entity obtained from [Create Entity](/reference/create-entity)." } ], "operationId": "post_v1-banking-connectivity-entities-entity-id-onboardings-onboarding-id-cancel", "summary": "Cancel Entity Onboarding (Banking Connectivity)", "tags": [ "Entity Onboarding (Banking Connectivity)" ] } }, "/banking/transfers": { "post": { "description": "", "responses": { "202": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "xfer_bb0e8400-e29b-41d4-a716-446655440000" }, "source_account_id": { "type": "string", "example": "acct_aa0e8400-e29b-41d4-a716-446655440000" }, "destination_account_id": {}, "account_id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "merchant_transfer_id": { "type": "string", "example": "merchant_txn_12345" }, "provider": { "type": "object", "properties": { "account_id": { "type": "string", "example": "col_bank_account_789" }, "transfer_id": { "type": "string", "example": "col_transfer_xyz123" } } }, "status": { "type": "string", "example": "PENDING" }, "direction": { "type": "string", "example": "OUTGOING" }, "destination_account": { "type": "object", "properties": { "account_number_last_4": { "type": "string", "example": "3210" }, "routing_number": { "type": "string", "example": "987654321" }, "iban": {}, "bsb": {}, "swift": {}, "sort_code": {}, "account_name": { "type": "string", "example": "Jane Smith" }, "bank_name": { "type": "string", "example": "Chase Bank" } } }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 1000, "default": 0 }, "currency": { "type": "string", "example": "USD" } } }, "payment_rail": { "type": "string", "example": "ACH_STANDARD" }, "description": { "type": "string", "example": "Payment to vendor" }, "created_at": { "type": "string", "example": "2026-02-01T10:15:00Z" }, "updated_at": { "type": "string", "example": "2026-02-01T10:15:00Z" } } }, "examples": { "Accepted (Outgoing)": { "summary": "Accepted (Outgoing)", "value": { "id": "xfer_bb0e8400-e29b-41d4-a716-446655440000", "source_account_id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "destination_account_id": null, "account_id": "550e8400-e29b-41d4-a716-446655440000", "merchant_transfer_id": "merchant_txn_12345", "provider": { "account_id": "col_bank_account_789", "transfer_id": "col_transfer_xyz123" }, "status": "PENDING", "direction": "OUTGOING", "destination_account": { "account_number_last_4": "3210", "routing_number": "987654321", "iban": null, "bsb": null, "swift": null, "sort_code": null, "account_name": "Jane Smith", "bank_name": "Chase Bank" }, "amount": { "value": 1000, "currency": "USD" }, "payment_rail": "ACH_STANDARD", "description": "Payment to vendor", "created_at": "2026-02-01T10:15:00Z", "updated_at": "2026-02-01T10:15:00Z" } } } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "messages": { "type": "array", "items": { "type": "string", "example": "source_account_id is required" } }, "http_code": { "type": "integer", "example": 400, "default": 0 } } }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "code": "VALIDATION_ERROR", "messages": [ "source_account_id is required", "destination_account or destination_account_id must be provided" ], "http_code": 400 } } } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ACCOUNT_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Account not found" } }, "http_code": { "type": "integer", "example": 404, "default": 0 } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "code": "ACCOUNT_NOT_FOUND", "messages": [ "Account not found" ], "http_code": 404 } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "header", "name": "x-idempotency-key", "schema": { "type": "string" }, "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts. See [authentication](/reference/authentication#idempotency) for details (UUID).", "required": true } ], "operationId": "post_v1-banking-connectivity-transfers", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "source_account_id", "direction", "amount", "payment_rail", "destination_account" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the merchant's Yuno account (UUID, 36 characters).", "example": "550e8400-e29b-41d4-a716-446655440000" }, "source_account_id": { "type": "string", "description": "The `id` of the source Banking Connectivity account obtained from [Create Account](/reference/create-account-banking).", "example": "acct_aa0e8400-e29b-41d4-a716-446655440000" }, "destination_account_id": { "type": [ "string", "null" ], "description": "The `id` of the destination Banking Connectivity account for internal (book) transfers. Set to `null` for external transfers.", "example": null }, "direction": { "type": "string", "description": "The transfer direction.", "enum": [ "OUTGOING" ], "example": "OUTGOING" }, "amount": { "type": "object", "description": "The transfer amount. Currency must match the source account currency.", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The transfer amount (up to 4 decimal places, max 9,999,999,999).", "example": 1000 }, "currency": { "type": "string", "description": "The currency ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)). Must match the source account currency.", "example": "USD" } } }, "payment_rail": { "type": "string", "description": "The payment rail to use for the transfer. Available rails depend on the provider region.", "enum": [ "ACH_STANDARD", "ACH_SAME_DAY", "WIRE", "RTP", "FPS", "CHAPS", "BACS", "NPP", "PAYTO", "BPAY" ], "example": "ACH_STANDARD" }, "description": { "type": "string", "description": "A description for the transfer.", "example": "Payment to vendor" }, "merchant_transfer_id": { "type": "string", "description": "The merchant's own reference ID for reconciliation.", "example": "merchant_txn_12345" }, "destination_account": { "type": "object", "description": "The external destination account details. Required fields depend on the region: US requires `account_number` and `routing_number`; UK requires `iban` or `account_number` with `sort_code`; Australia requires `account_number` with `bsb`.", "properties": { "account_number": { "type": "string", "description": "The destination bank account number.", "example": "9876543210" }, "routing_number": { "type": [ "string", "null" ], "description": "The US routing number. Required for US destinations.", "example": "987654321" }, "iban": { "type": [ "string", "null" ], "description": "The IBAN. Required for UK and SEPA destinations.", "example": null }, "bsb": { "type": [ "string", "null" ], "description": "The Australian BSB number. Required for Australian destinations.", "example": null }, "swift": { "type": [ "string", "null" ], "description": "The SWIFT/BIC code. Required for international and SEPA transfers.", "example": null }, "sort_code": { "type": [ "string", "null" ], "description": "The UK sort code. Required for UK destinations.", "example": null }, "account_name": { "type": "string", "description": "The destination account holder name.", "example": "Jane Smith" }, "bank_name": { "type": "string", "description": "The destination bank name.", "example": "Chase Bank" } } } } }, "examples": { "Outgoing Transfer": { "summary": "Outgoing Transfer", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "source_account_id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "destination_account_id": null, "direction": "OUTGOING", "amount": { "value": 1000, "currency": "USD" }, "payment_rail": "ACH_STANDARD", "description": "Payment to vendor", "merchant_transfer_id": "merchant_txn_12345", "destination_account": { "account_number": "9876543210", "routing_number": "987654321", "iban": null, "bsb": null, "swift": null, "sort_code": null, "account_name": "Jane Smith", "bank_name": "Chase Bank" } } }, "Book Transfer (Internal)": { "summary": "Book Transfer (Internal)", "value": { "account_id": "550e8400-e29b-41d4-a716-446655440000", "source_account_id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "destination_account_id": "acct_bb0e8400-e29b-41d4-a716-446655440000", "direction": "OUTGOING", "amount": { "value": 500, "currency": "USD" }, "payment_rail": "ACH_STANDARD", "description": "Internal transfer between accounts", "merchant_transfer_id": "merchant_book_67890", "destination_account": { "account_number": "1122334455", "routing_number": "123456789", "iban": null, "bsb": null, "swift": null, "sort_code": null, "account_name": "Jane Smith - Savings", "bank_name": "Column" } } } } } } }, "summary": "Initiate Entity Transfer (Banking Connectivity)", "tags": [ "Entity Transfers (Banking Connectivity)" ] } }, "/campaigns": { "get": { "description": "", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "name": { "type": "string", "example": "Declined Payment Recovery - Colombia" }, "country": { "type": "string", "example": "CO" }, "channel": { "type": "string", "example": "WHATSAPP_MESSAGE" }, "status": { "type": "string", "example": "ACTIVE" }, "duration": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2025-07-01T00:00:00Z" }, "end_at": { "type": "string", "example": "2026-07-01T00:00:00Z" } } }, "created_at": { "type": "string", "example": "2025-07-01T12:00:00Z" }, "updated_at": { "type": "string", "example": "2025-07-01T12:00:00Z" } } } }, "meta": { "type": "object", "properties": { "total": { "type": "integer", "example": 5 }, "limit": { "type": "integer", "example": 10 }, "offset": { "type": "integer", "example": 0 } } } } }, "examples": { "OK": { "summary": "OK", "value": { "data": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Declined Payment Recovery - Colombia", "country": "CO", "channel": "WHATSAPP_MESSAGE", "status": "ACTIVE", "duration": { "start_at": "2025-07-01T00:00:00Z", "end_at": "2026-07-01T00:00:00Z" }, "created_at": "2025-07-01T12:00:00Z", "updated_at": "2025-07-01T12:00:00Z" } ], "meta": { "total": 5, "limit": 10, "offset": 0 } } } } } }, "description": "" } }, "parameters": [ { "in": "query", "name": "limit", "description": "Results per page (1-100)", "schema": { "type": "integer", "default": 20 }, "required": false }, { "in": "query", "name": "offset", "description": "Number of results to skip", "schema": { "type": "integer", "default": 0 }, "required": false }, { "in": "query", "name": "start_date", "description": "Filter by start date (ISO 8601)", "schema": { "type": "string" }, "required": false }, { "in": "query", "name": "end_date", "description": "Filter by end date (ISO 8601)", "schema": { "type": "string" }, "required": false } ], "operationId": "get_campaigns", "tags": [ "Communications Campaigns" ] }, "post": { "description": "", "responses": { "200": { "description": "" }, "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "name": { "type": "string", "example": "Declined Payment Recovery - Colombia" }, "account_id": { "type": "string", "example": "2404911d-5df9-429e-8488-ad41abea1a4b" }, "organization_code": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "country": { "type": "string", "example": "CO" }, "channel": { "type": "string", "example": "WHATSAPP_MESSAGE" }, "schedule": { "type": "object", "properties": { "daily_start_time": { "type": "string", "example": "08:00" }, "daily_end_time": { "type": "string", "example": "21:00" }, "time_zone": { "type": "string", "example": "America/Bogota" } } }, "duration": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2025-07-01T00:00:00Z" }, "end_at": { "type": "string", "example": "2026-07-01T00:00:00Z" } } }, "status": { "type": "string", "example": "ACTIVE" }, "created_at": { "type": "string", "example": "2025-07-01T12:00:00Z" }, "updated_at": { "type": "string", "example": "2025-07-01T12:00:00Z" } } } } }, "examples": { "Created": { "summary": "Created", "value": { "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Declined Payment Recovery - Colombia", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "organization_code": "550e8400-e29b-41d4-a716-446655440000", "country": "CO", "channel": "WHATSAPP_MESSAGE", "schedule": { "daily_start_time": "08:00", "daily_end_time": "21:00", "time_zone": "America/Bogota" }, "duration": { "start_at": "2025-07-01T00:00:00Z", "end_at": "2026-07-01T00:00:00Z" }, "status": "ACTIVE", "created_at": "2025-07-01T12:00:00Z", "updated_at": "2025-07-01T12:00:00Z" } } } } } }, "description": "Created" } }, "parameters": [], "operationId": "post_campaigns", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Campaign name for identification." }, "account_id": { "type": "string", "description": "Your Yuno account ID, found in the [Yuno Dashboard](https://dashboard.y.uno/developers) (UUID)." }, "organization_code": { "type": "string", "description": "Your organization identifier (UUID)." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code (e.g., `CO`, `MX`, `BR`)." }, "channel": { "type": "string", "description": "Communication channel.", "enum": [ "WHATSAPP_MESSAGE", "PHONE_CALL" ] }, "focus": { "type": "string", "description": "Campaign focus descriptor (e.g., `payment_recovery`)." }, "schedule": { "type": "object", "properties": { "daily_start_time": { "type": "string", "description": "Start of daily send window in `HH:MM` format." }, "daily_end_time": { "type": "string", "description": "End of daily send window in `HH:MM` format." }, "time_zone": { "type": "string", "description": "IANA timezone (e.g., `America/Bogota`) or UTC offset (e.g., `-05:00`)" } }, "required": [ "daily_start_time", "daily_end_time", "time_zone" ], "description": "Scheduling configuration." }, "duration": { "type": "object", "properties": { "start_at": { "type": "string", "description": "Campaign start date in ISO 8601 format." }, "end_at": { "type": "string", "description": "Campaign end date in ISO 8601 format. Must be after `start_at`." } }, "required": [ "end_at", "start_at" ], "description": "Campaign active period." } }, "required": [ "name", "duration", "schedule", "channel", "country", "organization_code", "account_id" ] }, "examples": { "Basic declined payment recovery": { "summary": "Basic declined payment recovery", "value": { "name": "Mexico Card Recovery", "account_id": "YOUR_ACCOUNT_ID", "organization_code": "YOUR_ORGANIZATION_CODE", "country": "MX", "channel": "WHATSAPP_MESSAGE", "focus": "payment_recovery", "schedule": { "daily_start_time": "09:00", "daily_end_time": "20:00", "time_zone": "America/Mexico_City" }, "duration": { "start_at": "2025-08-01T00:00:00Z", "end_at": "2026-08-01T00:00:00Z" } } }, "High-value transaction recovery via phone call": { "summary": "High-value transaction recovery via phone call", "value": { "name": "High Value Recovery - Phone", "account_id": "YOUR_ACCOUNT_ID", "organization_code": "YOUR_ORGANIZATION_CODE", "country": "CO", "channel": "PHONE_CALL", "focus": "payment_recovery", "schedule": { "daily_start_time": "09:00", "daily_end_time": "18:00", "time_zone": "America/Bogota" }, "duration": { "start_at": "2025-08-01T00:00:00Z", "end_at": "2026-08-01T00:00:00Z" } } } } } } }, "tags": [ "Communications Campaigns" ] } }, "/campaigns/{campaign_id}": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "name": { "type": "string", "example": "Declined Payment Recovery - Colombia" }, "account_id": { "type": "string", "example": "2404911d-5df9-429e-8488-ad41abea1a4b" }, "organization_code": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "country": { "type": "string", "example": "CO" }, "channel": { "type": "string", "example": "WHATSAPP_MESSAGE" }, "schedule": { "type": "object", "properties": { "daily_start_time": { "type": "string", "example": "08:00" }, "daily_end_time": { "type": "string", "example": "21:00" }, "time_zone": { "type": "string", "example": "America/Bogota" } } }, "duration": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2025-07-01T00:00:00Z" }, "end_at": { "type": "string", "example": "2026-07-01T00:00:00Z" } } }, "status": { "type": "string", "example": "ACTIVE" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "f1e2d3c4-b5a6-7890-abcd-ef1234567890" }, "rule_type": { "type": "string", "example": "PAYMENT_STATUS" }, "values": { "type": "array", "items": { "type": "string" }, "example": [ "DECLINED" ] }, "conditional": { "type": "string", "example": "EQUAL" }, "metadata_key": { "type": [ "string", "null" ], "example": null }, "status": { "type": "string", "example": "ACTIVE" }, "created_at": { "type": "string", "example": "2025-07-01T12:05:00Z" }, "updated_at": { "type": "string", "example": "2025-07-01T12:05:00Z" } } } }, "created_at": { "type": "string", "example": "2025-07-01T12:00:00Z" }, "updated_at": { "type": "string", "example": "2025-07-01T12:00:00Z" } } } } }, "examples": { "OK": { "summary": "OK", "value": { "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Declined Payment Recovery - Colombia", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "organization_code": "550e8400-e29b-41d4-a716-446655440000", "country": "CO", "channel": "WHATSAPP_MESSAGE", "schedule": { "daily_start_time": "08:00", "daily_end_time": "21:00", "time_zone": "America/Bogota" }, "duration": { "start_at": "2025-07-01T00:00:00Z", "end_at": "2026-07-01T00:00:00Z" }, "status": "ACTIVE", "rules": [ { "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890", "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL", "metadata_key": null, "status": "ACTIVE", "created_at": "2025-07-01T12:05:00Z", "updated_at": "2025-07-01T12:05:00Z" } ], "created_at": "2025-07-01T12:00:00Z", "updated_at": "2025-07-01T12:00:00Z" } } } } } }, "description": "OK" } }, "parameters": [ { "in": "path", "name": "campaign_id", "description": "The campaign identifier (UUID).", "schema": { "type": "string" }, "required": true } ], "operationId": "get_campaigns-campaign-id", "tags": [ "Communications Campaigns" ] }, "patch": { "description": "", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "name": { "type": "string", "example": "Declined Payment Recovery - Colombia" }, "status": { "type": "string", "example": "PAUSED" }, "updated_at": { "type": "string", "example": "2025-07-15T10:00:00Z" } } } } }, "examples": { "OK": { "summary": "OK", "value": { "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Declined Payment Recovery - Colombia", "status": "PAUSED", "updated_at": "2025-07-15T10:00:00Z" } } } } } }, "description": "" } }, "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string" }, "required": true, "description": "The campaign identifier (UUID)." } ], "operationId": "patch_campaigns-campaign-id", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "New status for the campaign.", "enum": [ "ACTIVE", "PAUSED", "COMPLETED", "CANCELLED" ] } }, "required": [ "status" ] }, "examples": { "Example": { "summary": "Example", "value": { "status": "PAUSED" } } } } } }, "tags": [ "Communications Campaigns" ] } }, "/campaigns/{campaign_id}/rules": { "post": { "description": "", "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "f1e2d3c4-b5a6-7890-abcd-ef1234567890" }, "rule_type": { "type": "string", "example": "PAYMENT_STATUS" }, "values": { "type": "array", "items": { "type": "string" }, "example": [ "DECLINED" ] }, "conditional": { "type": "string", "example": "EQUAL" }, "metadata_key": { "type": [ "string", "null" ], "example": null }, "status": { "type": "string", "example": "ACTIVE" }, "created_at": { "type": "string", "example": "2025-07-01T12:05:00Z" }, "updated_at": { "type": "string", "example": "2025-07-01T12:05:00Z" } } } } } }, "examples": { "Created": { "summary": "Created", "value": { "data": [ { "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890", "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL", "metadata_key": null, "status": "ACTIVE", "created_at": "2025-07-01T12:05:00Z", "updated_at": "2025-07-01T12:05:00Z" }, { "id": "a9b8c7d6-e5f4-3210-abcd-ef1234567890", "rule_type": "CURRENCY", "values": [ "COP" ], "conditional": "EQUAL", "metadata_key": null, "status": "ACTIVE", "created_at": "2025-07-01T12:05:00Z", "updated_at": "2025-07-01T12:05:00Z" }, { "id": "11223344-5566-7788-99aa-bbccddeeff00", "rule_type": "AMOUNT", "values": [ "50000" ], "conditional": "GREATER_THAN", "metadata_key": null, "status": "ACTIVE", "created_at": "2025-07-01T12:05:00Z", "updated_at": "2025-07-01T12:05:00Z" } ] } } } } }, "description": "Created" } }, "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string" }, "required": true, "description": "The campaign identifier (UUID)." } ], "operationId": "post_campaigns-campaign-id-rules", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "object", "properties": { "rule_type": { "type": "string", "description": "Type of rule (see [Rule Types Reference](/reference/communications-campaigns#rule-types-reference))" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Array of string values for comparison. Not required for `UNIQUE_BY_USER`." }, "conditional": { "type": "string", "description": "Comparison operator. Not required for `USER_COMMS_PER_DAY` or `UNIQUE_BY_USER`. See [Conditional Operators Reference](/reference/communications-campaigns#conditional-operators-reference)." }, "metadata_key": { "type": "string", "description": "Required when `rule_type` is `METADATA`. The metadata field name to evaluate." } }, "required": [ "rule_type" ] }, "description": "Array of rule objects" } }, "required": [ "rules" ] }, "examples": { "Basic declined payment recovery": { "summary": "Basic declined payment recovery", "value": { "rules": [ { "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL" }, { "rule_type": "PAYMENT_METHOD", "values": [ "CARD" ], "conditional": "EQUAL" } ] } }, "High-value transaction recovery via phone call": { "summary": "High-value transaction recovery via phone call", "value": { "rules": [ { "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL" }, { "rule_type": "AMOUNT_AND_CURRENCY", "values": [ "500", "USD" ], "conditional": "GREATER_THAN" }, { "rule_type": "USER_COMMS_PER_DAY", "values": [ "1" ] } ] } }, "Provider-specific recovery with amount range": { "summary": "Provider-specific recovery with amount range", "value": { "rules": [ { "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL" }, { "rule_type": "PROVIDER", "values": [ "stripe", "adyen" ], "conditional": "ONE_OF" }, { "rule_type": "AMOUNT", "values": [ "10000", "500000" ], "conditional": "BETWEEN" }, { "rule_type": "CURRENCY", "values": [ "COP" ], "conditional": "EQUAL" } ] } }, "Metadata-based segmentation": { "summary": "Metadata-based segmentation", "value": { "rules": [ { "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL" }, { "rule_type": "METADATA", "metadata_key": "vertical", "values": [ "restaurant", "grocery" ], "conditional": "ONE_OF" }, { "rule_type": "METADATA", "metadata_key": "customer_tier", "values": [ "premium", "gold" ], "conditional": "ONE_OF" }, { "rule_type": "UNIQUE_BY_USER" } ] } }, "Exclude specific response codes": { "summary": "Exclude specific response codes", "value": { "rules": [ { "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL" }, { "rule_type": "ISO_RESPONSE_CODE", "values": [ "14", "43", "59" ], "conditional": "NOT_ONE_OF" } ] } } } } } }, "tags": [ "Communications Campaigns" ] } }, "/campaigns/{campaign_id}/rules/{rule_id}": { "get": { "description": "", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "example": "f1e2d3c4-b5a6-7890-abcd-ef1234567890" }, "rule_type": { "type": "string", "example": "PAYMENT_STATUS" }, "values": { "type": "array", "items": { "type": "string" }, "example": [ "DECLINED" ] }, "conditional": { "type": "string", "example": "EQUAL" }, "metadata_key": { "type": [ "string", "null" ], "example": null }, "status": { "type": "string", "example": "ACTIVE" }, "created_at": { "type": "string", "example": "2025-07-01T12:05:00Z" }, "updated_at": { "type": "string", "example": "2025-07-01T12:05:00Z" } } } } }, "examples": { "Success": { "summary": "Success", "value": { "data": { "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890", "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL", "metadata_key": null, "status": "ACTIVE", "created_at": "2025-07-01T12:05:00Z", "updated_at": "2025-07-01T12:05:00Z" } } } } } }, "description": "" } }, "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string" }, "required": true, "description": "The campaign identifier (UUID)." }, { "in": "path", "name": "rule_id", "schema": { "type": "string" }, "required": true, "description": "The rule identifier (UUID)." } ], "operationId": "get_campaigns-campaign-id-rules-rule-id", "tags": [ "Communications Campaigns" ] }, "patch": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "data": { "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890", "rule_type": "PAYMENT_STATUS", "values": [ "DECLINED" ], "conditional": "EQUAL", "metadata_key": null, "status": "ACTIVE", "created_at": "2025-07-01T12:05:00Z", "updated_at": "2025-07-01T12:05:00Z" } } } } } } } }, "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string" }, "required": true, "description": "The campaign identifier (UUID)." }, { "in": "path", "name": "rule_id", "schema": { "type": "string" }, "required": true, "description": "The rule identifier (UUID)." } ], "operationId": "patch_campaigns-campaign-id-rules-rule-id", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rule_type": { "type": "string", "description": "New rule type (see [Rule Types Reference](/reference/communications-campaigns#rule-types-reference))" }, "values": { "type": "array", "items": { "type": "string" }, "description": "New values array. Not required for `UNIQUE_BY_USER`." }, "conditional": { "type": "string", "description": "New comparison operator. Not required for `USER_COMMS_PER_DAY` or `UNIQUE_BY_USER`. See [Conditional Operators Reference](/reference/communications-campaigns#conditional-operators-reference)." }, "metadata_key": { "type": "string", "description": "New metadata key. Required when `rule_type` is `METADATA`. The metadata field name to evaluate." } } }, "examples": { "Basic Example": { "summary": "Basic Example", "value": { "values": [ "DECLINED", "REJECTED" ], "conditional": "ONE_OF" } } } } } }, "tags": [ "Communications Campaigns" ] } }, "/campaigns/{campaign_id}/rules/{rule_id}/status": { "patch": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "status": "ACTIVE" } } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ACTIVE" } } } } } } }, "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string" }, "required": true, "description": "The campaign identifier (UUID)." }, { "in": "path", "name": "rule_id", "schema": { "type": "string" }, "required": true, "description": "The rule identifier (UUID)." } ], "operationId": "patch_campaigns-campaign-id-rules-rule-id-status", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "`ACTIVE` or `INACTIVE`" } }, "required": [ "status" ] }, "examples": { "Example": { "summary": "Example", "value": { "status": "INACTIVE" } } } } } }, "tags": [ "Communications Campaigns" ] } }, "/checkout/customers/sessions/{customer_session}/payment-methods": { "get": { "summary": "Retrieve Payment Methods To Enroll", "description": "", "operationId": "retrieve-payment-methods-to-enroll-checkout", "parameters": [ { "name": "customer_session", "in": "path", "description": "The customer session that has been created for the enrollment using the [Create Customer Session](https://docs.y.uno/reference/create-customer-session) endpoint (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "payment_methods": [ { "name": "Visa Credit Card", "description": "Visa Credit Card", "type": "VISA", "category": "CARD", "icon": "https://icons.prod.y.uno/visa_logosimbolo.png", "enrollment": { "session": "6641e30d-ca7a-440f-b97c-24231eac6dab", "sdk_required_action": false } }, { "name": "Mastercard Credit Card", "description": "Mastercard Credit Card", "type": "MASTERCARD", "category": "CARD", "icon": "https://icons.prod.y.uno/mastercard_logosimbolo.png", "enrollment": { "session": "6641e30d-ca7a-440f-b97c-24231eac6dab", "sdk_required_action": false } }, { "name": "PayPal Wallet", "description": "PayPal Wallet", "type": "PAYPAL", "category": "WALLET", "icon": "https://icons.prod.y.uno/paypal_logosimbolo.png", "enrollment": { "session": "6641e30d-ca7a-440f-b97c-24231eac6dab", "sdk_required_action": false } } ] } } }, "schema": { "type": "object", "properties": { "payment_methods": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Visa Credit Card" }, "description": { "type": "string", "example": "Visa Credit Card" }, "type": { "type": "string", "example": "VISA" }, "category": { "type": "string", "example": "CARD" }, "icon": { "type": "string", "example": "https://icons.prod.y.uno/visa_logosimbolo.png" }, "enrollment": { "type": "object", "properties": { "session": { "type": "string", "example": "6641e30d-ca7a-440f-b97c-24231eac6dab" }, "sdk_required_action": { "type": "boolean", "example": false, "default": true } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Checkout" ] } }, "/checkout/sessions": { "post": { "summary": "Create Checkout Session", "description": "", "operationId": "create-checkout-session", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchant_order_id", "payment_description", "country", "account_id" ], "properties": { "customer_id": { "type": "string", "description": "The unique identifier of the customer, created using the [Create Customer](https://docs.y.uno/reference/create-customer) endpoint (UUID, 36 chars)." }, "merchant_order_id": { "type": "string", "description": "The unique identifier of the customer's order (MAX 255; MIN 3)." }, "payment_description": { "type": "string", "description": "The description of the payment (MAX 255; MIN 3)." }, "callback_url": { "type": "string", "description": "The URL where we will redirect your customer after making the purchase. Required for alternative payment methods with redirection. (MAX 526; MIN 3)" }, "country": { "type": "string", "description": "The customer's country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on [the Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars)." }, "amount": { "type": "object", "description": "Specifies the payment amount object, with the value and currency.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "description": "The payment amount (multiple of 0.0001).", "format": "float" } } }, "alternative_amount": { "type": "object", "description": "Alternative currency representation of the transaction amount.", "required": [ "currency", "value" ], "properties": { "currency": { "type": [ "string", "null" ], "description": "The alternative currency code. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "description": "The alternative amount value (multiple of 0.0001).", "format": "float" } } }, "metadata": { "type": "array", "description": "Specifies a list of metadata objects. You can add up to 120 metadata objects.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48)" }, "value": { "type": "string", "description": "The metadata key value (MAX 512)" } }, "required": [ "key", "value" ], "type": "object" } }, "workflow": { "type": "string", "description": "Checkout workflow type.", "enum": [ "SDK_CHECKOUT", "CHECKOUT", "SDK_SEAMLESS" ] }, "installments": { "type": "object", "description": "The object to send the installment plan created in Yuno to show your customers and let them choose from. This optional field is used in case a particular installments plan needs to be used in the session. if not sent, we will display the installment plan created for the account for each scenario, if any.", "properties": { "plan_id": { "type": "string", "description": "Plan Id of the installment plan created in Yuno" }, "plan": { "type": "array", "description": "Installments to show the customer in with the checkout_session. This optional struct is used in case a particular installments plan needs to be used in the session and does not have an installments plan created for it. if not sent, we will display the installment plan created for the account for each scenario, if any.", "items": { "properties": { "installment": { "type": "integer", "description": "The number of monthly installments shoppers can choose", "format": "int32" }, "rate": { "type": "number", "description": "The rate applied to the final amount of the transaction by the payment provider after using installments. The value should be entered as a multiplier, not a percentage. For example, to apply a 20% rate, enter `1.20` instead of `20`.", "format": "float" } }, "required": [ "installment", "rate" ], "type": "object" } } } }, "recurring_payment": { "type": "object", "description": "Optional object to enable and configure recurring payments (subscriptions).", "properties": { "description": { "type": "string", "description": "Description of the subscription plan." }, "management_url": { "type": "string", "description": "URL where the user can manage their subscription." }, "billing_agreement": { "type": "string", "description": "Billing agreement identifier." }, "regular_billing": { "type": "object", "description": "Configuration for the recurring billing cycle.", "required": [ "label", "amount", "interval_unit", "interval_count" ], "properties": { "label": { "type": "string", "description": "Descriptive label for the billing cycle (e.g. \"Monthly\")." }, "amount": { "type": "string", "description": "Billing amount (e.g. \"9.99\")." }, "interval_unit": { "type": "string", "description": "Unit of the billing interval.", "enum": [ "year", "month", "day", "hour", "minute" ] }, "interval_count": { "type": "integer", "description": "Number of units between each billing cycle." } } }, "trial_billing": { "type": "object", "description": "(Optional) Trial period configuration.", "required": [ "label", "amount", "interval_unit", "interval_count" ], "properties": { "label": { "type": "string", "description": "Descriptive label for the trial billing cycle (e.g. \"Free trial\")." }, "amount": { "type": "string", "description": "Billing amount for trial (e.g. \"0.00\")." }, "interval_unit": { "type": "string", "description": "Unit of the trial billing interval.", "enum": [ "year", "month", "day", "hour", "minute" ] }, "interval_count": { "type": "integer", "description": "Number of units for the trial period." } } } } }, "checkout_id": { "type": "string", "description": "The unique identifier (UUID) of the Custom Checkout to use for this session. Optional. When omitted, the session uses the account's default checkout." } } }, "examples": { "Checkout Session (full data)": { "value": { "account_id": "{{account_id}}", "merchant_order_id": "1717681150", "payment_description": "Test Cards", "country": "CO", "customer_id": "{{customer_id}}", "callback_url": "https://www.example.com", "amount": { "currency": "COP", "value": 8000 }, "alternative_amount": { "currency": "USD", "value": 2 }, "metadata": [ { "key": "ID", "value": "123456" } ], "recurring_payment": { "description": "Monthly subscription", "management_url": "https://example.com/manage", "billing_agreement": "BA-123", "regular_billing": { "label": "Monthly", "amount": "9.99", "interval_unit": "month", "interval_count": 1 }, "trial_billing": { "label": "Free trial", "amount": "0.00", "interval_unit": "month", "interval_count": 1 } }, "checkout_id": "6822f80c-684e-41a3-8628-78963d3d60f7" } }, "Checkout Session (min data)": { "value": { "country": "US", "amount": { "currency": "USD", "value": 100 }, "alternative_amount": { "currency": "ARS", "value": "140000" }, "account_id": "{{account_id}}", "merchant_order_id": "1717681150", "payment_description": "Test Cards", "customer_id": "{{customer_id}}" } }, "Checkout Session (alternative currency omitted)": { "value": { "account_id": "{{account_id}}", "merchant_order_id": "1717681150", "payment_description": "Test Cards", "country": "CO", "customer_id": "{{customer_id}}", "amount": { "currency": "COP", "value": 8000 } }, "summary": "Checkout Session (alternative currency omitted)" } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Checkout Session (min. data)": { "value": { "merchant_order_id": "1717681150", "checkout_session": "d313047b-4f96-44ef-bbad-caf1d7ba4c2b", "country": "US", "payment_description": "Test Cards", "customer_id": "a577ad8f-08f1-4590-9cf1-e7679b15ee84", "callback_url": "https://www.example.com/callback", "amount": { "currency": "USD", "value": 520 }, "created_at": "2024-06-06T13:39:10.932297Z", "metadata": null, "workflow": "SDK_CHECKOUT", "installments": { "plan_id": null, "plan": null }, "checkout_id": "6822f80c-684e-41a3-8628-78963d3d60f7" } }, "Checkout Session (full data)": { "value": { "merchant_order_id": "1717681150", "checkout_session": "c437f4cc-7d66-40e6-a8df-7c3cde1ddca7", "country": "US", "payment_description": "Test Cards", "customer_id": "55006822-7c79-490b-bea1-81798b9afc74", "callback_url": "https://www.example.com/?checkoutSession=c437f4cc-7d66-40e6-a8df-7c3cde1ddca7", "amount": { "currency": "USD", "value": 520 }, "created_at": "2023-07-20T17:06:17.232130Z", "metadata": [ { "key": "ID", "value": "123456" } ], "workflow": "SDK_CHECKOUT", "installments": { "plan_id": null, "plan": null }, "checkout_id": "6822f80c-684e-41a3-8628-78963d3d60f7" } } }, "schema": { "oneOf": [ { "title": "Checkout Session (min. data)", "type": "object", "properties": { "merchant_order_id": { "type": "string", "example": "1717681150" }, "checkout_session": { "type": "string", "example": "d313047b-4f96-44ef-bbad-caf1d7ba4c2b" }, "country": { "type": "string", "example": "US" }, "payment_description": { "type": "string", "example": "Test Cards" }, "customer_id": { "type": "string", "example": "a577ad8f-08f1-4590-9cf1-e7679b15ee84" }, "callback_url": { "type": "string", "example": "https://www.example.com/callback" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 520, "default": 0 } } }, "created_at": { "type": "string", "example": "2024-06-06T13:39:10.932297Z" }, "metadata": {}, "workflow": { "type": "string", "example": "SDK_CHECKOUT" }, "installments": { "type": "object", "properties": { "plan_id": {}, "plan": {} } }, "checkout_id": { "type": "string", "example": "6822f80c-684e-41a3-8628-78963d3d60f7" } } }, { "title": "Checkout Session (full data)", "type": "object", "properties": { "merchant_order_id": { "type": "string", "example": "1717681150" }, "checkout_session": { "type": "string", "example": "c437f4cc-7d66-40e6-a8df-7c3cde1ddca7" }, "country": { "type": "string", "example": "US" }, "payment_description": { "type": "string", "example": "Test Cards" }, "customer_id": { "type": "string", "example": "55006822-7c79-490b-bea1-81798b9afc74" }, "callback_url": { "type": "string", "example": "https://www.example.com/?checkoutSession=c437f4cc-7d66-40e6-a8df-7c3cde1ddca7" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 520, "default": 0 } } }, "created_at": { "type": "string", "example": "2023-07-20T17:06:17.232130Z" }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "ID" }, "value": { "type": "string", "example": "123456" } } } }, "workflow": { "type": "string", "example": "SDK_CHECKOUT" }, "installments": { "type": "object", "properties": { "plan_id": {}, "plan": {} } }, "checkout_id": { "type": "string", "example": "6822f80c-684e-41a3-8628-78963d3d60f7" } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Checkout Sessions" ] } }, "/checkout/sessions/{checkout_session}": { "get": { "summary": "Retrieve Checkout Session", "operationId": "get-checkout-session", "parameters": [ { "name": "checkout_session", "in": "path", "description": "The unique identifier of the checkout session (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "02caeb08-45c0-4670-9736-5bdee1b311f8", "merchant_order_id": "1752072398", "country": "AR", "payment_description": "Test Cards", "customer_id": "e937e18e-a684-4d7b-a1a1-ab64c10a941d", "callback_url": "https://google.com/?checkoutSession=02caeb08-45c0-4670-9736-5bdee1b311f8", "amount": { "currency": "ARS", "value": 520 }, "created_at": "2025-07-09T14:46:39.515251Z", "metadata": null, "workflow": "SDK_CHECKOUT", "installments": { "plan_id": null, "plan": null }, "used": true, "checkout_id": "6822f80c-684e-41a3-8628-78963d3d60f7" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the checkout session (MAX 64; MIN 36).", "example": "02caeb08-45c0-4670-9736-5bdee1b311f8" }, "merchant_order_id": { "type": "string", "description": "The unique identifier of the customer's order (MAX 255; MIN 3).", "example": "1752072398" }, "country": { "type": "string", "description": "Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1).", "example": "AR" }, "payment_description": { "type": "string", "description": "The description of the payment (MAX 255; MIN 3).", "example": "Test Cards" }, "customer_id": { "type": "string", "description": "The unique identifier of the customer (MAX 64; MIN 36).", "example": "e937e18e-a684-4d7b-a1a1-ab64c10a941d" }, "callback_url": { "type": "string", "description": "The URL where to redirect the customer after the payment (MAX 526; MIN 3).", "example": "https://google.com/?checkoutSession=02caeb08-45c0-4670-9736-5bdee1b311f8" }, "amount": { "type": "object", "description": "Specifies the payment amount object, with the value and currency.", "properties": { "currency": { "type": "string", "description": "The currency used to make the payment (MAX 3; MIN 3; ISO 4217).", "example": "ARS" }, "value": { "type": "number", "description": "The payment amount (multiple of 0.0001).", "example": 520 } } }, "created_at": { "type": "string", "description": "Checkout Session creation date and time (MAX 27; MIN 27; ISO 8601).", "example": "2025-07-09T14:46:39.515251Z" }, "metadata": { "type": [ "array", "null" ], "description": "Specifies a list of metadata objects. You can add up to 50 metadata objects.", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Specifies one metadata key.", "example": "age" }, "value": { "type": "string", "description": "Specifies the value for the defined metadata key.", "example": "28" } } } }, "workflow": { "type": "string", "description": "The payment workflow type that specifies how the checkout session will be processed.", "example": "SDK_CHECKOUT" }, "installments": { "type": "object", "description": "The object to send the installment plan created in Yuno to show your customers and let them choose from.", "properties": { "plan_id": { "type": [ "string", "null" ], "description": "Specifies a plan id created in Yuno to show your customer in the checkout session (MAX 64; MIN 64)." }, "plan": { "type": [ "array", "null" ], "description": "Installments to show the customer with the checkout session.", "items": { "type": "object", "properties": { "installment": { "type": "integer", "description": "The number of monthly installments shoppers can choose.", "example": 3 }, "rate": { "type": "number", "description": "The rate that will be applied to the final amount of the transaction by the payment provider after using installments.", "example": 1.5 } } } } } }, "used": { "type": "boolean", "description": "Specifies whether a checkout session was used previously or not.", "example": true }, "checkout_id": { "type": "string", "example": "6822f80c-684e-41a3-8628-78963d3d60f7" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Checkout Sessions" ] }, "patch": { "summary": "Copy of Create Checkout Session", "description": "", "operationId": "post_checkoutsessions-1", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchant_order_id", "payment_description", "country", "account_id" ], "properties": { "customer_id": { "type": "string", "description": "The unique identifier of the customer, created using the [Create Customer](https://docs.y.uno/reference/create-customer) endpoint (UUID, 36 chars)." }, "merchant_order_id": { "type": "string", "description": "The unique identifier of the customer's order (MAX 255; MIN 3)." }, "payment_description": { "type": "string", "description": "The description of the payment (MAX 255; MIN 3)." }, "callback_url": { "type": "string", "description": "The URL where we will redirect your customer after making the purchase. Required for alternative payment methods with redirection. (MAX 526; MIN 3)" }, "country": { "type": "string", "description": "The customer's country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on [the Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars).", "default": "{{account_id}}" }, "amount": { "type": "object", "description": "Specifies the payment amount object, with the value and currency.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "description": "The payment amount (multiple of 0.0001).", "format": "float" } } }, "alternative_amount": { "type": "object", "description": "Alternative currency representation of the transaction amount.", "required": [ "currency", "value" ], "properties": { "currency": { "type": [ "string", "null" ], "description": "The alternative currency code. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "description": "The alternative amount value (multiple of 0.0001).", "format": "float" } } }, "metadata": { "type": "array", "description": "Specifies a list of metadata objects. You can add up to 120 metadata objects.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48)" }, "value": { "type": "string", "description": "The metadata key value (MAX 512)" } }, "required": [ "key", "value" ], "type": "object" } }, "workflow": { "type": "string", "description": "Checkout workflow type.", "enum": [ "SDK_CHECKOUT", "CHECKOUT", "SDK_SEAMLESS" ] }, "installments": { "type": "object", "description": "The object to send the installment plan created in Yuno to show your customers and let them choose from. This optional field is used in case a particular installments plan needs to be used in the session. if not sent, we will display the installment plan created for the account for each scenario, if any.", "properties": { "plan_id": { "type": "string", "description": "Plan Id of the installment plan created in Yuno" }, "plan": { "type": "array", "description": "Installments to show the customer in with the checkout_session. This optional struct is used in case a particular installments plan needs to be used in the session and does not have an installments plan created for it. if not sent, we will display the installment plan created for the account for each scenario, if any.", "items": { "properties": { "installment": { "type": "integer", "description": "The number of monthly installments shoppers can choose", "format": "int32" }, "rate": { "type": "number", "description": "The rate applied to the final amount of the transaction by the payment provider after using installments. The value should be entered as a multiplier, not a percentage. For example, to apply a 20% rate, enter `1.20` instead of `20`.", "format": "float" } }, "required": [ "installment", "rate" ], "type": "object" } } } } } }, "examples": { "Update checkout session": { "value": { "country": "BR", "amount": { "currency": "ARS" }, "alternative_amount": { "currency": "ARS" }, "merchant_order_id": "007", "payment_description": "Payment Test", "account_id": "{{account_id}}" }, "summary": "Update checkout session" } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success": { "value": { "merchant_order_id": "007", "checkout_session": "c67ce158-6053-4661-a1de-aed5c945b935", "country": "BR", "payment_description": "Payment Test", "callback_url": null, "amount": { "currency": "ARS", "value": 100 }, "created_at": "2025-11-14T00:43:22.719648Z", "metadata": null, "workflow": "SDK_CHECKOUT", "installments": { "plan_id": null, "plan": null }, "used": false }, "summary": "Success" } }, "schema": { "type": "object", "properties": { "merchant_order_id": { "type": "string", "example": "007" }, "checkout_session": { "type": "string", "example": "c67ce158-6053-4661-a1de-aed5c945b935" }, "country": { "type": "string", "example": "BR" }, "payment_description": { "type": "string", "example": "Payment Test" }, "callback_url": {}, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "ARS" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "created_at": { "type": "string", "example": "2025-11-14T00:43:22.719648Z" }, "metadata": {}, "workflow": { "type": "string", "example": "SDK_CHECKOUT" }, "installments": { "type": "object", "properties": { "plan_id": {}, "plan": {} } }, "used": { "type": "boolean", "example": false, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "parameters": [ { "in": "path", "name": "checkout_session", "schema": { "type": "string" }, "required": true } ], "tags": [ "Checkout Sessions" ] } }, "/checkout/sessions/{checkout_session}/payment-methods": { "get": { "summary": "Retrieve Payment Methods for Checkout", "description": "", "operationId": "retrieve-payment-methods-for-checkout", "parameters": [ { "name": "checkout_session", "in": "path", "description": "The unique identifier of the checkout session (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "category", "in": "query", "description": "Optional category filter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": [ { "name": "VISA ****1111", "vaulted_token": "de00c1bd-624b-4e7b-ae28-47d86c94b15f", "description": "VISA ****1111", "type": "CARD", "category": "CARD", "icon": "https://icons.prod.y.uno/visa_logosimbolo.png", "last_successfully_used": false, "last_successfully_used_at": "", "checkout": { "session": "d313047b-4f96-44ef-bbad-caf1d7ba4c2b", "sdk_required_action": false, "conditions": { "enabled": true, "rules": null } }, "card_data": { "iin": "41111111", "lfd": "1111", "expiration_month": 3, "expiration_year": 26, "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer": "JPMORGAN CHASE BANK N A", "issuer_code": null, "category": "CREDIT", "type": "CREDIT" }, "preferred": false }, { "name": "Card", "vaulted_token": null, "description": "Card", "type": "CARD", "category": "CARD", "icon": "https://icons.prod.y.uno/card_logosimbolo.png", "last_successfully_used": null, "last_successfully_used_at": null, "checkout": { "session": "d313047b-4f96-44ef-bbad-caf1d7ba4c2b", "sdk_required_action": true, "conditions": { "enabled": true, "rules": null } }, "preferred": false }, { "name": "Bank Transfer", "vaulted_token": null, "description": "Bank Transfer", "type": "BANK_TRANSFER", "category": "BANK_TRANSFER", "icon": "https://icons.prod.y.uno/banktransfer_logosimbolo.png", "last_successfully_used": null, "last_successfully_used_at": null, "checkout": { "session": "d313047b-4f96-44ef-bbad-caf1d7ba4c2b", "sdk_required_action": true, "conditions": { "enabled": false, "rules": [ { "condition": "INCLUDE", "condition_group_code": "2b273309-2c63-4ef8-b5f8-2953abf7ad4a", "condition_name": "Country-US", "type": "COUNTRY", "values": { "countries": [ "US" ], "currency": null, "max": null, "metadata": null, "min": null } } ] } }, "preferred": false } ] } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "VISA ****1111" }, "vaulted_token": { "type": "string", "example": "de00c1bd-624b-4e7b-ae28-47d86c94b15f" }, "description": { "type": "string", "example": "VISA ****1111" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "icon": { "type": "string", "example": "https://icons.prod.y.uno/visa_logosimbolo.png" }, "last_successfully_used": { "type": "boolean", "example": false, "default": true }, "last_successfully_used_at": { "type": "string", "example": "" }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "d313047b-4f96-44ef-bbad-caf1d7ba4c2b" }, "sdk_required_action": { "type": "boolean", "example": false, "default": true }, "conditions": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "default": true }, "rules": { "type": "array", "description": "List of condition rules (INCLUDE/EXCLUDE) applied to the payment method. Each rule has a type (e.g. METADATA, AMOUNT, COUNTRY) and values.", "items": { "type": "object", "properties": { "condition": { "type": "string", "description": "INCLUDE or EXCLUDE", "example": "INCLUDE" }, "condition_group_code": { "type": "string", "description": "UUID of the condition group", "example": "2b273309-2c63-4ef8-b5f8-2953abf7ad4a" }, "condition_name": { "type": "string", "description": "Human-readable name of the condition", "example": "Country-US" }, "type": { "type": "string", "description": "Rule type: METADATA, AMOUNT, COUNTRY, etc.", "example": "COUNTRY" }, "values": { "type": "object", "description": "Values used by the rule. Structure depends on rule type: `currency`, `max`, and `min` are strings (nullable); `countries` is an array of strings (e.g. [\"AF\"]); `metadata` is an array of objects with `key` and `value` (e.g. [{\"key\": \"test\", \"value\": \"test\"}]).", "properties": { "countries": { "type": [ "array", "null" ], "description": "Array of country codes (e.g. [\"AF\"], [\"US\"]). Null when not used by the rule.", "items": { "type": "string" }, "example": [ "AF" ] }, "currency": { "type": [ "string", "null" ], "description": "Currency code when rule type is AMOUNT. Null otherwise.", "example": null }, "max": { "type": [ "string", "null" ], "description": "Maximum value when applicable. Null otherwise.", "example": null }, "metadata": { "type": [ "array", "null" ], "description": "Array of key-value objects (e.g. [{\"key\": \"test\", \"value\": \"test\"}]). Null when not used by the rule.", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "min": { "type": [ "string", "null" ], "description": "Minimum value when applicable. Null otherwise.", "example": null } } } } } } } } } }, "card_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" } } }, "preferred": { "type": "boolean", "example": false, "default": true } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Checkout Sessions" ] } }, "/checkouts": { "get": { "summary": "List Checkouts", "description": "Lists the account's custom checkouts as summaries (no configuration or styling), sorted default-first and then most recently updated. Includes ARCHIVED checkouts. All filters are optional and combinable (ANDed). Without page or size the response is a bare array with every matching checkout; sending either switches to a paginated envelope.", "operationId": "list-checkouts", "parameters": [ { "name": "name", "in": "query", "description": "Case-insensitive contains filter on the checkout name. LIKE metacharacters (% and _) match literally.", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "description": "Case-insensitive contains filter on the checkout identifier.", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "description": "Filter by status. Accepts one or several values (ORed): repeat the parameter or send a comma-separated list (status=PUBLISHED,ARCHIVED). Invalid values are rejected with 400. Absent: all statuses.", "schema": { "type": "string", "enum": [ "PUBLISHED", "NOT_PUBLISHED", "ARCHIVED" ] }, "required": false }, { "name": "created_after", "in": "query", "description": "Inclusive lower bound on created_at (ISO-8601 instant, e.g. 2026-05-01T00:00:00Z).", "schema": { "type": "string", "format": "date-time" }, "required": false }, { "name": "created_before", "in": "query", "description": "Inclusive upper bound on created_at (ISO-8601 instant).", "schema": { "type": "string", "format": "date-time" }, "required": false }, { "name": "updated_after", "in": "query", "description": "Inclusive lower bound on updated_at (ISO-8601 instant).", "schema": { "type": "string", "format": "date-time" }, "required": false }, { "name": "updated_before", "in": "query", "description": "Inclusive upper bound on updated_at (ISO-8601 instant).", "schema": { "type": "string", "format": "date-time" }, "required": false }, { "name": "page", "in": "query", "description": "Page number (1-based). Opt-in pagination: sending page or size switches the response to the paginated envelope. Default 1. Non-numeric values are rejected with 400.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "required": false }, { "name": "size", "in": "query", "description": "Page size. Opt-in pagination: sending page or size switches the response to the paginated envelope. Default 25, capped at 100. Non-numeric values are rejected with 400.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 }, "required": false } ], "responses": { "200": { "description": "The account's checkouts. A bare array when page and size are absent; a paginated envelope (data + pagination) when either is present. Items carry the same 7 fields in both shapes. pagination.total is the full filtered count, not the page's row count.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CheckoutSummary" }, "description": "Bare array of every matching checkout (page and size absent).", "title": "Without pagination" }, { "type": "object", "description": "Paginated envelope (page or size present).", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CheckoutSummary" } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page (1-based)." }, "size": { "type": "integer", "description": "Page size." }, "total": { "type": "integer", "description": "Full filtered count, not the page's row count." } } } }, "title": "With pagination" } ] }, "examples": { "Without pagination": { "value": [ { "id": "2a8d6472-3117-4e85-8b28-d51ba3abab77", "name": "Default", "description": "Default", "status": "PUBLISHED", "is_default": true, "created_at": "2026-05-02T18:11:04.120Z", "updated_at": "2026-07-01T09:30:12.001Z" }, { "id": "0b28ff66-15f1-44c1-8d1e-bd1fefbc0a19", "name": "Promo Checkout", "description": "Seasonal promo", "status": "ARCHIVED", "is_default": false, "created_at": "2026-04-11T10:02:33.000Z", "updated_at": "2026-06-20T15:45:00.000Z" } ] }, "With pagination": { "value": { "data": [ { "id": "2a8d6472-3117-4e85-8b28-d51ba3abab77", "name": "Default", "description": "Default", "status": "PUBLISHED", "is_default": true, "created_at": "2026-05-02T18:11:04.120Z", "updated_at": "2026-07-01T09:30:12.001Z" } ], "pagination": { "page": 1, "size": 25, "total": 3 } } } } } } }, "400": { "description": "Invalid page/size values or an invalid status value.", "content": { "application/json": { "examples": { "Invalid pagination": { "value": { "code": "ILLEGAL_ARGUMENT", "messages": [ "page must be a positive integer" ] } } } } } }, "401": { "description": "Missing or invalid credentials, or the account is not in the beta allowlist." } }, "tags": [ "Checkout Builder" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "AccountCode": [] } ] }, "post": { "summary": "Create Checkout", "description": "Creates a new custom checkout as a published clone of the account's default checkout: payment methods (including icon/name overrides and required-field condition sets) are copied from the default; general settings and styling inherit the account baseline until the checkout's first publish. The new checkout is born with status PUBLISHED and is never the account's default. The identifier is exposed as the top-level `id`.", "operationId": "create-checkout", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "description": "Optional client key, up to 64 characters. Best-effort; re-sending the same key is not guaranteed to be de-duplicated.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Checkout name. Required, non-blank, and unique per account (a duplicate name is rejected with 409)." }, "description": { "type": "string", "description": "Optional free-text description." } } }, "examples": { "Name only": { "value": { "name": "Promo Checkout" } }, "Name and description": { "value": { "name": "Promo Checkout", "description": "Seasonal promo storefront" } } } } } }, "responses": { "201": { "description": "The created checkout. Born PUBLISHED as a clone of the account's default; `is_default` is always false on creation. Use `id` as the checkout_code in the other Checkout Builder endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutMutationResponse" }, "examples": { "Created": { "value": { "id": "0b28ff66-15f1-44c1-8d1e-bd1fefbc0a19", "name": "Promo Checkout", "description": "Seasonal promo storefront", "is_default": false, "is_active": true, "created_at": "2026-07-17T10:02:33.000Z" } } } } } }, "400": { "description": "Missing or blank `name`, or a malformed JSON body.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing name": { "value": { "code": "INVALID_PARAMETERS", "messages": [ "name is required" ] } } } } } }, "401": { "description": "Not authenticated, or the account is not in the beta allowlist.", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Not authenticated" ] } } } } } }, "404": { "description": "The account has no default checkout to clone from.", "content": { "application/json": { "examples": { "No default checkout": { "value": { "code": "DEFAULT_CHECKOUT_NOT_FOUND", "messages": [ "No default Custom Checkout found for account: 78163a7c-c63c-4fdd-b72b-d5f77093a927" ] } } } } } }, "409": { "description": "A checkout with the same name already exists for the account.", "content": { "application/json": { "examples": { "Duplicate name": { "value": { "code": "DUPLICATE_CHECKOUT_NAME", "messages": [ "A Custom Checkout with name 'Promo Checkout' already exists for this account" ] } } } } } } }, "tags": [ "Checkout Builder" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "AccountCode": [] } ] } }, "/checkouts/{checkout_code}": { "get": { "summary": "Fetch Checkout Configuration", "description": "Returns the full custom checkout for the given code: configuration and styling composed in a single response. The checkout identifier is exposed as the top-level `id`.", "operationId": "get-checkout-configuration", "parameters": [ { "name": "checkout_code", "in": "path", "description": "The unique identifier of the checkout to retrieve (UUID, 36 chars). Non-UUID values are rejected with 400 before processing.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "The custom checkout, with configuration and styling composed.", "content": { "application/json": { "examples": { "Success": { "value": { "id": "8005ca91-dcfb-4428-b9f6-49c6e3446474", "name": "Main Checkout", "description": "", "status": "PUBLISHED", "is_default": true, "created_at": "2026-01-01T00:00:00Z", "updated_at": "2026-05-18T13:06:08Z", "config": { "payment_methods": [ { "payment_method_type": "CARD", "name": "Card", "description": "Card", "icon": "https://sdk.prod.y.uno/brands/card_logosimbolo.png", "category": "CARD", "short_name": "Card", "hint": "", "order_to_show": 1, "is_active": true, "type": "PAYMENT_METHOD", "has_enrollment": true, "conditions_quantity": 1, "active_enrollment_type": "BOTH" } ], "general_settings": { "country_documents": [ { "country_code": "AR", "documents": [ "DNI", "CUIT" ] } ] }, "feature_flags": { "custom_required_fields": true, "custom_logo_icon": true } }, "styling": { "styles": { "global": { "accent_color": "#282A30", "primary_background_color": "#FFFFFF", "primary_text_color": "#282A30", "primary_button_text_color": "#FFFFFF", "secondary_background_color": "#ECEFF2", "secondary_text_color": "#84807F", "secondary_button_background_color": "#FFFFFF", "secondary_button_text_color": "#282A30", "font_family": "Inter" }, "header": { "logo_border_size": 0, "logo_border_color": "#282A30", "logo_corner_radius": 8, "font_size": 18, "font_weight": 700 }, "button": { "corner_radius": 8, "border_size": 0, "primary_border_color": "#282A30", "secondary_border_color": "#282A30", "font_size": 18, "font_weight": 400 } }, "settings": { "sdk_type": { "web": "SEAMLESS", "mobile": "SEAMLESS" }, "card": { "save_on_success": true, "visualization_mode": "ONE_STEP", "enable_ocr": false, "credit_card_only_processing": false, "default_network": "DOM" }, "web_sdk": { "render_mode": "MODAL", "hide_pay_button": false }, "payment_method_list": { "unfolded_display": false, "preselected_payment_method": false, "condensed_checkout_view": false, "edit_payment_method_list": false }, "ui": { "dark_mode": false, "show_secure_payment_tag": true }, "payment_link": { "show_result_screen": false } }, "external_fonts": [ { "family_name": "Inter", "files": [ { "weight": 400, "url": "https://staging.y.uno/sdk-static-bundles-ms/v1/static/fonts/Inter-Regular.ttf" } ] } ], "payment_link_styles": { "panel": { "left": { "background": { "color": "#ECEFF2" }, "logo": "data:image/jpeg;base64,..." } }, "checkbox": { "color": "#282A30" }, "border": { "color": "#282A30" }, "radio_button": { "color": "#282A30" }, "button": { "text": { "color": "#876E6E" }, "background": { "color": "#282A30" } }, "published_at": "2026-05-14T19:34:06Z" } } } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Checkout UUID (the checkout_code).", "example": "8005ca91-dcfb-4428-b9f6-49c6e3446474" }, "name": { "type": "string", "description": "Checkout name.", "example": "Main Checkout" }, "description": { "type": "string", "description": "Checkout description." }, "status": { "type": "string", "description": "Checkout status.", "example": "PUBLISHED" }, "is_default": { "type": "boolean", "description": "Whether this is the account's default checkout.", "example": true }, "created_at": { "type": "string", "description": "Creation timestamp (ISO 8601)." }, "updated_at": { "type": "string", "description": "Last updated timestamp (ISO 8601)." }, "config": { "type": "object", "description": "Checkout configuration.", "properties": { "payment_methods": { "type": "array", "description": "Payment methods configured for this checkout. Order is driven by `order_to_show` (lower = first). Returns the full payment-method catalog available to the account, not only the ones active for this checkout. Filter by `is_active: true` to get only the enabled ones.", "items": { "type": "object" } }, "general_settings": { "type": "object", "description": "General checkout settings, including accepted document types per country (`country_documents`)." }, "feature_flags": { "type": "object", "description": "Feature toggles for this checkout, including `custom_required_fields` and `custom_logo_icon`." } } }, "styling": { "type": "object", "description": "Checkout styling and SDK settings: `styles`, `settings`, `external_fonts`, `payment_link_styles`." } } } } } }, "400": { "description": "`checkout_code` is not a valid UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_PARAMETERS" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } }, "401": { "description": "Not authenticated, or the account is not in the beta allowlist.", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Not authenticated" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "NOT_AUTHENTICATED" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } }, "404": { "description": "The checkout was not found for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } } }, "deprecated": false, "tags": [ "Checkout Builder" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "AccountCode": [] } ] }, "put": { "summary": "Publish Checkout Configuration", "description": "Writes configuration and/or styling for the checkout in a single call. The body may contain a `config` object, a `styling` object, or both; at least one is required. Each part is validated independently before being applied; if any rule fails, the request is rejected with a single aggregated 400 and nothing is applied. Configuration is a sparse upsert (omitted payment methods keep their previous state; new methods cannot be created). Styling is a partial merge (omitted or null fields are preserved).", "operationId": "publish-checkout-configuration", "parameters": [ { "name": "checkout_code", "in": "path", "description": "The unique identifier of the checkout to update (UUID, 36 chars). Non-UUID values are rejected with 400 before processing.", "schema": { "type": "string" }, "required": true }, { "name": "X-Idempotency-Key", "in": "header", "description": "Client-generated UUID. Re-sending the same request with the same key is safe and will not double-publish.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "examples": { "Configuration and styling": { "value": { "config": { "payment_methods": [ { "payment_method_type": "CARD", "order_to_show": 0, "is_active": true, "active_enrollment_type": "BOTH", "conditions_to_override": [], "required_fields_to_override": { "is_active": true, "fields": [ { "field_name": "security_code", "is_active": true, "current_value": "ALWAYS", "conditions_to_override": [ { "name": "BR only", "is_active": true, "priority": 1, "conditions": [ { "condition_type": "COUNTRY", "conditional": "ONE_OF", "values": [ "BR" ] } ] } ] } ], "enrollment_fields": [], "is_enrollment_active": true } } ], "general_settings": { "country_documents": [ { "country_code": "BR", "documents": [ "CPF", "CNPJ" ] } ] } }, "styling": { "styles": { "global": { "accent_color": "#1A73E8", "primary_background_color": "#FFFFFF", "font_family": "Inter" }, "header": { "logo": "https://cdn.example.com/logo.png", "font_weight": 600 }, "button": { "corner_radius": 8, "font_weight": 500 } }, "flags": { "force_default_styles": false } } } } }, "schema": { "type": "object", "description": "At least one of `config` or `styling` is required.", "properties": { "config": { "type": "object", "description": "Checkout configuration: payment methods and general settings. Sparse upsert; omitted payment methods keep their previous state.", "properties": { "payment_methods": { "type": "array", "description": "Payment methods to update. Order is driven by `order_to_show` (lower = first).", "items": { "type": "object", "properties": { "payment_method_type": { "type": "string", "description": "Payment method type, e.g. CARD, PAYPAL, NU_PAY, GOOGLE_PAY.", "example": "CARD" }, "order_to_show": { "type": "integer", "description": "Display order (>= 0). Lower is shown first.", "example": 0 }, "is_active": { "type": "boolean", "description": "Whether the method is offered.", "example": true }, "active_enrollment_type": { "type": "string", "enum": [ "ENROLLMENT", "NO_ENROLLMENT", "BOTH", "NONE" ], "description": "Enrollment posture for the method." }, "conditions_to_override": { "type": "array", "description": "Payment-method-level condition sets that gate when the method appears. A client-supplied set `code` (UUID) is preserved.", "items": { "type": "object" } }, "required_fields_to_override": { "type": "object", "description": "Per-field configuration. `fields` = non-enrolled flow; `enrollment_fields` = enrolled (saved-card) flow. At most one condition set per field (a second is rejected with 400).", "properties": { "is_active": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "object" } }, "enrollment_fields": { "type": "array", "items": { "type": "object" } }, "is_enrollment_active": { "type": "boolean" } } } } } }, "general_settings": { "type": "object", "properties": { "country_documents": { "type": "array", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code.", "example": "BR" }, "documents": { "type": "array", "items": { "type": "string" }, "example": [ "CPF", "CNPJ" ] } } } } } } } }, "styling": { "type": "object", "description": "Checkout styling and SDK settings. Partial merge; omitted or null fields are preserved; use `flags.force_default_styles` to reset. `settings.urls`, `settings.click_to_pay`, `settings.form` and `settings.google_pay` are beta-locked and rejected if sent with a non-empty value.", "properties": { "styles": { "type": "object", "description": "global, header and button styles. All `*_color` fields must be a 6- or 8-digit hex color (#RRGGBB / #RRGGBBAA); `font_weight` must be one of 100..900 (step 100); `font_family` must be in the supported catalog or declared in `external_fonts`. Logos must be an HTTPS URL to a public host or a relative path (no data:/SVG/javascript:)." }, "settings": { "type": "object", "description": "SDK settings, forwarded to the checkout SDK. `settings.urls`, `settings.click_to_pay`, `settings.form` and `settings.google_pay` are beta-locked and rejected if sent with a non-empty value.", "properties": { "card": { "type": "object", "description": "Card SDK settings.", "properties": { "save_on_success": { "type": "boolean", "description": "Offer to save the card for future payments." }, "visualization_mode": { "type": "string", "description": "Card form visualization mode." }, "enable_ocr": { "type": "boolean", "description": "Enable card scanning (OCR)." }, "credit_card_only_processing": { "type": "boolean", "description": "Process credit cards only." }, "enable_payment_retry": { "type": "boolean", "description": "Allow retrying a declined card payment." }, "default_network": { "type": "string", "description": "Default card network: DOM or INT." } } }, "sdk_type": { "type": "object" }, "web_sdk": { "type": "object" }, "payment_method_list": { "type": "object" }, "ui": { "type": "object" } } }, "flags": { "type": "object", "properties": { "force_default_styles": { "type": "boolean" } } }, "external_fonts": { "type": "array", "description": "Custom fonts. `files[].url` must be an HTTPS URL to a public host.", "items": { "type": "object" } }, "payment_link_styles": { "type": "object" } } } } } } } }, "responses": { "200": { "description": "The updated checkout (configuration + styling composed). Its identifier is exposed as the top-level `id`.", "content": { "application/json": { "examples": { "Success": { "value": { "id": "8005ca91-dcfb-4428-b9f6-49c6e3446474", "name": "Main Checkout", "status": "PUBLISHED", "is_default": true, "config": { "payment_methods": [], "general_settings": {} }, "styling": { "styles": {}, "settings": {}, "flags": {} } } } }, "schema": { "type": "object" } } } }, "400": { "description": "Validation failed. All violations are aggregated into a single response. A malformed JSON body also returns 400.", "content": { "application/json": { "examples": { "Invalid parameters": { "value": { "code": "INVALID_PARAMETERS", "messages": [ "payment_methods[0].order_to_show must be >= 0", "styles.global.accent_color must be a 6- or 8-digit hex color (#RRGGBB or #RRGGBBAA)" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_PARAMETERS" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } }, "401": { "description": "Not authenticated, or the account is not in the beta allowlist.", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Not authenticated" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "NOT_AUTHENTICATED" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } }, "404": { "description": "The checkout was not found for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } } }, "deprecated": false, "tags": [ "Checkout Builder" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "AccountCode": [] } ] }, "patch": { "summary": "Manage Checkout Lifecycle", "description": "Renames, publishes, unpublishes, archives, restores, or promotes the checkout. The body carries any combination of `name`, `description`, `status`, and `is_default`; at least one field is required (an empty body is rejected with 400). Status transitions follow the lifecycle state machine: publish (`PUBLISHED`) is only valid from `NOT_PUBLISHED`; an ARCHIVED checkout is restored in two steps (`status: NOT_PUBLISHED` first, then `status: PUBLISHED`); patching to the current status is rejected. Metadata (`name`/`description`) remains editable while ARCHIVED. `is_default` accepts only `true`: it promotes the checkout to account default, force-publishing it from any state, and atomically demotes the previous default; when `is_default: true` is sent together with `status`, the promotion wins and `status` is ignored. The default checkout cannot be archived or unpublished.", "operationId": "manage-checkout-lifecycle", "parameters": [ { "name": "checkout_code", "in": "path", "description": "The unique identifier of the checkout to update (UUID, 36 chars). Non-UUID values are rejected with 400 before processing.", "schema": { "type": "string" }, "required": true }, { "name": "X-Idempotency-Key", "in": "header", "description": "Optional client key, up to 64 characters. Best-effort; re-sending the same key is not guaranteed to be de-duplicated.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "New checkout name. Unique per account (a duplicate name is rejected with 409). Editable in any status, including ARCHIVED." }, "description": { "type": "string", "description": "New checkout description. Editable in any status, including ARCHIVED." }, "status": { "type": "string", "enum": [ "PUBLISHED", "NOT_PUBLISHED", "ARCHIVED" ], "description": "Target lifecycle status. PUBLISHED is only reachable from NOT_PUBLISHED; NOT_PUBLISHED is reachable from PUBLISHED (unpublish) or ARCHIVED (restore); ARCHIVED is reachable from PUBLISHED or NOT_PUBLISHED. Any other transition (including patching to the current status) is rejected with 400. Unknown values are rejected with 400." }, "is_default": { "type": "boolean", "description": "Only `true` is accepted: promotes this checkout to account default, force-publishing it from any state and atomically demoting the previous default. `false` is rejected with 400; demote by promoting another checkout instead." } } }, "examples": { "Rename": { "value": { "name": "Promo Checkout (renamed)" } }, "Publish": { "value": { "status": "PUBLISHED" } }, "Unpublish": { "value": { "status": "NOT_PUBLISHED" } }, "Archive": { "value": { "status": "ARCHIVED" } }, "Restore an archived checkout (step 1 of 2)": { "value": { "status": "NOT_PUBLISHED" } }, "Promote to default": { "value": { "is_default": true } } } } } }, "responses": { "200": { "description": "The updated checkout summary. The identifier is exposed as the top-level `id`. Read the resulting `status` with the Fetch endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutMutationResponse_2" }, "examples": { "Updated": { "value": { "id": "0b28ff66-15f1-44c1-8d1e-bd1fefbc0a19", "name": "Promo Checkout (renamed)", "description": "Seasonal promo storefront", "is_default": false, "is_active": true, "created_at": "2026-07-17T10:02:33.000Z" } } } } } }, "400": { "description": "Empty body, invalid or same-status transition, unknown `status` value, `is_default: false`, a non-UUID `checkout_code`, or a malformed JSON body.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Invalid transition (e.g. direct ARCHIVED → PUBLISHED)": { "value": { "code": "INVALID_STATUS_TRANSITION", "messages": [ "Cannot transition from 'ARCHIVED' via this operation" ] } }, "Empty body": { "value": { "code": "INVALID_PATCH_BODY", "messages": [ "body is empty" ] } }, "is_default false": { "value": { "code": "INVALID_OPERATION", "messages": [ "isDefault: false direct demotion is not allowed; promote another checkout instead" ] } } } } } }, "401": { "description": "Not authenticated, or the account is not in the beta allowlist.", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Not authenticated" ] } } } } } }, "404": { "description": "The checkout was not found for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Checkout not found": { "value": { "code": "CHECKOUT_NOT_FOUND", "messages": [ "No Custom Checkout found for checkout_code: 0b28ff66-15f1-44c1-8d1e-bd1fefbc0a19" ] } } } } } }, "409": { "description": "Duplicate name, or the checkout is the account's default and cannot be archived or unpublished.", "content": { "application/json": { "examples": { "Duplicate name": { "value": { "code": "DUPLICATE_CHECKOUT_NAME", "messages": [ "A Custom Checkout with name 'Promo Checkout' already exists for this account" ] } }, "Archive the default": { "value": { "code": "CANNOT_ARCHIVE_DEFAULT_CHECKOUT", "messages": [ "Cannot archive the default Custom Checkout. Promote another checkout as default first." ] } }, "Unpublish the default": { "value": { "code": "CANNOT_UNPUBLISH_DEFAULT_CHECKOUT", "messages": [ "Cannot unpublish the default Custom Checkout. Promote another checkout as default first." ] } } } } } } }, "tags": [ "Checkout Builder" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "AccountCode": [] } ] } }, "/connections": { "post": { "summary": "Create a Connection", "operationId": "create-connection", "description": "Creates a connection in ACTIVE status.", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "merchant_connection_id", "provider_id", "flow_type", "payment_methods", "params" ], "properties": { "account_id": { "type": "string", "format": "uuid", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "merchant_connection_id": { "type": "string", "example": "adyen-us-prod-001" }, "provider_id": { "type": "string", "example": "ADYEN" }, "flow_type": { "type": "string", "example": "PAYIN" }, "payment_methods": { "type": "array", "items": { "type": "string" }, "example": [ "CARD", "GOOGLE_PAY" ] }, "params": { "type": "array", "items": { "type": "object", "properties": { "param_id": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "connection_id": { "type": "string", "example": "f1a3c4d5-7b8e-4a2c-9d1e-3f4a5b6c7d8e" }, "merchant_connection_id": { "type": "string", "example": "stripe-us-prod-001" }, "provider_id": { "type": "string", "example": "STRIPE" }, "status": { "type": "string", "example": "ACTIVE" }, "flow_type": { "type": "string", "example": "PAYIN" }, "payment_methods": { "type": "array", "items": { "type": "string" }, "example": [ "CARD", "GOOGLE_PAY", "APPLE_PAY" ] }, "params": { "type": "array", "items": { "type": "object" } }, "costs": { "type": "array", "items": { "type": "object" } }, "created_at": { "type": "string", "format": "date-time", "example": "2026-05-12T10:24:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-05-12T10:24:00Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation_error" }, "code": { "type": "string", "example": "MISSING_REQUIRED_PARAM" }, "message": { "type": "string", "example": "Required param 'API_KEY' is missing" }, "details": { "type": "object" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "conflict" }, "code": { "type": "string", "example": "CONNECTION_MERCHANT_ID_CONFLICT" }, "message": { "type": "string", "example": "A connection with this merchant_connection_id already exists" } } } } } } }, "tags": [ "Organizations" ] } }, "/connections/catalog/{provider_id}": { "get": { "summary": "Get Provider Catalog", "operationId": "get-provider-catalog", "description": "Returns the schema you need to fill in to create a connection for a given provider.", "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "example": "ADYEN" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "payment_method_type": { "type": "array", "items": { "type": "string" }, "example": [ "CARD", "GOOGLE_PAY", "APPLE_PAY", "ACH", "KLARNA_PAY_NOW", "KLARNA_PAY_LATER", "IDEAL", "GIROPAY", "BANCONTACT", "SEPA_DEBIT" ] }, "params": { "type": "array", "items": { "type": "object", "properties": { "param_id": { "type": "string", "example": "API_KEY" }, "field_type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "Stripe Secret API Key" }, "editable_field": { "type": "boolean", "example": true }, "optional": { "type": "boolean", "example": false }, "secret": { "type": "boolean", "example": true } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "auth_error" }, "code": { "type": "string", "example": "INSUFFICIENT_SCOPE" }, "message": { "type": "string", "example": "API key is missing required scope 'connections:read'" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "code": { "type": "string", "example": "PROVIDER_NOT_FOUND" }, "message": { "type": "string", "example": "Provider 'NOT_A_PROVIDER' is not in the Yuno provider catalog" } } } } } } }, "tags": [ "Organizations" ] } }, "/connections/{connection_id}": { "get": { "summary": "Retrieve a Connection", "operationId": "retrieve-connection", "description": "Returns a connection you previously created.", "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connection_id": { "type": "string", "example": "f1a3c4d5-7b8e-4a2c-9d1e-3f4a5b6c7d8e" }, "merchant_connection_id": { "type": "string", "example": "stripe-us-prod-001" }, "provider_id": { "type": "string", "example": "STRIPE" }, "status": { "type": "string", "example": "ACTIVE" }, "flow_type": { "type": "string", "example": "PAYIN" }, "payment_methods": { "type": "array", "items": { "type": "string" }, "example": [ "CARD", "GOOGLE_PAY", "APPLE_PAY" ] }, "params": { "type": "array", "items": { "type": "object", "properties": { "param_id": { "type": "string", "example": "merchantAccount" }, "value": { "type": "string", "example": "ACME_LIVE" } } } }, "costs": { "type": "array", "items": { "type": "object", "properties": { "sort_number": { "type": "integer", "example": 1 }, "cost_name": { "type": "string", "example": "Transaction Fee" }, "currency": { "type": "string", "example": "USD" } } } }, "created_at": { "type": "string", "format": "date-time", "example": "2026-05-12T10:24:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-05-12T10:24:00Z" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "auth_error" }, "code": { "type": "string", "example": "INSUFFICIENT_SCOPE" }, "message": { "type": "string", "example": "API key is missing required scope 'connections:read'" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "code": { "type": "string", "example": "CONNECTION_NOT_FOUND" }, "message": { "type": "string", "example": "Connection '...' was not found" } } } } } } }, "tags": [ "Organizations" ] } }, "/currency-conversion": { "post": { "summary": "Get Conversion Rate", "operationId": "get-conversion-rate", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "amount", "provider_data" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on the [Yuno dashboard](https://dashboard.y.uno) (UUID; 36 chars)." }, "amount": { "type": "object", "description": "Amount to be converted", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "Amount to convert (must be equal or greater than 0)." }, "currency": { "type": "string", "description": "The currency used to make the payment ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217); 3 chars)." }, "currency_conversion": { "type": "object", "description": "Information to make the conversion", "required": [ "cardholder_currency" ], "properties": { "cardholder_currency": { "type": "string", "description": "The currency to make the conversion ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217); 3 chars)." } } } } }, "provider_data": { "type": "object", "description": "Provider information", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Identification of the provider", "enum": [ "CIBC", "MERCADO_PAGO" ] } } }, "payment_method": { "type": "object", "description": "Payment method information. Provide either `token`, `vaulted_token`, or `card`.", "properties": { "token": { "type": "string", "description": "Payment method token (UUID; 36 chars)." }, "vaulted_token": { "type": "string", "description": "Vaulted payment method token (UUID; 36 chars)." }, "card": { "type": "object", "description": "Card information required for the currency conversion. Only for PCI compliant merchants.", "properties": { "card_data": { "type": "object", "description": "Card data information", "required": [ "number", "holder_name", "expiration_month", "expiration_year" ], "properties": { "number": { "type": "string", "description": "Card number without separators. Available for PCI-certified merchants (MIN 8)." }, "expiration_month": { "type": "integer", "description": "Card expiration month (01-12). Available for PCI-certified merchants (2 chars).", "format": "int32" }, "expiration_year": { "type": "integer", "description": "Card expiration year. Available for PCI-certified merchants (4 chars).", "format": "int32" }, "holder_name": { "type": "string", "description": "Cardholder full name. Available for PCI-certified merchants (MIN 3; MAX 26)." } } } } } } } } }, "examples": { "Example": { "value": { "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482", "amount": { "value": 10000, "currency": "COP", "currency_conversion": { "cardholder_currency": "USD" } }, "provider_data": { "id": "CIBC" }, "payment_method": { "card": { "card_data": { "number": "4111111111111111", "holder_name": "JOHN DOE", "expiration_month": 12, "expiration_year": 25 } } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "599cc714-9bb6-4a3c-8465-c360cd47e04e", "amount": { "value": 10000, "currency": "COP", "currency_conversion": { "cardholder_currency": "USD", "cardholder_amount": 2.58, "rate": 3879.812207, "provider_data": { "id": "CIBC", "transaction_id": "274c4fc9a1e3c27625fc4d925e0331783c3c5c94358280158d3980e97ac66795a80970d48c176078f394106345c05215431bbc6260a6980db3a2e0b753db1a3f32d0c8adfc02c18794dc07ac1c13a14e581a3d78ba4b9c5afdae537f38cc495628239b7470a997cc8d5b51ae787603b64de3b19cea09f825f6fd13896656b75092bd7fe19a0560df29b94", "response_code": "2000", "response_message": "Successful", "raw_response": { "fxRateInquiryResponse": { "localDate": 210, "localTime": 180927, "merchantID": "18695684", "rateEndTime": 1739212767659, "ratePreferenceCode": "R1", "rateStartTime": 1739210967659, "rateValidityPeriod": 30, "rates": [ { "cardholderAmount": 2.58, "cardholderCurrency": "840", "merchantAmount": 10000, "merchantCurrency": "170", "rate": 3879.812207, "rateInquiryRef": "274c4fc9a1e3c27625fc4d925e0331783c3c5c94358280158d3980e97ac66795a80970d48c176078f394106345c05215431bbc6260a6980db3a2e0b753db1a3f32d0c8adfc02c18794dc07ac1c13a14e581a3d78ba4b9c5afdae537f38cc495628239b7470a997cc8d5b51ae787603b64de3b19cea09f825f6fd13896656b75092bd7fe19a0560df29b94" } ], "responseCode": "2000", "responseMessage": "Successful", "sessionId": "2a587fa2-e7da-11ef-8b88-7e36493c761f", "terminalID": "CT000001", "traceNumber": 3594 } } } } }, "expired_at": "2025-02-10T18:39:27Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "599cc714-9bb6-4a3c-8465-c360cd47e04e" }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 10000, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "currency_conversion": { "type": "object", "properties": { "cardholder_currency": { "type": "string", "example": "USD" }, "cardholder_amount": { "type": "number", "example": 2.58, "default": 0 }, "rate": { "type": "number", "example": 3879.812207, "default": 0 }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "CIBC" }, "transaction_id": { "type": "string", "example": "274c4fc9a1e3c27625fc4d925e0331783c3c5c94358280158d3980e97ac66795a80970d48c176078f394106345c05215431bbc6260a6980db3a2e0b753db1a3f32d0c8adfc02c18794dc07ac1c13a14e581a3d78ba4b9c5afdae537f38cc495628239b7470a997cc8d5b51ae787603b64de3b19cea09f825f6fd13896656b75092bd7fe19a0560df29b94" }, "response_code": { "type": "string", "example": "2000" }, "response_message": { "type": "string", "example": "Successful" }, "raw_response": { "type": "object", "properties": { "fxRateInquiryResponse": { "type": "object", "properties": { "localDate": { "type": "integer", "example": 210, "default": 0 }, "localTime": { "type": "integer", "example": 180927, "default": 0 }, "merchantID": { "type": "string", "example": "18695684" }, "rateEndTime": { "type": "integer", "example": 1739212767659, "default": 0 }, "ratePreferenceCode": { "type": "string", "example": "R1" }, "rateStartTime": { "type": "integer", "example": 1739210967659, "default": 0 }, "rateValidityPeriod": { "type": "integer", "example": 30, "default": 0 }, "rates": { "type": "array", "items": { "type": "object", "properties": { "cardholderAmount": { "type": "number", "example": 2.58, "default": 0 }, "cardholderCurrency": { "type": "string", "example": "840" }, "merchantAmount": { "type": "integer", "example": 10000, "default": 0 }, "merchantCurrency": { "type": "string", "example": "170" }, "rate": { "type": "number", "example": 3879.812207, "default": 0 }, "rateInquiryRef": { "type": "string", "example": "274c4fc9a1e3c27625fc4d925e0331783c3c5c94358280158d3980e97ac66795a80970d48c176078f394106345c05215431bbc6260a6980db3a2e0b753db1a3f32d0c8adfc02c18794dc07ac1c13a14e581a3d78ba4b9c5afdae537f38cc495628239b7470a997cc8d5b51ae787603b64de3b19cea09f825f6fd13896656b75092bd7fe19a0560df29b94" } } } }, "responseCode": { "type": "string", "example": "2000" }, "responseMessage": { "type": "string", "example": "Successful" }, "sessionId": { "type": "string", "example": "2a587fa2-e7da-11ef-8b88-7e36493c761f" }, "terminalID": { "type": "string", "example": "CT000001" }, "traceNumber": { "type": "integer", "example": 3594, "default": 0 } } } } } } } } } } }, "expired_at": { "type": "string", "example": "2025-02-10T18:39:27Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": {} } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Conversion Rate" ], "security": [ { "XPublicApiKey": [], "XPrivateSecretKey": [] } ] } }, "/customers": { "get": { "summary": "Retrieve Customer by External ID", "description": "", "operationId": "retrieve-customer-by-external-id", "parameters": [ { "name": "merchant_customer_id", "in": "query", "description": "The unique identifier of the customer in the external merchant (MAX 255; MIN 1).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "94121f98-98f7-4d57-aa5f-228401d35b12" }, "merchant_customer_id": { "type": "string", "example": "1744402154" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "F" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@gmail.com" }, "nationality": { "type": "string", "example": "CO" }, "country": { "type": "string", "example": "CO" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "1010268952" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "3132450765" }, "country_code": { "type": "string", "example": "57" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "address_line_2": { "type": "string", "example": "Apartamento 502, Torre I" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogotá" }, "zip_code": { "type": "string", "example": "111111" }, "neighborhood": { "type": "string", "example": "Test" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "address_line_2": { "type": "string", "example": "Apartamento 502, Torre I" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogotá" }, "zip_code": { "type": "string", "example": "111111" }, "neighborhood": { "type": "string", "example": "Test" } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "ID" }, "value": { "type": "string", "example": "1234" } } } }, "created_at": { "type": "string", "example": "2025-04-11T20:09:14.927971Z" }, "updated_at": { "type": "string", "example": "2025-04-11T20:09:14.927972Z" }, "merchant_customer_created_at": { "type": "string", "example": "2023-08-05T14:43:58.980718Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Customer not found": { "value": { "code": "CUSTOMER_NOT_FOUND", "messages": [ "Customer not found." ] }, "summary": "Customer not found" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Invalid credentials": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid Credentials" ] }, "summary": "Invalid credentials" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Authorization required": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] }, "summary": "Authorization required" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Not Found": { "value": { "code": "NOT_FOUND", "messages": [ "Not Found" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "CUSTOMER_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Customer not found" } } } } } } } }, "deprecated": false, "tags": [ "Customers" ] }, "post": { "summary": "Create Customer", "description": "", "operationId": "create-customer", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchant_customer_id" ], "properties": { "merchant_customer_id": { "type": "string", "description": "The unique identifier of the customer in the external merchant (MAX 255; MIN 3)." }, "merchant_customer_created_at": { "type": "string", "description": "Customer's registration date on the merchants platform (MAX 27; MIN 27; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601))", "format": "date-time" }, "first_name": { "type": "string", "description": "The customer's first name (MAX 255; MIN 3)." }, "last_name": { "type": "string", "description": "The customer's last name (MAX 255; MIN 3)." }, "gender": { "type": "string", "description": "The customer's gender." }, "date_of_birth": { "type": "string", "description": "The customer's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10)." }, "email": { "type": "string", "description": "The customer's e-mail (MAX 255; MIN 3)." }, "nationality": { "type": "string", "description": "The customer's nationality (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SZ", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "country": { "type": "string", "description": "The customer's country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SZ", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "document": { "type": "object", "description": "Specifies the customer's document object, including its number and type. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.", "properties": { "document_number": { "type": "string", "description": "The customer's document number (MAX 40; MIN 3). This field is required if the 'document' object is included in the request." }, "document_type": { "type": "string", "description": "The customer's document type (MAX 6, MIN 3; [Country reference](country-reference))." } } }, "phone": { "type": "object", "description": "Specifies the customer's phone number object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the customer's phone (MAX 3; MIN 1). Possible values values: Check the [Country reference.](country-reference) This field is required if the 'phone' object is included in the request." }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1). This field is required if the 'phone' object is included in the request." } } }, "billing_address": { "type": "object", "description": "Specifies the customer's billing address object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 3). This field is required if the 'billing_address' object is included in the request." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 3)." }, "building_number_1": { "type": "string", "description": "The primary building number of the customer (MAX 255; MIN 3)" }, "building_number_2": { "type": "string", "description": "The secondary building number of the customer (MAX 255; MIN 3)" }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 3). This field is required if the 'billing_address' object is included in the request." }, "country": { "type": "string", "description": "The country considered for the billing address (MAX 2; MIN 2; [ISO 3166-1](country-reference)). This field is required if the 'billing_address' object is included in the request.", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SZ", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "state": { "type": "string", "description": "The state considered for the billing address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the billing address (MAX 10; MIN 5)." }, "neighborhood": { "type": "string", "description": "The neighborhood of the address line of the customer (MAX 255; MIN 1)." } }, "required": [ "address_line_1", "city" ] }, "shipping_address": { "type": "object", "description": "Specifies the customer's shipping address object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.", "properties": { "address_line_1": { "type": "string", "description": "The primary shipping address line of the customer (MAX 255; MIN 3). This field is required if the 'shipping_address' object is included in the request." }, "address_line_2": { "type": "string", "description": "The secondary shipping address line of the customer (MAX 255; MIN 3)." }, "building_number_1": { "type": "string", "description": "The primary building number of the customer (MAX 255; MIN 3)" }, "building_number_2": { "type": "string", "description": "The secondary building number of the customer (MAX 255; MIN 3)" }, "city": { "type": "string", "description": "The city considered for the shipping address (MAX 255; MIN 3). This field is required if the 'shipping_address' object is included in the request." }, "country": { "type": "string", "description": "The country considered for the shipping address (MAX 2; MIN 2; [ISO 3166-1](country-reference)). This field is required if the 'shipping_address' object is included in the request.", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SZ", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "state": { "type": "string", "description": "The state considered for the shipping address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the shipping address (MAX 10; MIN 5)." }, "neighborhood": { "type": "string", "description": "The neighborhood of the address line of the customer(MAX 255; MIN 1)." } }, "required": [ "address_line_1", "city", "country" ] }, "metadata": { "type": "array", "description": "Specifies a list of metadata objects. You can add up to 50 metadata objects.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48)." }, "value": { "type": "string", "description": "The metadata key value (MAX 512)." } }, "required": [ "key", "value" ], "type": "object" } } } }, "examples": { "Customer (full data)": { "value": { "merchant_customer_id": "4321", "merchant_customer_created_at": "2022-05-09T20:46:54.786342Z", "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "gender": "M", "date_of_birth": "1990-02-28", "nationality": "US", "country": "US", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001", "neighborhood": "Manhattan" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001", "neighborhood": "Manhattan" }, "metadata": [ { "key": "ID", "value": "123456" } ] } }, "Customer (min. data)": { "value": { "merchant_customer_id": "4321", "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com" } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Customer (full data)": { "value": { "id": "bf64527c-5531-4ece-bf2c-51a8e775d8e1", "merchant_customer_id": "AAAAAAAAAAAAAA0002", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "john.doe@email.com", "nationality": "US", "country": "US", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001", "neighborhood": "Manhattan" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001", "neighborhood": "Manhattan" }, "metadata": [ { "key": "ID", "value": "123456" } ], "created_at": "2025-04-24T18:54:54.351969Z", "updated_at": "2025-04-24T18:54:54.351971Z", "merchant_customer_created_at": "2022-05-09T20:46:54.786342Z" } }, "Customer (min. data)": { "value": { "id": "fe17085f-e9fd-4882-a42a-21eacc10fbb6", "merchant_customer_id": "AAAAAAA000001", "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "john.doe@email.com", "nationality": null, "country": null, "document": null, "phone": null, "billing_address": null, "shipping_address": null, "created_at": "2025-04-24T18:54:15.805086Z", "updated_at": "2025-04-24T18:54:15.805088Z", "merchant_customer_created_at": null } } }, "schema": { "oneOf": [ { "title": "Customer (full data)", "type": "object", "properties": { "id": { "type": "string", "example": "bf64527c-5531-4ece-bf2c-51a8e775d8e1" }, "merchant_customer_id": { "type": "string", "example": "AAAAAAAAAAAAAA0002" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@email.com" }, "nationality": { "type": "string", "example": "US" }, "country": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" }, "neighborhood": { "type": "string", "example": "Manhattan" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" }, "neighborhood": { "type": "string", "example": "Manhattan" } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "ID" }, "value": { "type": "string", "example": "123456" } } } }, "created_at": { "type": "string", "example": "2025-04-24T18:54:54.351969Z" }, "updated_at": { "type": "string", "example": "2025-04-24T18:54:54.351971Z" }, "merchant_customer_created_at": { "type": "string", "example": "2022-05-09T20:46:54.786342Z" } } }, { "title": "Customer (min. data)", "type": "object", "properties": { "id": { "type": "string", "example": "fe17085f-e9fd-4882-a42a-21eacc10fbb6" }, "merchant_customer_id": { "type": "string", "example": "AAAAAAA000001" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": {}, "date_of_birth": {}, "email": { "type": "string", "example": "john.doe@email.com" }, "nationality": {}, "country": {}, "document": {}, "phone": {}, "billing_address": {}, "shipping_address": {}, "created_at": { "type": "string", "example": "2025-04-24T18:54:15.805086Z" }, "updated_at": { "type": "string", "example": "2025-04-24T18:54:15.805088Z" }, "merchant_customer_created_at": {} } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid Credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid Credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API" } } } } } } } }, "deprecated": false, "tags": [ "Customers" ] } }, "/customers/payment-methods/{payment_method_id}/unenroll": { "post": { "summary": "Unenroll Payment Method", "description": "", "operationId": "unenroll-payment-method-checkout", "parameters": [ { "name": "payment_method_id", "in": "path", "description": "The payment method id to unenroll (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "77ee4a02-da3e-4a11-ac15-ba69e1813475", "idempotency_key": null, "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "VISA ****1111", "description": "VISA ****1111", "type": "CARD", "category": "CARD", "country": "US", "status": "UNENROLLED", "created_at": "2024-06-06T13:28:57.149530Z", "updated_at": "2024-06-06T13:31:13.945554Z", "enrollment": { "session": "0685f1d6-11ff-4992-abc3-9eea1842205c", "sdk_required_action": true }, "provider": { "id": "YUNO", "type": "YUNO", "provider_status": null }, "verify": { "vault_on_success": false, "payment": null }, "preferred": null } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "77ee4a02-da3e-4a11-ac15-ba69e1813475" }, "idempotency_key": {}, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "example": "VISA ****1111" }, "description": { "type": "string", "example": "VISA ****1111" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "UNENROLLED" }, "created_at": { "type": "string", "example": "2024-06-06T13:28:57.149530Z" }, "updated_at": { "type": "string", "example": "2024-06-06T13:31:13.945554Z" }, "enrollment": { "type": "object", "properties": { "session": { "type": "string", "example": "0685f1d6-11ff-4992-abc3-9eea1842205c" }, "sdk_required_action": { "type": "boolean", "example": true, "default": true } } }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO" }, "type": { "type": "string", "example": "YUNO" }, "provider_status": {} } }, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": false, "default": true }, "payment": {} } }, "preferred": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Checkout" ] } }, "/customers/sessions": { "post": { "summary": "Create Customer Session", "description": "", "operationId": "create-customer-session", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "country", "customer_id" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on [the Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars)." }, "country": { "type": "string", "description": "The customer's country (MAX 2; MIN 2; [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "customer_id": { "type": "string", "description": "The unique identifier of the customer, created using the [Create Customer](https://docs.y.uno/reference/create-customer) endpoint (UUID, 36 chars)." }, "callback_url": { "type": "string", "description": "The url to redirect your customer after the enrollment is made in the provider's environment (MAX 526; MIN 3)." }, "checkout_id": { "type": "string", "description": "The unique identifier (UUID) of the Custom Checkout to use for this enrollment session. Optional. When omitted, the session uses the account's default checkout." } } }, "examples": { "Customer session": { "value": { "account_id": "8beac4de-5f6f-11ed-9b6a-0242ac120002", "customer_id": "ae106483-65ee-463b-8782-9794022b3112", "country": "US", "callback_url": "https://www.google.com/?customerSession=7dd71f21-9e4c-439a-9c6d-58f240bd28df", "created_at": "2025-05-07T20:00:18.721786Z", "checkout_id": "6822f80c-684e-41a3-8628-78963d3d60f7" } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Customer session": { "value": { "customer_session": "7dd71f21-9e4c-439a-9c6d-58f240bd28df", "customer_id": "ae106483-65ee-463b-8782-9794022b3112", "country": "US", "callback_url": "https://www.google.com/?customerSession=7dd71f21-9e4c-439a-9c6d-58f240bd28df", "created_at": "2025-05-07T20:00:18.721786Z", "checkout_id": "6822f80c-684e-41a3-8628-78963d3d60f7" } } }, "schema": { "type": "object", "properties": { "customer_session": { "type": "string", "example": "7dd71f21-9e4c-439a-9c6d-58f240bd28df" }, "customer_id": { "type": "string", "example": "ae106483-65ee-463b-8782-9794022b3112" }, "country": { "type": "string", "example": "US" }, "callback_url": { "type": "string", "example": "https://www.google.com/?customerSession=7dd71f21-9e4c-439a-9c6d-58f240bd28df" }, "created_at": { "type": "string", "example": "2025-05-07T20:00:18.721786Z" }, "checkout_id": { "type": "string", "example": "6822f80c-684e-41a3-8628-78963d3d60f7" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } }, "Customer Not Found": { "value": { "code": "CUSTOMER_NOT_FOUND", "messages": [ "Customer not found" ] }, "summary": "Customer Not Found" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Customer Sessions Enrollment" ] } }, "/customers/sessions/{customer_session}/payment-methods": { "post": { "summary": "Enroll Payment Method", "description": "", "operationId": "enroll-payment-method-checkout", "parameters": [ { "name": "customer_session", "in": "path", "description": "The customer session that has been created for the enrollment using the [Create Customer Session](https://docs.y.uno/reference/create-customer-session) endpoint (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "payment_method_type", "country" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on [the Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars)." }, "payment_method_type": { "type": "string", "description": "The payment method type (MAX 255; MIN 3; [Payment Type List](/reference/payment-type-list)).", "enum": [ "CARD", "MERCADO_PAGO_WALLET", "NEQUI", "BANCOLOMBIA_TOKENBOX", "NU_PAY_ENROLLMENT" ] }, "country": { "type": "string", "description": "The transaction's country code (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "account_updater": { "type": "boolean", "description": "Per-card control for Card Account Updater. When set to `false`, this card is excluded from Card Account Updater and will not receive automatic card-detail updates. When omitted, the card follows your account's Account Updater configuration. Applies at enrollment." }, "verify": { "type": "object", "description": "Indicates whether to verify the payment with a verify transaction or not. You’ll need to have a provider defined in your CARD route. False by default. Access the [Card Verification](/docs/card-verification) page for more details.", "required": [ "vault_on_success" ], "properties": { "vault_on_success": { "type": "boolean", "description": "Indicates whether to verify the payment with a verify transaction or not. You’ll need to have a provider defined in your CARD route. False by default." }, "currency": { "type": "string", "description": "Currency of the card verification. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." } } } } }, "examples": { "Enroll": { "value": { "payment_method_type": "CARD", "country": "US", "account_id": "{{account_id}}" } }, "Enroll with card verification": { "value": { "account_id": "{{account_id}}", "payment_method_type": "CARD", "country": "US", "verify": { "vault_on_success": true, "currency": "USD" } } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Enroll": { "value": { "id": "0395199e-a99c-4a85-acac-6c916f43fa74", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Visa Credit Card", "description": "Visa Credit Card", "type": "VISA", "category": "CARD", "country": "US", "status": "READY_TO_ENROLL", "created_at": "2024-06-06T13:14:18.799434Z", "updated_at": "2024-06-06T13:14:18.799437Z", "enrollment": { "session": "6641e30d-ca7a-440f-b97c-24231eac6dab", "sdk_required_action": false }, "provider": { "id": "YUNO", "type": "YUNO", "provider_status": null }, "customer_payer": { "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "gender": "M", "date_of_birth": "1990-02-28", "document": { "document_number": "123456789", "document_type": "SSN" }, "phone": { "number": "1234567890", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001" } }, "verify": { "vault_on_success": false, "payment": null }, "preferred": null } }, "Enroll with card verification": { "value": { "id": "51887489-60d3-45a9-b895-81d3c1c3aec6", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Visa Credit Card", "description": "Visa Credit Card", "type": "VISA", "category": "CARD", "country": "US", "status": "READY_TO_ENROLL", "created_at": "2024-06-06T13:19:57.828087Z", "updated_at": "2024-06-06T13:19:57.828089Z", "enrollment": { "session": "238fc319-4a31-4568-be7f-c475e8fbe230", "sdk_required_action": false }, "provider": { "id": "YUNO", "type": "YUNO", "provider_status": null }, "customer_payer": { "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "gender": "M", "date_of_birth": "1990-02-28", "document": { "document_number": "123456789", "document_type": "SSN" }, "phone": { "number": "1234567890", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001" } }, "verify": { "vault_on_success": true, "currency": "USD", "payment": null }, "preferred": null } } }, "schema": { "oneOf": [ { "title": "Enroll", "type": "object", "properties": { "id": { "type": "string", "example": "0395199e-a99c-4a85-acac-6c916f43fa74" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "example": "Visa Credit Card" }, "description": { "type": "string", "example": "Visa Credit Card" }, "type": { "type": "string", "example": "VISA" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_ENROLL" }, "created_at": { "type": "string", "example": "2024-06-06T13:14:18.799434Z" }, "updated_at": { "type": "string", "example": "2024-06-06T13:14:18.799437Z" }, "enrollment": { "type": "object", "properties": { "session": { "type": "string", "example": "6641e30d-ca7a-440f-b97c-24231eac6dab" }, "sdk_required_action": { "type": "boolean", "example": false, "default": true } } }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO" }, "type": { "type": "string", "example": "YUNO" }, "provider_status": {} } }, "customer_payer": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "document": { "type": "object", "properties": { "document_number": { "type": "string", "example": "123456789" }, "document_type": { "type": "string", "example": "SSN" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "1234567890" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" } } } } }, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": false, "default": true }, "payment": {} } }, "preferred": {} } }, { "title": "Enroll with card verification", "type": "object", "properties": { "id": { "type": "string", "example": "51887489-60d3-45a9-b895-81d3c1c3aec6" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "example": "Visa Credit Card" }, "description": { "type": "string", "example": "Visa Credit Card" }, "type": { "type": "string", "example": "VISA" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_ENROLL" }, "created_at": { "type": "string", "example": "2024-06-06T13:19:57.828087Z" }, "updated_at": { "type": "string", "example": "2024-06-06T13:19:57.828089Z" }, "enrollment": { "type": "object", "properties": { "session": { "type": "string", "example": "238fc319-4a31-4568-be7f-c475e8fbe230" }, "sdk_required_action": { "type": "boolean", "example": false, "default": true } } }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO" }, "type": { "type": "string", "example": "YUNO" }, "provider_status": {} } }, "customer_payer": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "document": { "type": "object", "properties": { "document_number": { "type": "string", "example": "123456789" }, "document_type": { "type": "string", "example": "SSN" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "1234567890" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" } } } } }, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "payment": {} } }, "preferred": {} } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Checkout" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/customers/{customer_id}": { "get": { "summary": "Retrieve Customer", "description": "", "operationId": "retrieve-customer", "parameters": [ { "in": "path", "name": "customer_id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "94121f98-98f7-4d57-aa5f-228401d35b12", "merchant_customer_id": "1744402154", "first_name": "John", "last_name": "Doe", "gender": "F", "date_of_birth": "1990-02-28", "email": "john.doe@gmail.com", "nationality": "CO", "country": "CO", "document": { "document_type": "CC", "document_number": "1010268952" }, "phone": { "number": "3132450765", "country_code": "57" }, "billing_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": "Test" }, "shipping_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": "Test" }, "metadata": [ { "key": "ID", "value": "1234" } ], "created_at": "2025-04-11T20:09:14.927971Z", "updated_at": "2025-04-11T20:09:14.927972Z", "merchant_customer_created_at": "2023-08-05T14:43:58.980718Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "94121f98-98f7-4d57-aa5f-228401d35b12" }, "merchant_customer_id": { "type": "string", "example": "1744402154" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "F" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@gmail.com" }, "nationality": { "type": "string", "example": "CO" }, "country": { "type": "string", "example": "CO" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "1010268952" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "3132450765" }, "country_code": { "type": "string", "example": "57" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "address_line_2": { "type": "string", "example": "Apartamento 502, Torre I" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogotá" }, "zip_code": { "type": "string", "example": "111111" }, "neighborhood": { "type": "string", "example": "Test" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "address_line_2": { "type": "string", "example": "Apartamento 502, Torre I" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogotá" }, "zip_code": { "type": "string", "example": "111111" }, "neighborhood": { "type": "string", "example": "Test" } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "ID" }, "value": { "type": "string", "example": "1234" } } } }, "created_at": { "type": "string", "example": "2025-04-11T20:09:14.927971Z" }, "updated_at": { "type": "string", "example": "2025-04-11T20:09:14.927972Z" }, "merchant_customer_created_at": { "type": "string", "example": "2023-08-05T14:43:58.980718Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Customer not found": { "value": { "code": "CUSTOMER_NOT_FOUND", "messages": [ "Customer not found." ] }, "summary": "Customer not found" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Invalid credentials": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid Credentials" ] }, "summary": "Invalid credentials" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Authorization required": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API" ] }, "summary": "Authorization required" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API" } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Not Found": { "value": { "code": "NOT_FOUND", "messages": [ "Not Found" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "CUSTOMER_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Customer not found" } } } } } } } }, "deprecated": false, "tags": [ "Customers" ] }, "patch": { "summary": "Update Customer", "description": "", "operationId": "update-customer", "parameters": [ { "name": "customer_id", "in": "path", "description": "The unique identifier of the customer (UUID | MAX 36; MIN 36).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "merchant_customer_id": { "type": "string", "description": "The unique identifier of the customer in the external merchant (MAX 255; MIN 3)." }, "merchant_customer_created_at": { "type": "string", "description": "Customer´s registration date on the merchants platform (ISO 8601 MAX 27; MIN 27)", "format": "date-time" }, "first_name": { "type": "string", "description": "The customer's first name (MAX 255; MIN 3)." }, "last_name": { "type": "string", "description": "The customer's last name (MAX 255; MIN 3)." }, "gender": { "type": "string", "description": "The customer's gender." }, "date_of_birth": { "type": "string", "description": "The customer's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10)." }, "email": { "type": "string", "description": "The customer's e-mail (MAX 255; MIN 3)." }, "nationality": { "type": "string", "description": "The customer's nationality (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SZ", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "country": { "type": "string", "description": "The customer's country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SZ", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "document": { "type": "object", "description": "Specifies the customer's document object, including its number and type.", "properties": { "document_number": { "type": "string", "description": "The customer's document number (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "The customer's document type (MAX 6, MIN 3; [Country reference](country-reference))." } } }, "phone": { "type": "object", "description": "Specifies the customer's phone number object.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the customer's phone (MAX 3; MIN 1). Possible values values: Check the [Country reference.](country-reference)" }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1)." } } }, "billing_address": { "type": "object", "description": "Specifies the customer's billing address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the billing address (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SZ", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "state": { "type": "string", "description": "The state considered for the billing address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the billing address (MAX 10; MIN 5)." }, "neighborhood": { "type": "string", "description": "The neighborhood of the address line of the customer(MAX 255; MIN 1)." } } }, "shipping_address": { "type": "object", "description": "Specifies the customer's shipping address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary shipping address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary shipping address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the shipping address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the shipping address (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SZ", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "state": { "type": "string", "description": "The state considered for the shipping address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the shipping address (MAX 10; MIN 5)." }, "neighborhood": { "type": "string", "description": "The neighborhood of the address line of the customer(MAX 255; MIN 1)." } } }, "metadata": { "type": "array", "description": "Specifies a list of metadata objects. You can add up to 50 metadata objects.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48)." }, "value": { "type": "string", "description": "The metadata key value (MAX 512)." } }, "required": [ "key", "value" ], "type": "object" } } } }, "examples": { "update": { "value": { "email": "john.doe2@gmail.com" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "update": { "value": { "id": "94121f98-98f7-4d57-aa5f-228401d35b12", "merchant_customer_id": "1744402154", "first_name": "John", "last_name": "Doe", "gender": "F", "date_of_birth": "1990-02-28", "email": "john.doe2@gmail.com", "nationality": "CO", "country": "CO", "document": { "document_type": "CC", "document_number": "1010268952" }, "phone": { "number": "3132450765", "country_code": "57" }, "billing_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": "Test" }, "shipping_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": "Test" }, "metadata": [ { "key": "ID", "value": "1234" } ], "created_at": "2025-04-11T20:10:29.163144Z", "updated_at": "2025-04-11T20:10:29.163141Z", "merchant_customer_created_at": "2023-08-05T14:43:58.980718Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "94121f98-98f7-4d57-aa5f-228401d35b12" }, "merchant_customer_id": { "type": "string", "example": "1744402154" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "F" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe2@gmail.com" }, "nationality": { "type": "string", "example": "CO" }, "country": { "type": "string", "example": "CO" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "1010268952" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "3132450765" }, "country_code": { "type": "string", "example": "57" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "address_line_2": { "type": "string", "example": "Apartamento 502, Torre I" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogotá" }, "zip_code": { "type": "string", "example": "111111" }, "neighborhood": { "type": "string", "example": "Test" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "address_line_2": { "type": "string", "example": "Apartamento 502, Torre I" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogotá" }, "zip_code": { "type": "string", "example": "111111" }, "neighborhood": { "type": "string", "example": "Test" } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "ID" }, "value": { "type": "string", "example": "1234" } } } }, "created_at": { "type": "string", "example": "2025-04-11T20:10:29.163144Z" }, "updated_at": { "type": "string", "example": "2025-04-11T20:10:29.163141Z" }, "merchant_customer_created_at": { "type": "string", "example": "2023-08-05T14:43:58.980718Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Customers" ] }, "delete": { "description": "", "operationId": "delete-customer", "responses": { "202": { "description": "Accepted (body is empty)" }, "400": { "description": "Customer not found", "content": { "application/json": { "examples": { "Customer Not Found": { "value": { "code": "CUSTOMER_NOT_FOUND", "messages": [ "Customer not found." ] }, "summary": "Customer Not Found" }, "Bad Request": { "summary": "Bad Request", "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string" }, "example": [ "Not found" ] } } } } } } }, "parameters": [ { "in": "header", "name": "x-account-code", "schema": { "type": "string" }, "description": "The account_id found in the Yuno Dashboard (UUID | MAX 36; MIN 36).", "required": true }, { "in": "path", "name": "customer_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Customers" ] } }, "/customers/{customer_id}/payment-methods": { "get": { "summary": "Retrieve Enrolled Payment Methods", "description": "", "operationId": "retrieve-enrolled-payment-methods-api", "parameters": [ { "name": "customer_id", "in": "path", "description": "The unique identifier of the customer, created using the [Create Customer](https://docs.y.uno/reference/create-customer) endpoint (MAX 64; MIN 36).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "payment_methods": [ { "idempotency_key": null, "name": "VISA ****1111", "description": "VISA ****1111", "icon": "https://icons.prod.y.uno/visa_logosimbolo.png", "type": "CARD", "category": "CARD", "country": "US", "status": "ENROLLED", "sub_status": null, "vaulted_token": "46adcbc0-aa26-4867-a4e7-28a5ad9100ae", "callback_url": null, "action": null, "redirect_url": null, "created_at": "2023-08-05T14:22:06.766268Z", "updated_at": "2023-08-05T14:22:06.766268Z", "card_data": { "iin": "41111111", "lfd": "1111", "expiration_month": 3, "expiration_year": 27, "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer": null, "issuer_name": "JPMORGAN_CHASE_BANK_NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT" }, "last_successfully_used": false, "last_successfully_used_at": "" }, { "idempotency_key": null, "name": "VISA ****1111", "description": "VISA ****1111", "icon": "https://icons.prod.y.uno/visa_logosimbolo.png", "type": "CARD", "category": "CARD", "country": "US", "status": "ENROLLED", "sub_status": null, "vaulted_token": "7ced7717-f860-4705-a376-58a714953de9", "callback_url": null, "action": null, "redirect_url": null, "created_at": "2023-08-05T14:45:24.112621Z", "updated_at": "2023-08-05T14:45:24.112621Z", "card_data": { "iin": "41111111", "lfd": "1111", "expiration_month": 3, "expiration_year": 27, "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer": null, "issuer_name": "JPMORGAN_CHASE_BANK_NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT" }, "last_successfully_used": false, "last_successfully_used_at": "" } ] } } }, "schema": { "type": "object", "properties": { "payment_methods": { "type": "array", "items": { "type": "object", "properties": { "idempotency_key": {}, "name": { "type": "string", "example": "VISA ****1111" }, "description": { "type": "string", "example": "VISA ****1111" }, "icon": { "type": "string", "example": "https://icons.prod.y.uno/visa_logosimbolo.png" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "ENROLLED" }, "sub_status": {}, "vaulted_token": { "type": "string", "example": "46adcbc0-aa26-4867-a4e7-28a5ad9100ae" }, "callback_url": {}, "action": {}, "redirect_url": {}, "created_at": { "type": "string", "example": "2023-08-05T14:22:06.766268Z" }, "updated_at": { "type": "string", "example": "2023-08-05T14:22:06.766268Z" }, "card_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 27, "default": 0 }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "security_code_expires_in": { "type": "integer", "example": 842, "description": "Seconds left before the stored security code stops being available to the PCI forward proxy. Returns -1 once that window has closed, and is omitted entirely when the card carries no security code. Only present for organizations with the PCI forward proxy enabled." }, "brand": { "type": "string", "example": "VISA" }, "issuer": {}, "issuer_name": { "type": "string", "example": "JPMORGAN_CHASE_BANK_NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" } } }, "last_successfully_used": { "type": "boolean", "example": false, "default": true }, "last_successfully_used_at": { "type": "string", "example": "" } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Direct Workflow" ] }, "post": { "summary": "Enroll Payment Method", "description": "", "operationId": "enroll-payment-method-api", "parameters": [ { "name": "customer_id", "in": "path", "description": "The unique identifier of the customer, created using the [Create Customer](https://docs.y.uno/reference/create-customer) endpoint (MAX 64; MIN 36).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "country", "type" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on [Yuno's Dashboard](https://dashboard.y.uno/) (MAX 64; MIN 36)." }, "country": { "type": "string", "description": "The transaction's country code (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "type": { "type": "string", "description": "The payment method type (MAX 255; MIN 3; [Payment type](/reference/payment-type-list)).", "enum": [ "CARD", "ACH_ENROLLMENT", "NU_PAY_ENROLLMENT" ] }, "workflow": { "type": "string", "description": "The payment workflow indicates whether the integration will use Yuno's SDK or will be a back to back connection. Since you are in the Direct workflow, the value must be `DIRECT`.", "default": "DIRECT", "enum": [ "DIRECT" ] }, "callback_url": { "type": "string", "description": "URL to return the customer after an enrollment in a provider´s environment. Only necessary for alternative payment methods integrations (MAX 255; MIN 3)." }, "token": { "type": "string", "format": "uuid", "description": "Pre-generated token used to reference the payment method being enrolled." }, "parent_type": { "type": "string", "description": "Type of the parent payment method, used when enrolling a tokenized/derived method (e.g. `CARD`)." }, "account_updater": { "type": "boolean", "description": "Per-card control for Card Account Updater. When set to `false`, this card is excluded from Card Account Updater and will not receive automatic card-detail updates. When omitted, the card follows your account's Account Updater configuration. Applies at enrollment." }, "card_data": { "type": "object", "description": "Specifies the details of the card. Only for `DIRECT` workflow integration.", "required": [ "number", "expiration_month", "expiration_year" ], "properties": { "number": { "type": "string", "description": "Card’s number without any separators (MAX 19; MIN 8) - only available for PCI certified merchants." }, "expiration_month": { "type": "integer", "description": "Card’s expiration month - MM (MAX 2; MIN 2) - only available for PCI certified merchants.", "format": "int32" }, "expiration_year": { "type": "integer", "description": "Card’s expiration year - YYYY (MAX 4; MIN 4) - only available for PCI certified merchants.", "format": "int32" }, "security_code": { "type": "string", "description": "Card’s security code (MAX 4; MIN 3) - only available for PCI certified merchants." }, "holder_name": { "type": "string", "description": "Cardholder’s full name as it appears on the card (MAX 26; MIN 3) - only available for PCI certified merchants." }, "brand": { "type": "string", "description": "Card brand (e.g. `VISA`, `MASTERCARD`, `AMEX`)." }, "scheme": { "type": "string", "description": "Card scheme used to process the transaction (validated card scheme)." }, "soft_descriptor": { "type": "string", "description": "Statement descriptor shown on the cardholder’s bank statement." }, "card_pin": { "type": "string", "description": "Card PIN, for payment methods that require it." }, "authentication_method": { "type": "string", "description": "Authentication method for Click-to-Pay.", "enum": [ "FIDO2", "OWN_CREDENTIALS", "FEDERATED_ID" ] } } }, "customer_payer": { "type": "object", "description": "Information about the customer/payer associated with the payment method.", "properties": { "code": { "type": "string", "description": "Yuno customer identifier (customer code). MIN 3 / MAX 255." }, "organization_customer_external_id": { "type": "string", "description": "Customer identifier in the merchant’s own system, scoped to the organization. MIN 3 / MAX 255." }, "email": { "type": "string", "description": "Email address of the customer." }, "ip_address": { "type": "string", "description": "IP address of the customer at the time of enrollment. Required by the provider for the online ACH mandate." }, "browser_info": { "type": "object", "description": "Browser metadata. Required by the provider for the online ACH mandate.", "properties": { "user_agent": { "type": "string", "description": "Full user-agent string of the customer’s browser." } } } } }, "payment_method": { "type": "object", "description": "Payment method wrapper used for non-card methods (e.g. bank transfer / ACH) and vaulting options.", "properties": { "type": { "type": "string", "description": "Method type label for the enrolled instrument (e.g. `ACH_ENROLLMENT`). The enrollment type is driven by the top-level `type`; this field is informational." }, "vault_on_success": { "type": "boolean", "description": "When `true`, the payment method is vaulted (saved) after a successful enrollment." }, "vault_only": { "type": "boolean", "description": "When `true`, Yuno stores the bank details from `payment_method.detail.bank_transfer` and enrolls the payment method immediately as `ENROLLED`, without any provider interaction at enrollment or unenrollment. Only available for bank transfer enrollments." }, "detail": { "type": "object", "description": "Method-specific details for the instrument being enrolled.", "properties": { "bank_transfer": { "type": "object", "required": [ "beneficiary_name", "routing_number" ], "properties": { "account_type": { "type": "string", "description": "Bank account type.", "enum": [ "CHECKINGS", "SAVINGS" ] }, "account_holder_type": { "type": "string", "description": "Type of account holder (e.g. `INDIVIDUAL`, `ENTITY`). Accepted and stored, but not forwarded to the provider for ACH — does not control individual vs. company treatment for ACH enrollment.", "enum": [ "INDIVIDUAL", "ENTITY" ] }, "bank_id": { "type": "string", "description": "Identifier of the bank. MIN 3 / MAX 255." }, "bank_name": { "type": "string", "description": "Name of the bank. MIN 3 / MAX 255." }, "bank_account": { "type": "string", "description": "Bank account number. MIN 3 / MAX 255." }, "beneficiary_name": { "type": "string", "description": "Name of the account beneficiary. MIN 3 / MAX 255." }, "branch": { "type": "string", "description": "Bank branch code. MIN 1 / MAX 8." }, "branch_digit": { "type": "string", "description": "Branch verification digit. MIN 1 / MAX 2." }, "routing_number": { "type": "string", "description": "Bank routing number. MIN 3 / MAX 255." }, "code": { "type": "string", "description": "Bank code. MIN 1 / MAX 8." }, "reference": { "type": "string", "description": "Reference associated with the bank account. MIN 1 / MAX 255." }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." }, "creditor_id": { "type": "string", "description": "Creditor identifier of the direct debit mandate (for example, the SEPA creditor identifier shown on the payer's bank statement). MIN 1 / MAX 128." } } } } } } } } }, "provider_data": { "type": "object", "description": "Provider data used for token migration or provider-token enrollment. Send this object when `token_source` is `PROVIDER_API`, `MIGRATION_FILE`, or `PROVIDER_TOKEN`. Usage must be agreed with your commercial advisor in Yuno.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the payment provider." }, "token_source": { "type": "string", "description": "Origin of the provided token. Note: `PROVIDER_TOKEN` is only supported when the top-level `type` is `CARD`. Using it with `ACH_ENROLLMENT` returns an error.", "enum": [ "PROVIDER_API", "MIGRATION_FILE", "PROVIDER_TOKEN" ] }, "payment_method_token": { "type": "string", "description": "Provider’s payment method token. Required when `token_source` is `PROVIDER_TOKEN`." }, "connection_id": { "type": "string", "format": "uuid", "description": "Identifier of the provider connection. Required when `token_source` is `PROVIDER_API` or `PROVIDER_TOKEN`." } } }, "verify": { "type": "object", "description": "Indicates whether to verify the payment with a verify transaction or not. You’ll need to have a provider defined in your CARD route. False by default.", "required": [ "vault_on_success" ], "properties": { "vault_on_success": { "type": "boolean", "description": "Indicates whether to verify the payment with a verify transaction or not. You’ll need to have a provider defined in your CARD route. False by default." }, "currency": { "type": "string", "description": "Currency of the card verification. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "metadata": { "type": "array", "description": "Optional custom key–value tags for the verification (e.g., order_ref, invoice). They are attached to the internal verify payment created by the verification — available downstream exactly like payment `metadata` (payment data, provider gateway request, routing) — and stored with the enrolled payment method's verification settings. Up to 120 items.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48. Value: MIN:1, MAX:48). **[Case Sensitive]**" }, "value": { "type": "string", "description": "The metadata key value (MAX 512. Value: MIN:1, MAX:512). **[Case Sensitive]**" } }, "required": [ "key", "value" ], "type": "object" } } } }, "recurring_payment": { "type": "object", "description": "Recurring / subscription billing metadata associated with the enrolled method.", "properties": { "regular_billing": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label for the recurring billing plan." }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "description": "Billing currency, ISO 4217 format (3 letters)." }, "value": { "type": "number", "description": "Billing amount per interval. Range 0 – 9999999999." } } }, "interval_unit": { "type": "string", "description": "Billing interval unit.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] }, "interval_count": { "type": "integer", "description": "Number of interval units between charges (e.g. `1` = every month when `interval_unit` is `MONTH`)." } } } } } } }, "examples": { "Card Direct": { "value": { "account_id": "dbf0c133-86bc-4be0-94a5-ca2ff6778451", "country": "CO", "type": "CARD", "workflow": "DIRECT", "card_data": { "number": "4111111111111111", "holder_name": "JOHN DOE", "expiration_month": 12, "expiration_year": 26, "security_code": "212", "brand": "VISA" }, "customer_payer": { "code": "12345", "organization_customer_external_id": "ext-12345" }, "verify": { "vault_on_success": true, "currency": "COP" } } }, "ACH Enrollment": { "value": { "account_id": "dbf0c133-86bc-4be0-94a5-ca2ff6778451", "country": "US", "type": "ACH_ENROLLMENT", "workflow": "DIRECT", "customer_payer": { "code": "", "email": "john@example.com", "ip_address": "203.0.113.5", "browser_info": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36" } }, "payment_method": { "vault_on_success": true, "detail": { "bank_transfer": { "bank_account": "000123456789", "routing_number": "110000000", "beneficiary_name": "John Doe", "account_type": "CHECKINGS", "bank_account_mask_number": "****6789", "mandate": { "id": "MND-123", "info": "free text mandate info", "received_status": "RECEIVED", "existing_status": "ACTIVE", "created_at": "2026-07-09T00:00:00Z", "updated_at": "2026-07-09T00:00:00Z" } } } } } }, "SEPA mandate import (vault-only)": { "value": { "account_id": "dbf0c133-86bc-4be0-94a5-ca2ff6778451", "country": "DE", "type": "SEPA", "payment_method": { "vault_only": true, "detail": { "bank_transfer": { "bank_account": "DE89370400440532013000", "bank_account_mask_number": "****3000", "beneficiary_name": "Max Mustermann", "account_holder_type": "INDIVIDUAL", "mandate": { "id": "MNDT-2019-000123", "info": "SEPA Core Direct Debit mandate", "creditor_id": "DE98ZZZ09999999999", "received_status": "RECEIVED", "existing_status": "ACTIVE", "created_at": "2019-05-04T00:00:00Z" } } } }, "customer_payer": { "first_name": "Max", "last_name": "Mustermann", "email": "max@example.com" } } }, "Token migration process": { "value": { "account_id": "dbf0c133-86bc-4be0-94a5-ca2ff6778451", "country": "MX", "type": "CARD", "workflow": "DIRECT", "provider_data": { "id": "DLOCAL", "token_source": "PROVIDER_TOKEN", "payment_method_token": "tok_provider_abc123", "connection_id": "b1a2c3d4-e5f6-7890-abcd-ef1234567890" }, "verify": { "vault_on_success": true } } }, "Card Enrollment With Verification": { "value": { "account_id": "dbf0c133-86bc-4be0-94a5-ca2ff6778451", "country": "US", "type": "CARD", "workflow": "DIRECT", "card_data": { "holder_name": "John Doe", "expiration_month": 3, "expiration_year": 30, "number": "4111111111111111", "security_code": "123" }, "verify": { "vault_on_success": true, "currency": "USD", "metadata": [ { "key": "order_ref", "value": "ABC-123" } ] } } }, "Provider token enrollment": { "summary": "Enroll a provider-issued token (PROVIDER_TOKEN flow)", "value": { "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482", "country": "CO", "type": "CARD", "card_data": { "brand": "VISA", "lfd": "4242" }, "provider_data": { "id": "ADYEN", "token_source": "PROVIDER_TOKEN", "payment_method_token": "tok_provider_xyz", "connection_id": "f00d04b4-584f-4790-b51d-ceede8fd8f0f" } } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "ACH Enrollment": { "value": { "type": "ACH_ENROLLMENT", "status": "READY_TO_ENROLL", "action": "REDIRECT_URL", "redirect_url": "https://payments.stripe.com/microdeposit/pacreq_test_placeholder" } }, "Result": { "value": { "idempotency_key": "2ca58c6d-8794-4c8f-a2f6-bba4b7498b74", "name": "VISA ****1111", "description": "VISA ****1111", "type": "CARD", "category": "CARD", "country": "US", "status": "ENROLLED", "sub_status": null, "vaulted_token": "cbdcc878-ceb4-4dd8-b0f0-49d444855de0", "callback_url": "www.example.com", "action": null, "created_at": "2024-06-06T13:32:49.715656Z", "updated_at": "2024-06-06T13:32:49.715656Z", "card_data": { "iin": "41111111", "lfd": "1111", "holder_name": "JOHN DOE", "expiration_month": 3, "expiration_year": 26, "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer": "JPMORGAN CHASE BANK N A", "issuer_code": null, "country_code": "US", "category": "CREDIT", "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "last_successfully_used": null, "last_successfully_used_at": null, "preferred": null, "verify": { "vault_on_success": false, "payment": null } } }, "With Verify": { "value": { "idempotency_key": "2ca58c6d-8794-4c8f-a2f6-bba4b7498b74", "name": "VISA ****0000", "description": "VISA ****0000", "type": "CARD", "category": "CARD", "country": "US", "status": "ENROLLED", "sub_status": null, "vaulted_token": "9c298b36-b005-42ed-92e1-808b2a785e5f", "callback_url": null, "action": null, "created_at": "2023-09-04T16:37:55.314018Z", "updated_at": "2023-09-04T16:37:55.314019Z", "card_data": { "iin": "49880800", "lfd": "0000", "holder_name": "JOHN DOE", "expiration_month": 3, "expiration_year": 30, "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer": "JPMORGAN CHASE BANK N A", "issuer_code": null, "country_code": "US", "category": "BUSINESS ENHANCED", "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "last_successfully_used": null, "last_successfully_used_at": null, "preferred": null, "verify": { "vault_on_success": true, "currency": "USD", "payment": { "id": "2ff3872a-9b62-412f-be3e-69689b184e5f", "account_id": "ad59c347-407c-4f11-841b-f3ac260cd018", "description": "VERIFY CARD", "country": "US", "status": "SUCCEEDED", "sub_status": "VERIFIED", "merchant_order_id": "VERIFY_CARD_9c298b36-b005-42ed-92e1-808b2a785e5f", "created_at": "2023-09-04T16:37:55.352948Z", "updated_at": "2023-09-04T16:37:56.429675Z", "amount": { "currency": "USD", "value": 0, "refunded": 0, "captured": 0 }, "metadata": [ { "key": "order_ref", "value": "ABC-123" } ], "transactions": [ { "id": "1e501f45-583b-4187-b42e-8c3e620d1ef5", "type": "VERIFY", "status": "SUCCEEDED", "response_code": "SUCCEEDED", "response_message": "Transaction successful", "category": "CARD", "merchant_reference": "VERIFY_CARD_9c298b36-b005-42ed-92e1-808b2a785e5f", "provider_data": { "id": "ADYEN", "transaction_id": "SKCN8ZR5S8NKGK82", "account_id": "", "status": "Cancelled", "sub_status": "", "status_detail": "", "response_message": "", "raw_response": { "additionalData": { "threeds2.cardEnrolled": "false" }, "merchantReference": "VERIFY_CARD_9c298b36-b005-42ed-92e1-808b2a785e5f", "refusalReason": "FRAUD-CANCELLED", "refusalReasonCode": "22", "resultCode": "Cancelled" }, "third_party_transaction_id": null }, "created_at": "2023-09-04T16:37:55.482510Z", "updated_at": "2023-09-04T16:37:56.348742Z" } ] } } } } }, "schema": { "oneOf": [ { "type": "object", "properties": { "idempotency_key": { "type": "string", "example": "2ca58c6d-8794-4c8f-a2f6-bba4b7498b74" }, "name": { "type": "string", "example": "VISA ****1111" }, "description": { "type": "string", "example": "VISA ****1111" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "ENROLLED" }, "sub_status": {}, "vaulted_token": { "type": "string", "example": "cbdcc878-ceb4-4dd8-b0f0-49d444855de0" }, "callback_url": { "type": "string", "example": "www.example.com" }, "action": {}, "redirect_url": { "type": "string", "example": null }, "parent_type": { "type": "string", "example": "CARD" }, "created_at": { "type": "string", "example": "2024-06-06T13:32:49.715656Z" }, "updated_at": { "type": "string", "example": "2024-06-06T13:32:49.715656Z" }, "card_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "holder_name": { "type": "string", "description": "Cardholder's full name as returned by the payment provider.", "example": "JOHN DOE" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the card's issuing country.", "example": "US" }, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" } } }, "last_successfully_used": {}, "last_successfully_used_at": {}, "preferred": {}, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": false, "default": true }, "payment": {} } }, "provider_data": { "type": "object", "description": "Additional data from the provider", "properties": { "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object" } } } } }, { "title": "With Verify", "type": "object", "properties": { "idempotency_key": { "type": "string", "example": "2ca58c6d-8794-4c8f-a2f6-bba4b7498b74" }, "name": { "type": "string", "example": "VISA ****0000" }, "description": { "type": "string", "example": "VISA ****0000" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "ENROLLED" }, "sub_status": {}, "vaulted_token": { "type": "string", "example": "9c298b36-b005-42ed-92e1-808b2a785e5f" }, "callback_url": {}, "action": {}, "created_at": { "type": "string", "example": "2023-09-04T16:37:55.314018Z" }, "updated_at": { "type": "string", "example": "2023-09-04T16:37:55.314019Z" }, "card_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "49880800" }, "lfd": { "type": "string", "example": "0000" }, "holder_name": { "type": "string", "description": "Cardholder's full name as returned by the payment provider.", "example": "JOHN DOE" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 30, "default": 0 }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the card's issuing country.", "example": "US" }, "category": { "type": "string", "example": "BUSINESS ENHANCED" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" } } }, "last_successfully_used": {}, "last_successfully_used_at": {}, "preferred": {}, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "2ff3872a-9b62-412f-be3e-69689b184e5f" }, "account_id": { "type": "string", "example": "ad59c347-407c-4f11-841b-f3ac260cd018" }, "description": { "type": "string", "example": "VERIFY CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "VERIFIED" }, "merchant_order_id": { "type": "string", "example": "VERIFY_CARD_9c298b36-b005-42ed-92e1-808b2a785e5f" }, "created_at": { "type": "string", "example": "2023-09-04T16:37:55.352948Z" }, "updated_at": { "type": "string", "example": "2023-09-04T16:37:56.429675Z" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 0, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "1e501f45-583b-4187-b42e-8c3e620d1ef5" }, "type": { "type": "string", "example": "VERIFY" }, "status": { "type": "string", "example": "SUCCEEDED" }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "category": { "type": "string", "example": "CARD" }, "merchant_reference": { "type": "string", "example": "VERIFY_CARD_9c298b36-b005-42ed-92e1-808b2a785e5f" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ADYEN" }, "transaction_id": { "type": "string", "example": "SKCN8ZR5S8NKGK82" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "Cancelled" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "raw_response": { "type": "object", "properties": { "additionalData": { "type": "object", "properties": { "threeds2.cardEnrolled": { "type": "string", "example": "false" } } }, "merchantReference": { "type": "string", "example": "VERIFY_CARD_9c298b36-b005-42ed-92e1-808b2a785e5f" }, "refusalReason": { "type": "string", "example": "FRAUD-CANCELLED" }, "refusalReasonCode": { "type": "string", "example": "22" }, "resultCode": { "type": "string", "example": "Cancelled" } } }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "third_party_transaction_id": {} } }, "created_at": { "type": "string", "example": "2023-09-04T16:37:55.482510Z" }, "updated_at": { "type": "string", "example": "2023-09-04T16:37:56.348742Z" } } } }, "metadata": { "type": "array", "description": "The custom key–value tags sent in `verify.metadata`, echoed from the internal verify payment.", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "order_ref" }, "value": { "type": "string", "example": "ABC-123" } } } } } } } }, "provider_data": { "type": "object", "description": "Additional data from the provider", "properties": { "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object" } } } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Direct Workflow" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/customers/{customer_id}/payment-methods/{payment_method_id}": { "get": { "summary": "Retrieve Enrolled Payment Method by Id", "description": "", "operationId": "retrieve-enrolled-payment-method-by-id-api", "parameters": [ { "name": "customer_id", "in": "path", "description": "The unique identifier of the customer, created using the [Create Customer](https://docs.y.uno/reference/create-customer) endpoint (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "payment_method_id", "in": "path", "description": "The unique identifier of the `payment_method`. This information was received as the `vaulted_token` by enrolling a payment method using [Enroll Payment Method](/reference/enroll-payment-method-api) (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "idempotency_key": "2ca58c6d-8794-4c8f-a2f6-bba4b7498b74", "id": "2fd6bf11-2129-4061-9c2a-34e196f89753", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "VISA ****1111", "description": "VISA ****1111", "type": "CARD", "category": "CARD", "country": "US", "status": "ENROLLED", "sub_status": null, "vaulted_token": "7ced7717-f860-4705-a376-58a714953de9", "action": "FORM", "redirect_url": null, "created_at": "2024-06-04T12:47:46.992602Z", "updated_at": "2024-06-04T12:47:46.992603Z", "enrollment": { "session": "", "sdk_required_action": false }, "provider": { "id": "YUNO", "type": "YUNO", "token": "e47299a5-269e-42a1-9be1-9f64e400413a", "provider_status": null }, "customer_payer": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "gender": "M", "date_of_birth": "1990-02-28", "document": { "document_number": "123456789", "document_type": "SSN" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001" } }, "card_data": { "iin": "41111111", "lfd": "1111", "expiration_month": 3, "expiration_year": 26, "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer": "JPMORGAN CHASE BANK N A", "issuer_code": null, "category": "CREDIT", "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "last_successfully_used": null, "last_successfully_used_at": null, "verify": { "vault_on_success": false, "payment": null }, "preferred": null } } }, "schema": { "type": "object", "properties": { "idempotency_key": { "type": "string", "example": "2ca58c6d-8794-4c8f-a2f6-bba4b7498b74" }, "id": { "type": "string", "example": "2fd6bf11-2129-4061-9c2a-34e196f89753" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "example": "VISA ****1111" }, "description": { "type": "string", "example": "VISA ****1111" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "ENROLLED" }, "sub_status": {}, "vaulted_token": { "type": "string", "example": "7ced7717-f860-4705-a376-58a714953de9" }, "action": { "type": "string", "example": "FORM" }, "redirect_url": {}, "created_at": { "type": "string", "example": "2024-06-04T12:47:46.992602Z" }, "updated_at": { "type": "string", "example": "2024-06-04T12:47:46.992603Z" }, "enrollment": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_required_action": { "type": "boolean", "example": false, "default": true } } }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO" }, "type": { "type": "string", "example": "YUNO" }, "token": { "type": "string", "example": "e47299a5-269e-42a1-9be1-9f64e400413a" }, "provider_status": {} } }, "customer_payer": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "document": { "type": "object", "properties": { "document_number": { "type": "string", "example": "123456789" }, "document_type": { "type": "string", "example": "SSN" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" } } } } }, "card_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "security_code_expires_in": { "type": "integer", "example": 842, "description": "Seconds left before the stored security code stops being available to the PCI forward proxy. Returns -1 once that window has closed, and is omitted entirely when the card carries no security code. Only present for organizations with the PCI forward proxy enabled." }, "brand": { "type": "string", "example": "VISA" }, "issuer": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" } } }, "last_successfully_used": {}, "last_successfully_used_at": {}, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": false, "default": true }, "payment": {} } }, "preferred": {}, "provider_data": { "type": "object", "description": "Additional data from the provider", "properties": { "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } }, "Customer Not Found": { "value": { "code": "CUSTOMER_NOT_FOUND", "messages": [ "Customer not found" ] }, "summary": "Customer Not Found" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Direct Workflow" ] } }, "/customers/{customer_id}/payment-methods/{payment_method_id}/unenroll": { "post": { "summary": "Unenroll Payment Method", "description": "", "operationId": "unenroll-payment-method-api", "parameters": [ { "name": "customer_id", "in": "path", "description": "The unique identifier of the customer (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "payment_method_id", "in": "path", "description": "The unique identifier of the payment method. This is the `vaulted_token` received when enrolling a payment method using [Enroll Payment Method](/reference/enroll-payment-method-api) (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "cbdcc878-ceb4-4dd8-b0f0-49d444855de0", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "VISA ****1111", "description": "VISA ****1111", "type": "CARD", "category": "CARD", "country": "US", "status": "UNENROLLED", "created_at": "2024-06-06T13:32:49.715656Z", "updated_at": "2024-06-06T13:37:38.891106Z", "enrollment": { "session": "", "sdk_required_action": true }, "provider": { "id": "YUNO", "type": "YUNO", "provider_status": null }, "verify": { "vault_on_success": false, "payment": null }, "preferred": null } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "cbdcc878-ceb4-4dd8-b0f0-49d444855de0" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "example": "VISA ****1111" }, "description": { "type": "string", "example": "VISA ****1111" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "UNENROLLED" }, "created_at": { "type": "string", "example": "2024-06-06T13:32:49.715656Z" }, "updated_at": { "type": "string", "example": "2024-06-06T13:37:38.891106Z" }, "enrollment": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_required_action": { "type": "boolean", "example": true, "default": true } } }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO" }, "type": { "type": "string", "example": "YUNO" }, "provider_status": {} } }, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": false, "default": true }, "payment": {} } }, "preferred": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Direct Workflow" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/dry-run/provider-events": { "post": { "operationId": "registerDryRunProviderEvent", "summary": "Register provider request / response / webhook payloads", "description": "Stores the HTTP traffic that the merchant exchanged directly with a payment\nprovider (request, response, and webhook) for correlation to a Yuno payment.\n", "parameters": [ { "in": "header", "name": "PUBLIC-API-KEY", "schema": { "type": "string" }, "description": "Public API key. One of PUBLIC-API-KEY / PRIVATE-SECRET-KEY required." }, { "in": "header", "name": "PRIVATE-SECRET-KEY", "schema": { "type": "string" }, "description": "Private secret key for server-to-server calls. One of PUBLIC-API-KEY / PRIVATE-SECRET-KEY required." }, { "in": "header", "name": "X-Idempotency-Key", "schema": { "type": "string", "maxLength": 64 }, "description": "Free-form string (MAX 64). 24-hour replay window." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DryRunRequest" } } } }, "responses": { "201": { "description": "Dry-run registered", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DryRunResponse" } } } }, "400": { "description": "Validation failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Payment not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency replay with a different payload" }, "413": { "description": "Payload or batch exceeds size limits" }, "415": { "description": "Unsupported Content-Type (must be application/json)" }, "429": { "description": "Rate limit exceeded" } }, "tags": [ "Dry Run" ] } }, "/installments-plans": { "get": { "summary": "Get Installments Plans", "description": "", "operationId": "get-installments-plan-by-account", "parameters": [ { "name": "account_id", "in": "query", "description": "The unique identifier of the account. Find it on the [Yuno dashboard](https://dashboard.y.uno) (UUID; 36 chars).", "required": true, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency used for filtering plans ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217); 3 chars).", "schema": { "type": "string" } }, { "name": "iin", "in": "query", "description": "[Optional] - The issuer identification number (IIN) refers to the first few digits of a payment card number issued by a financial institution (MAX 8; MIN 6). In case you defined an iin for the installments plan, you can use it to filter the response.", "schema": { "type": "string" } }, { "name": "amount", "in": "query", "description": "[Optional] - The amount that the installment plan is available for. In case you defined an amount range for the installments plan, you can use it to filter the response.", "schema": { "type": "string" } }, { "name": "payment_method_type", "in": "query", "description": "[Optional] - Filter by payment method type (CARD | NU_PAY_ENROLLMENT).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": [ { "id": "4d573425-33f9-4c46-b009-2c7e749b0ec7", "name": "plan_007", "account_id": [ "f7c5fe77-721b-49c2-84d3-957748df3c2c" ], "merchant_reference": "Test", "installments_plan": [ { "installment": 1, "rate": 1, "provider_id": "", "amount": { "currency": "USD", "value": "0", "total_value": "0" } }, { "installment": 3, "rate": 1, "provider_id": "", "financial_costs": [ { "type": "CFT", "rate": 45.25, "formatted_value": "45,25%" }, { "type": "TEA", "rate": 38.5, "formatted_value": "38,50%" } ], "amount": { "currency": "USD", "value": "0", "total_value": "0" } }, { "installment": 6, "rate": 1, "provider_id": "", "amount": { "currency": "USD", "value": "0", "total_value": "0" } }, { "installment": 9, "rate": 1, "provider_id": "", "amount": { "currency": "USD", "value": "0", "total_value": "0" } }, { "installment": 12, "rate": 1, "provider_id": "", "amount": { "currency": "USD", "value": "0", "total_value": "0" } } ], "iin": null, "country_code": "US", "first_installment_deferral": 0, "amount": { "Currency": "USD", "min_value": 0, "max_value": 100000000 }, "availability": { "start_at": "2023-09-12T00:00:00Z", "finish_at": "2030-09-20T00:00:00Z" }, "created_at": "2023-10-11T17:52:31.886178Z", "updated_at": "2023-10-11T17:52:31.886178Z", "payment_method_type": "NU_PAY_ENROLLMENT" } ] } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "4d573425-33f9-4c46-b009-2c7e749b0ec7" }, "name": { "type": "string", "example": "plan_007" }, "account_id": { "type": "array", "items": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" } }, "merchant_reference": { "type": "string", "example": "Test" }, "installments_plan": { "type": "array", "items": { "type": "object", "properties": { "installment": { "type": "integer", "example": 1, "default": 0 }, "rate": { "type": "integer", "example": 1, "default": 0 }, "provider_id": { "type": "string", "example": "" }, "financial_costs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CFT", "TEA", "CET", "CAT" ] }, "rate": { "type": "number", "format": "float" }, "formatted_value": { "type": "string" } } } }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "string", "example": "0" }, "total_value": { "type": "string", "example": "0" } } } } } }, "iin": {}, "country_code": { "type": "string", "example": "US" }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "amount": { "type": "object", "properties": { "Currency": { "type": "string", "example": "USD" }, "min_value": { "type": "integer", "example": 0, "default": 0 }, "max_value": { "type": "integer", "example": 100000000, "default": 0 } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2023-09-12T00:00:00Z" }, "finish_at": { "type": "string", "example": "2030-09-20T00:00:00Z" } } }, "created_at": { "type": "string", "example": "2023-10-11T17:52:31.886178Z" }, "updated_at": { "type": "string", "example": "2023-10-11T17:52:31.886178Z" }, "payment_method_type": { "type": "string", "enum": [ "CARD", "NU_PAY_ENROLLMENT", "APPLE_PAY" ], "example": "NU_PAY_ENROLLMENT" } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Installments" ] }, "post": { "summary": "Create Installments Plan", "description": "", "operationId": "create-installments-plan", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "account_id", "merchant_reference", "installments_plan" ], "properties": { "name": { "type": "string", "description": "The installment plan name (MAX 255; MIN 3)" }, "account_id": { "type": "array", "description": "The unique identifier(s) of the account(s) that will have the installment plan (UUID; 36 chars).", "default": "{{account_id}}", "items": { "type": "string" } }, "merchant_reference": { "type": "string", "description": "Identification of the installment plan (MAX 255; MIN 3)" }, "installments_plan": { "type": "array", "description": "Definition of installments available for each scenario", "items": { "properties": { "installment": { "type": "integer", "description": "The number of monthly installments shoppers can choose", "format": "int32" }, "rate": { "type": "number", "description": "The rate applied to the final amount of the transaction by the payment provider after using installments. The value should be entered as a multiplier, not a percentage. For example, to apply a 20% rate, enter `1.20` instead of `20`.", "format": "float" }, "financial_costs": { "type": "array", "description": "Optional financial costs details for this installment option.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The financial cost type identifier (MIN 3; MAX 255).\n\n
Example: `CFT`, `TEA`, `CET`, `CAT`" }, "rate": { "type": "number", "description": "The financial cost rate as a decimal number (e.g., 45.25 for 45.25%).", "minimum": 0, "maximum": 100000, "format": "float", "default": "" } }, "required": [ "type", "rate" ] } }, "type": { "type": "string", "description": "Installment’s type. Only available for Ecuador and Mexico. Merchant refers to payments deferred with interest, and Issuer refer to payments deferred without interest", "enum": [ "MERCHANT_INSTALLMENTS", "ISSUER_INSTALLMENTS" ] } }, "required": [ "installment" ], "type": "object" } }, "country_code": { "type": "string", "description": "The issuer's country (ISO 3166-1 MAX 2; MIN 2)" }, "brand": { "type": "array", "description": "Card’s [brand](brands) information (MAX 255; MIN 3).", "items": { "type": "string" } }, "issuer": { "type": "string", "description": "Card issuer (MAX 255; MIN 3)" }, "iin": { "type": "array", "description": "The issuer identification number (IIN) refers to the first few digits of a payment card number issued by a financial institution (MAX 8; MIN 6)", "items": { "type": "string" } }, "first_installment_deferral": { "type": "integer", "description": "The amount of months to wait to debit the first installment (MAX: 3).", "format": "int32" }, "amount": { "type": "object", "description": "The amounts that the installment plan will be available for. If null, available for any amount.", "required": [ "currency" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment (ISO 4217 MAX 3; MIN 3)" }, "min_value": { "type": "number", "description": "The minimum amount the installment plan will be available to use (multiple of 0.0001).", "format": "float" }, "max_value": { "type": "number", "description": "The maximum amount the installment plan will be available to use (multiple of 0.0001).", "format": "float" } } }, "availability": { "type": "object", "description": "The dates that the installment plan will be available for. If null then it does not have a finish date", "properties": { "start_at": { "type": "string", "description": "The start date that the installment plan will be available to use (UTC format)", "format": "date-time" }, "finish_at": { "type": "string", "description": "The end date until the installment plan will be available to use (UTC format)", "format": "date-time" } } }, "payment_method_type": { "type": "string", "description": "Allows specifying the payment method type when creating an installment plan. `CARD` matches by card IIN, while `NU_PAY_ENROLLMENT` and `APPLE_PAY` match without one. Plans are only offered to the payment method they were created for.", "enum": [ "CARD", "NU_PAY_ENROLLMENT", "APPLE_PAY" ] } } }, "examples": { "Request Example": { "value": { "name": "plan_007", "account_id": [ "{{account-code}}" ], "merchant_reference": "Test", "installments_plan": [ { "installment": 1, "rate": 1 }, { "installment": 3, "rate": 1, "financial_costs": [ { "type": "CFT", "rate": 45.25 }, { "type": "TEA", "rate": 38.5 } ] }, { "installment": 6, "rate": 1 }, { "installment": 9, "rate": 1 }, { "installment": 12, "rate": 1 } ], "country_code": "CO", "amount": { "currency": "COP", "min_value": 0, "max_value": 100000000 }, "availability": { "start_at": "2023-09-12T00:00:00Z", "finish_at": "2030-09-20T00:00:00Z" }, "payment_method_type": "NU_PAY_ENROLLMENT" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "4d573425-33f9-4c46-b009-2c7e749b0ec7", "name": "plan_007", "account_id": [ "f7c5fe77-721b-49c2-84d3-957748df3c2c" ], "merchant_reference": "Test", "installments_plan": [ { "installment": 1, "rate": 1, "provider_id": "" }, { "installment": 3, "rate": 1, "provider_id": "", "financial_costs": [ { "type": "CFT", "rate": 45.25, "formatted_value": "45,25%" }, { "type": "TEA", "rate": 38.5, "formatted_value": "38,50%" } ] }, { "installment": 6, "rate": 1, "provider_id": "" }, { "installment": 9, "rate": 1, "provider_id": "" }, { "installment": 12, "rate": 1, "provider_id": "" } ], "type": "", "source": "", "provider_id": "", "scheme": "", "brand": [ "VISA" ], "issuer": "", "issuer_id": "", "iin": null, "country_code": "US", "first_installment_deferral": 0, "amount": { "Currency": "USD", "min_value": 0, "max_value": 100000000 }, "availability": { "start_at": "2023-09-12T00:00:00Z", "finish_at": "2030-09-20T00:00:00Z" }, "payment_method_type": "NU_PAY_ENROLLMENT", "created_at": "2023-10-11T17:52:31.886178246Z", "updated_at": "2023-10-11T17:52:31.886178246Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "4d573425-33f9-4c46-b009-2c7e749b0ec7" }, "name": { "type": "string", "example": "plan_007" }, "account_id": { "type": "array", "items": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" } }, "merchant_reference": { "type": "string", "example": "Test" }, "installments_plan": { "type": "array", "items": { "type": "object", "properties": { "installment": { "type": "integer", "example": 1, "default": 0 }, "rate": { "type": "integer", "example": 1, "default": 0 }, "provider_id": { "type": "string", "example": "" }, "financial_costs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CFT", "TEA", "CET", "CAT" ] }, "rate": { "type": "number", "format": "float" }, "formatted_value": { "type": "string" } } } } } } }, "type": { "type": "string", "example": "" }, "source": { "type": "string", "example": "" }, "provider_id": { "type": "string", "example": "" }, "scheme": { "type": "string", "example": "" }, "brand": { "type": "array", "items": { "type": "string", "example": "VISA" } }, "issuer": { "type": "string", "example": "" }, "issuer_id": { "type": "string", "example": "" }, "iin": {}, "country_code": { "type": "string", "example": "US" }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "amount": { "type": "object", "properties": { "Currency": { "type": "string", "example": "USD" }, "min_value": { "type": "integer", "example": 0, "default": 0 }, "max_value": { "type": "integer", "example": 100000000, "default": 0 } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2023-09-12T00:00:00Z" }, "finish_at": { "type": "string", "example": "2030-09-20T00:00:00Z" } } }, "created_at": { "type": "string", "example": "2023-10-11T17:52:31.886178246Z" }, "updated_at": { "type": "string", "example": "2023-10-11T17:52:31.886178246Z" }, "payment_method_type": { "type": "string", "enum": [ "CARD", "NU_PAY_ENROLLMENT", "APPLE_PAY" ], "example": "NU_PAY_ENROLLMENT" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Installments" ] } }, "/installments-plans/{installment_code}": { "get": { "summary": "Get Installments Plan by ID", "description": "", "operationId": "get-installments-plan", "parameters": [ { "name": "installment_code", "in": "path", "description": "Identifier of the installment plan.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": [ { "id": "4d573425-33f9-4c46-b009-2c7e749b0ec7", "name": "plan_007", "account_id": [ "f7c5fe77-721b-49c2-84d3-957748df3c2c" ], "merchant_reference": "Test", "installments_plan": [ { "installment": 1, "rate": 1, "provider_id": "", "amount": { "currency": "USD", "value": "0", "total_value": "0" } }, { "installment": 3, "rate": 1, "provider_id": "", "financial_costs": [ { "type": "CFT", "rate": 45.25, "formatted_value": "45,25%" }, { "type": "TEA", "rate": 38.5, "formatted_value": "38,50%" } ], "amount": { "currency": "USD", "value": "0", "total_value": "0" } }, { "installment": 6, "rate": 1, "provider_id": "", "amount": { "currency": "USD", "value": "0", "total_value": "0" } }, { "installment": 9, "rate": 1, "provider_id": "", "amount": { "currency": "USD", "value": "0", "total_value": "0" } }, { "installment": 12, "rate": 1, "provider_id": "", "amount": { "currency": "USD", "value": "0", "total_value": "0" } } ], "iin": null, "country_code": "US", "first_installment_deferral": 0, "amount": { "Currency": "USD", "min_value": 0, "max_value": 100000000 }, "availability": { "start_at": "2023-09-12T00:00:00Z", "finish_at": "2030-09-20T00:00:00Z" }, "created_at": "2023-10-11T17:52:31.886178Z", "updated_at": "2023-10-11T17:52:31.886178Z", "payment_method_type": "NU_PAY_ENROLLMENT" } ] } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "4d573425-33f9-4c46-b009-2c7e749b0ec7" }, "name": { "type": "string", "example": "plan_007" }, "account_id": { "type": "array", "items": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" } }, "merchant_reference": { "type": "string", "example": "Test" }, "installments_plan": { "type": "array", "items": { "type": "object", "properties": { "installment": { "type": "integer", "example": 1, "default": 0 }, "rate": { "type": "integer", "example": 1, "default": 0 }, "provider_id": { "type": "string", "example": "" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "string", "example": "0" }, "total_value": { "type": "string", "example": "0" } } } } } }, "iin": {}, "country_code": { "type": "string", "example": "US" }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "amount": { "type": "object", "properties": { "Currency": { "type": "string", "example": "USD" }, "min_value": { "type": "integer", "example": 0, "default": 0 }, "max_value": { "type": "integer", "example": 100000000, "default": 0 } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2023-09-12T00:00:00Z" }, "finish_at": { "type": "string", "example": "2030-09-20T00:00:00Z" } } }, "created_at": { "type": "string", "example": "2023-10-11T17:52:31.886178Z" }, "updated_at": { "type": "string", "example": "2023-10-11T17:52:31.886178Z" }, "payment_method_type": { "type": "string", "enum": [ "CARD", "NU_PAY_ENROLLMENT", "APPLE_PAY" ], "example": "NU_PAY_ENROLLMENT" } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": {} } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Installments" ] }, "patch": { "summary": "Update Plan", "description": "", "operationId": "update-plan", "parameters": [ { "name": "installment_code", "in": "path", "description": "The unique identifier of the installment plan.", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The installment plan name (MAX 255; MIN 3)" }, "account_id": { "type": "array", "description": "The unique identifier of Yuno's account that will have the installment plan available to use (MAX 64 ; MIN 36).", "items": { "type": "string" } }, "merchant_reference": { "type": "string", "description": "Identification of the installment plan (MAX 255; MIN 3)" }, "installments_plan": { "type": "array", "description": "Definition of installments available for each scenario", "items": { "properties": { "installment": { "type": "integer", "description": "The number of monthly installments shoppers can choose", "format": "int32" }, "rate": { "type": "number", "description": "The rate applied to the final amount of the transaction by the payment provider after using installments. The value should be entered as a multiplier, not a percentage. For example, to apply a 20% rate, enter `1.20` instead of `20`.", "format": "float" }, "financial_costs": { "type": "array", "description": "Optional financial costs details for this installment option.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The financial cost type identifier (MIN 3; MAX 255).\n\n
Example: `CFT`, `TEA`, `CET`, `CAT`" }, "rate": { "type": "number", "description": "The financial cost rate as a decimal number (e.g., 45.25 for 45.25%).", "minimum": 0, "maximum": 100000, "format": "float", "default": "" } }, "required": [ "type", "rate" ] } }, "type": { "type": "string", "description": "Installment’s type. Only available for Ecuador and Mexico. Merchant refers to payments deferred with interest, and Issuer refer to payments deferred without interest", "enum": [ "MERCHANT_INSTALLMENTS", "ISSUER_INSTALLMENTS" ] } }, "required": [ "installment", "rate" ], "type": "object" } }, "country_code": { "type": "string", "description": "The issuer's country (ISO 3166-1 MAX 2; MIN 2)" }, "scheme": { "type": "string", "description": "Card’s scheme information. (MAX 255; MIN 3)" }, "brand": { "type": "array", "description": "Card’s [brand](brands) information (MAX 255; MIN 3).", "items": { "type": "string" } }, "issuer": { "type": "string", "description": "Card issuer (MAX 255; MIN 3)" }, "iin": { "type": "array", "description": "The issuer identification number (IIN) refers to the first few digits of a payment card number issued by a financial institution (MAX 8; MIN 6)", "items": { "type": "string" } }, "first_installment_deferral": { "type": "integer", "description": "The amount of months to wait to debit the first installment Mas:3", "format": "int32" }, "amount": { "type": "object", "description": "The amounts that the installment plan will be available for. If null, available for any amount.", "required": [ "currency" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment (ISO 4217 MAX 3; MIN 3)" }, "min_value": { "type": "number", "description": "The minimum amount the installment plan will be available to use (multiple of 0.0001).", "format": "float" }, "max_value": { "type": "number", "description": "The maximum amount the installment plan will be available to use (multiple of 0.0001).", "format": "float" } } }, "availability": { "type": "object", "description": "The dates that the installment plan will be available for. If null then it does not have a finish date", "required": [ "start_at", "finish_at" ], "properties": { "start_at": { "type": "string", "description": "The start date that the installment plan will be available to use", "format": "date-time" }, "finish_at": { "type": "string", "description": "The end date until the installment plan will be available to use.", "format": "date-time" } } } } }, "examples": { "Update Plan": { "summary": "Update Plan", "value": { "name": "Plan Update", "account_id": [ "{{account_id}}" ], "merchant_reference": "REF01", "installments_plan": [ { "installment": 3, "rate": 1.05, "financial_costs": [ { "type": "CFT", "rate": 15.5 } ], "type": "MERCHANT_INSTALLMENTS" }, { "installment": 6, "rate": 1.1 }, { "installment": 12, "rate": 1.2 } ], "country_code": "US", "scheme": "VISA", "brand": [ "VISA", "MASTERCARD" ], "issuer": "JPMORGAN CHASE BANK", "iin": [ "411111", "542418" ], "first_installment_deferral": 1, "amount": { "currency": "USD", "min_value": 50, "max_value": 10000 }, "availability": { "start_at": "2024-01-01T00:00:00.000Z", "finish_at": "2024-12-31T23:59:59.999Z" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "4d573425-33f9-4c46-b009-2c7e749b0ec7", "name": "plan_007", "account_id": [ "f7c5fe77-721b-49c2-84d3-957748df3c2c" ], "merchant_reference": "Test", "installments_plan": [ { "installment": 1, "rate": 1, "provider_id": "" }, { "installment": 3, "rate": 1, "provider_id": "", "financial_costs": [ { "type": "CFT", "rate": 45.25, "formatted_value": "45,25%" }, { "type": "TEA", "rate": 38.5, "formatted_value": "38,50%" } ] }, { "installment": 6, "rate": 1, "provider_id": "" }, { "installment": 9, "rate": 1, "provider_id": "" }, { "installment": 12, "rate": 1, "provider_id": "" } ], "type": "", "source": "", "provider_id": "", "scheme": "", "brand": [ "VISA" ], "issuer": "", "issuer_id": "", "iin": null, "country_code": "US", "first_installment_deferral": 0, "amount": { "Currency": "USD", "min_value": 0, "max_value": 100000000 }, "availability": { "start_at": "2023-09-12T00:00:00Z", "finish_at": "2030-09-20T00:00:00Z" }, "created_at": "2023-10-11T17:52:31.886178246Z", "updated_at": "2023-10-11T17:52:31.886178246Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "4d573425-33f9-4c46-b009-2c7e749b0ec7" }, "name": { "type": "string", "example": "plan_007" }, "account_id": { "type": "array", "items": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" } }, "merchant_reference": { "type": "string", "example": "Test" }, "installments_plan": { "type": "array", "items": { "type": "object", "properties": { "installment": { "type": "integer", "example": 1, "default": 0 }, "rate": { "type": "integer", "example": 1, "default": 0 }, "provider_id": { "type": "string", "example": "" }, "financial_costs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CFT", "TEA", "CET", "CAT" ] }, "rate": { "type": "number", "format": "float" }, "formatted_value": { "type": "string" } } } } } } }, "type": { "type": "string", "example": "" }, "source": { "type": "string", "example": "" }, "provider_id": { "type": "string", "example": "" }, "scheme": { "type": "string", "example": "" }, "brand": { "type": "array", "items": { "type": "string", "example": "VISA" } }, "issuer": { "type": "string", "example": "" }, "issuer_id": { "type": "string", "example": "" }, "iin": {}, "country_code": { "type": "string", "example": "US" }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "amount": { "type": "object", "properties": { "Currency": { "type": "string", "example": "USD" }, "min_value": { "type": "integer", "example": 0, "default": 0 }, "max_value": { "type": "integer", "example": 100000000, "default": 0 } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2023-09-12T00:00:00Z" }, "finish_at": { "type": "string", "example": "2030-09-20T00:00:00Z" } } }, "created_at": { "type": "string", "example": "2023-10-11T17:52:31.886178246Z" }, "updated_at": { "type": "string", "example": "2023-10-11T17:52:31.886178246Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": {} } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Installments" ] }, "delete": { "summary": "Delete Installments Plan", "description": "", "operationId": "delete-installments-plan-by-id", "parameters": [ { "name": "installment_code", "in": "path", "description": "Identifier of the installment plan.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Response": { "value": "HTTP 201 Created" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Installments" ] } }, "/issuers": { "get": { "summary": "Retrieve Issuers", "description": "", "operationId": "retrieve-issuers", "parameters": [ { "name": "checkout_session", "in": "query", "description": "The checkout session identifier (UUID, 36 chars).", "schema": { "type": "string" } }, { "name": "country_code", "in": "query", "description": "Country code ([ISO 3166-1](/docs/quickstart)).", "schema": { "type": "string" } }, { "name": "payment_method", "in": "query", "description": "Defines the payment method used to filter issuers. This parameter ensures the response includes only issuers that support the specified payment method", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "issuers": [ { "id": "1001", "name": "BANCO DE BOGOTÁ" }, { "id": "1002", "name": "BANCO POPULAR" }, { "id": "1005", "name": "BANCO UNIÓN COLOMBIANO FD2" }, { "id": "1006", "name": "ITAÚ" }, { "id": "1007", "name": "BANCOLOMBIA" }, { "id": "1009", "name": "CITIBANK" }, { "id": "1012", "name": "BANCO GNB SUDAMERIS" }, { "id": "1013", "name": "BBVA COLOMBIA S.A." }, { "id": "1019", "name": "SCOTIABANK COLPATRIA DESARROLLO" }, { "id": "1022", "name": "BANCO UNIÓN COLOMBIANO" }, { "id": "1023", "name": "BANCO DE OCCIDENTE" }, { "id": "1032", "name": "BANCO CAJA SOCIAL DESARROLLO" }, { "id": "1040", "name": "BANCO AGRARIO" }, { "id": "1051", "name": "BANCO DAVIVIENDA" }, { "id": "1052", "name": "BANCO COMERCIAL AV VILLAS S.A." }, { "id": "1059", "name": "BANCAMÍA" }, { "id": "1060", "name": "BANCO PICHINCHA S.A." }, { "id": "1061", "name": "BANCO COOMEVA S.A." }, { "id": "1062", "name": "BANCO FALABELLA" }, { "id": "1063", "name": "BANCO FINANDINA S.A. BIC" }, { "id": "1065", "name": "BANCO SANTANDER COLOMBIA" }, { "id": "1066", "name": "BANCO COOPERATIVO COOPCENTRAL" }, { "id": "1069", "name": "BANCO SERFINANZA" }, { "id": "1070", "name": "LULO BANK" }, { "id": "1078", "name": "SCOTIABANK COLPATRIA UAT" }, { "id": "1097", "name": "DALE" }, { "id": "1283", "name": "COOPERATIVA FINANCIERA DE ANTIOQUIA CFA" }, { "id": "1289", "name": "COOPERATIVA FINANCIERA COTRAFA" }, { "id": "1291", "name": "COOFINEP COOPERATIVA FINANCIERA" }, { "id": "1292", "name": "CONFIAR COOPERATIVA FINANCIERA" }, { "id": "1370", "name": "COLTEFINANCIERA" }, { "id": "1637", "name": "IRIS" }, { "id": "1801", "name": "MOVII S.A." }, { "id": "1802", "name": "DING TECNIPAGOS S.A." }, { "id": "1803", "name": "POWWI" }, { "id": "1804", "name": "UALÁ" }, { "id": "1808", "name": "BOLD CF" }, { "id": "1809", "name": "NU" }, { "id": "1811", "name": "RAPPIPAY" }, { "id": "1812", "name": "COINK S.A." } ] } } }, "schema": { "type": "object", "properties": { "issuers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "1001" }, "name": { "type": "string", "example": "BANCO DE BOGOTÁ" } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] }, "summary": "Invalid Request" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Payments" ] } }, "/network-tokens/cryptograms": { "post": { "summary": "Generate Network Token Cryptogram", "description": "Generates a fresh, single-use network token cryptogram for a vaulted card, so it can be authorized on an external PSP. By default the response also includes the card's current network token (DPAN), which requires PCI certification; with `include_network_token: false` the response is cryptogram-only and does not.", "operationId": "generate-network-token-cryptogram", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "vaulted_token", "country" ], "properties": { "vaulted_token": { "type": "string", "format": "uuid", "description": "The vaulted token of the card, the same identifier used as `payment_method.vaulted_token` in [Create Payment](https://docs.y.uno/reference/create-payment). The card must be an enrolled card of your organization with an active network token.", "examples": [ "9b2f4b1c-7f3a-4c2e-9b1a-2b3c4d5e6f70" ] }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code where the token will be used. Resolves the network token onboarding (organization + brand + country), with the same semantics as `country` in Create Payment.", "examples": [ "US" ] }, "amount": { "type": "object", "description": "Optional. Forwarded to the scheme; recommended, as some scheme flows bind the amount.", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code.", "examples": [ "USD" ] }, "value": { "type": "number", "description": "Amount value in the given currency.", "examples": [ 49.99 ] } } }, "include_network_token": { "type": "boolean", "default": true, "description": "Optional. Whether the response includes the PAN-equivalent parts of the network token: `network_token.number` (the DPAN) and `network_token.token_data`. Defaults to `true`, which requires your organization to be a PCI-certified merchant. Send `false` for a cryptogram-only response with no PAN-equivalent data (the `network_token` object keeps `network`, `status`, `par` and `network_token_id`) — available without PCI certification, designed to pair with the [Forward Proxy](https://docs.y.uno/docs/security-and-compliance/pci-proxy/forward-proxy), which resolves the DPAN at forward time via the `network_token_number` expression. A non-PCI organization that sends `true` or omits the field receives `403 NETWORK_TOKEN_RETURN_NOT_ALLOWED`.", "examples": [ false ] } } }, "examples": { "default": { "value": { "vaulted_token": "9b2f4b1c-7f3a-4c2e-9b1a-2b3c4d5e6f70", "country": "US", "amount": { "currency": "USD", "value": 49.99 } } }, "cryptogram_only": { "summary": "Cryptogram-only (no PCI certification required)", "value": { "vaulted_token": "9b2f4b1c-7f3a-4c2e-9b1a-2b3c4d5e6f70", "country": "US", "amount": { "currency": "USD", "value": 49.99 }, "include_network_token": false } } } } } }, "responses": { "201": { "description": "Cryptogram generated.", "content": { "application/json": { "schema": { "type": "object", "properties": { "vaulted_token": { "type": "string", "description": "Echo of the request's vaulted token." }, "network_token": { "type": "object", "description": "The card's current network token. Same shape returned by the PCI network-token retrieval. **When the request sets `include_network_token: false`, the `number` (DPAN) and `token_data` fields are omitted entirely** — the object keeps `network`, `status`, `par` and `network_token_id`.", "properties": { "network": { "type": "string", "description": "Card network.", "examples": [ "VISA" ] }, "number": { "type": "string", "description": "The current DPAN (device/network PAN). **Always submit this value with the returned `cryptogram`** — never a previously stored DPAN.", "examples": [ "4111111111111111" ] }, "status": { "type": [ "string", "null" ], "description": "Network token status.", "examples": [ "ACTIVE" ] }, "par": { "type": [ "string", "null" ], "description": "Payment Account Reference." }, "network_token_id": { "type": [ "string", "null" ], "description": "Network token identifier." }, "token_data": { "type": "object", "properties": { "iin": { "type": "string" }, "lfd": { "type": "string", "description": "Last four digits of the DPAN." }, "expiration_month": { "type": "integer", "examples": [ 7 ] }, "expiration_year": { "type": "integer", "examples": [ 2029 ] } } } } }, "cryptogram": { "type": "string", "description": "A fresh, single-use cryptogram from the scheme, generated on every call. Submit it together with `network_token.number` (DPAN) and `eci` to your PSP.", "examples": [ "AgAAAAAABk4DWZ4C28yUQAAAAAA=" ] }, "eci": { "type": [ "string", "null" ], "description": "Electronic Commerce Indicator. May be `null` for some Mastercard DSRP formats.", "examples": [ "05" ] }, "created_at": { "type": "string", "format": "date-time", "description": "Issuance timestamp (UTC)." } } }, "examples": { "default": { "value": { "vaulted_token": "9b2f4b1c-7f3a-4c2e-9b1a-2b3c4d5e6f70", "network_token": { "network": "VISA", "number": "4111111111111111", "status": "ACTIVE", "par": "V0010013022280191", "network_token_id": "DNITHE302344816910968", "token_data": { "iin": "411111", "lfd": "1111", "expiration_month": 7, "expiration_year": 2029 } }, "cryptogram": "AgAAAAAABk4DWZ4C28yUQAAAAAA=", "eci": "05", "created_at": "2026-07-16T14:32:10Z" } }, "cryptogram_only": { "summary": "Cryptogram-only (include_network_token: false)", "value": { "vaulted_token": "9b2f4b1c-7f3a-4c2e-9b1a-2b3c4d5e6f70", "network_token": { "network": "VISA", "status": "ACTIVE", "par": "V0010013022280191", "network_token_id": "DNITHE302344816910968" }, "cryptogram": "AgAAAAAABk4DWZ4C28yUQAAAAAA=", "eci": "05", "created_at": "2026-07-16T14:32:10Z" } } } } } }, "400": { "description": "Bad request — `INVALID_REQUEST`, `INSTRUMENT_NOT_TOKENIZABLE`, `PAYMENT_METHOD_NOT_ENROLLED`, `NETWORK_TOKEN_NOT_FOUND`, `TOKEN_NOT_ACTIVE`, `NETWORK_NOT_SUPPORTED`, or `COUNTRY_NOT_SUPPORTED`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "network_token_not_found": { "value": { "code": "NETWORK_TOKEN_NOT_FOUND", "messages": [ "Payment method has no network token." ] } } } } } }, "403": { "description": "Forbidden — `NETWORK_TOKEN_RETURN_NOT_ALLOWED` (organization is not PCI-certified and the request did not set `include_network_token: false`), `PCI_MERCHANT_REQUIRED` (organization is not a PCI-certified merchant), or `PRODUCT_NOT_ENABLED` (product flag is off for the organization).", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "network_token_return_not_allowed": { "value": { "code": "NETWORK_TOKEN_RETURN_NOT_ALLOWED", "messages": [ "Returning the network token requires PCI certification. Send include_network_token: false to receive the cryptogram only, or contact your Key Account Manager (KAM)." ] } }, "pci_merchant_required": { "value": { "code": "PCI_MERCHANT_REQUIRED", "messages": [ "This endpoint is only available to PCI-certified merchants." ] } } } } } }, "404": { "description": "Not found — `PAYMENT_METHOD_NOT_FOUND`. The `vaulted_token` does not exist or does not belong to your organization (identical response, no existence leak).", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "payment_method_not_found": { "value": { "code": "PAYMENT_METHOD_NOT_FOUND", "messages": [ "Payment method not found." ] } } } } } }, "502": { "description": "Provider error — `PROVIDER_ERROR`. The card scheme (Visa VTS / Mastercard MDES) could not be reached or returned an error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "provider_error": { "value": { "code": "PROVIDER_ERROR", "messages": [ "The network token cryptogram service is temporarily unavailable, please retry." ] } } } } } } }, "tags": [ "Network Tokens" ] } }, "/onboardings/{onboarding_id}/transfers": { "get": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK: Array of transfers (by most recent)": { "summary": "OK: Array of transfers (by most recent)", "value": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "origin_onboarding": { "id": "660e8400-e29b-41d4-a716-446655440001", "status": "TRANSFERRED", "type": "ONE_STEP_ONBOARDING", "workflow": "DIRECT", "provider": { "id": "STRIPE", "recipient_id": "acct_1234567890", "connection_id": "880e8400-e29b-41d4-a716-446655440003" }, "recipient": { "id": "770e8400-e29b-41d4-a716-446655440002", "merchant_recipient_id": "seller-123", "email": "seller@example.com" }, "created_at": "2026-01-15T10:00:00Z", "updated_at": "2026-01-15T16:59:22Z" }, "destination_onboarding": { "id": "990e8400-e29b-41d4-a716-446655440004", "status": "SUCCEEDED", "type": "ONE_STEP_ONBOARDING", "provider": { "id": "STRIPE", "recipient_id": "acct_0987654321", "connection_id": "880e8400-e29b-41d4-a716-446655440003" }, "recipient": { "id": "aa0e8400-e29b-41d4-a716-446655440005", "merchant_recipient_id": "seller-456", "email": "newseller@example.com" }, "created_at": "2026-01-15T16:59:22Z", "updated_at": "2026-01-15T16:59:23Z" }, "created_at": "2026-01-15T16:59:22.996009Z", "updated_at": "2026-01-15T16:59:23.734739Z" } ] } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "origin_onboarding": { "type": "object", "properties": { "id": { "type": "string", "example": "660e8400-e29b-41d4-a716-446655440001" }, "status": { "type": "string", "example": "TRANSFERRED" }, "type": { "type": "string", "example": "ONE_STEP_ONBOARDING" }, "workflow": { "type": "string", "example": "DIRECT" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "STRIPE" }, "recipient_id": { "type": "string", "example": "acct_1234567890" }, "connection_id": { "type": "string", "example": "880e8400-e29b-41d4-a716-446655440003" } } }, "recipient": { "type": "object", "properties": { "id": { "type": "string", "example": "770e8400-e29b-41d4-a716-446655440002" }, "merchant_recipient_id": { "type": "string", "example": "seller-123" }, "email": { "type": "string", "example": "seller@example.com" } } }, "created_at": { "type": "string", "example": "2026-01-15T10:00:00Z" }, "updated_at": { "type": "string", "example": "2026-01-15T16:59:22Z" } } }, "destination_onboarding": { "type": "object", "properties": { "id": { "type": "string", "example": "990e8400-e29b-41d4-a716-446655440004" }, "status": { "type": "string", "example": "SUCCEEDED" }, "type": { "type": "string", "example": "ONE_STEP_ONBOARDING" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "STRIPE" }, "recipient_id": { "type": "string", "example": "acct_0987654321" }, "connection_id": { "type": "string", "example": "880e8400-e29b-41d4-a716-446655440003" } } }, "recipient": { "type": "object", "properties": { "id": { "type": "string", "example": "aa0e8400-e29b-41d4-a716-446655440005" }, "merchant_recipient_id": { "type": "string", "example": "seller-456" }, "email": { "type": "string", "example": "newseller@example.com" } } }, "created_at": { "type": "string", "example": "2026-01-15T16:59:22Z" }, "updated_at": { "type": "string", "example": "2026-01-15T16:59:23Z" } } }, "created_at": { "type": "string", "example": "2026-01-15T16:59:22.996009Z" }, "updated_at": { "type": "string", "example": "2026-01-15T16:59:23.734739Z" } } } } } } }, "403": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "Forbidden: Onboarding belongs to different organization": { "summary": "Forbidden: Onboarding belongs to different organization", "value": { "code": "FORBIDDEN", "messages": [ "You do not have permission to access this resource." ] } } } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ONBOARDING_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Onboarding not found." } } } }, "examples": { "Not Found: Onboarding does not exist": { "summary": "Not Found: Onboarding does not exist", "value": { "code": "ONBOARDING_NOT_FOUND", "messages": [ "Onboarding not found." ] } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "onboarding_id", "schema": { "type": "string" }, "required": true, "description": "The onboarding `id` returned from the [create onboarding](/reference/create-onboarding) endpoint (UUID)." }, { "in": "header", "name": "x-account-code", "schema": { "type": "string" }, "description": "The `account_id` found in your [Yuno Dashboard](https://dashboard.y.uno/developers) (UUID)." } ], "operationId": "get_onboardings-onboarding-id-transfers", "tags": [ "Recipients For Marketplace" ] } }, "/organizations/account-groups": { "get": { "summary": "List Account Groups", "operationId": "list-account-groups", "description": "Lists all account groups for the authenticated organization.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "merchant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total_items": { "type": "integer" }, "total_pages": { "type": "integer" }, "has_next": { "type": "boolean" }, "has_previous": { "type": "boolean" } } } } } } } } }, "tags": [ "Organizations" ] }, "post": { "summary": "Create Account Group", "operationId": "create-account-group", "description": "Creates a new group (sub-organization).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "merchant_id" ], "properties": { "name": { "type": "string", "description": "Account group name (min=1, max=255)." }, "merchant_id": { "type": "string", "description": "Unique identifier used by the merchant in their systems (min=1, max=255)." } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the account group." }, "name": { "type": "string" }, "merchant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/account-groups/{account_group_id}": { "get": { "summary": "Retrieve Account Group", "operationId": "retrieve-account-group", "description": "Gets a specific account group by UUID.", "parameters": [ { "name": "account_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account group UUID." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "merchant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] }, "patch": { "summary": "Update Account Group", "operationId": "update-account-group", "description": "Updates an account group.", "parameters": [ { "name": "account_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account group UUID." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Account group name (min=1, max=255)." }, "merchant_id": { "type": "string", "description": "Local identifier (min=1, max=255)." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "merchant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] }, "delete": { "summary": "Delete Account Group", "operationId": "delete-account-group", "description": "Deletes an account group, the accounts are then assigned to a default group.", "parameters": [ { "name": "account_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account group UUID." } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "Organizations" ] } }, "/organizations/account-groups/{account_group_id}/accounts": { "get": { "summary": "List Accounts of Group", "operationId": "list-accounts-of-group", "description": "Get all accounts of an account group.", "parameters": [ { "name": "account_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account group UUID." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total_items": { "type": "integer" }, "total_pages": { "type": "integer" }, "has_next": { "type": "boolean" }, "has_previous": { "type": "boolean" } } } } } } } } }, "tags": [ "Organizations" ] }, "post": { "summary": "Create Account", "operationId": "create-account", "description": "Creates a new account under an account_group_id.", "parameters": [ { "name": "account_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The unique identifier of the account group." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Account name (min=1, max=255)." } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "account_group_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/accounts": { "get": { "summary": "List Accounts", "operationId": "list-accounts", "description": "Lists all accounts for the authenticated organization.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total_items": { "type": "integer" }, "total_pages": { "type": "integer" }, "has_next": { "type": "boolean" }, "has_previous": { "type": "boolean" } } } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/accounts/{account_id}": { "get": { "summary": "Retrieve Account", "operationId": "retrieve-account", "description": "Get a specific account by UUID.", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account UUID." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "account_group_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] }, "patch": { "summary": "Update Account", "operationId": "update-account", "description": "Updates an account.", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account UUID." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Account name (min=1, max=255)." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "account_group_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] }, "delete": { "summary": "Delete Account", "operationId": "delete-account", "description": "Disables an account.", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account UUID." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Account disabled successfully" } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/authenticate": { "post": { "summary": "Authenticate Whitelabel User", "operationId": "authenticate-whitelabel-user", "description": "Authenticates a whitelabel user and returns a JWT embed token.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "user_id" ], "properties": { "user_id": { "type": "string", "format": "uuid", "description": "UUID of the whitelabel user." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "JWT token for the whitelabel user." }, "token_type": { "type": "string", "example": "Bearer" }, "expires_in": { "type": "integer", "example": 86400 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_PARAMETERS" }, "message": { "type": "string", "example": "Missing or invalid user_id." } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "LOGIN_FAILED" }, "message": { "type": "string", "example": "Unable to authenticate the specified user." } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/permissions-catalog": { "get": { "summary": "List Permissions Catalog", "operationId": "list-permissions-catalog", "description": "Slim permissions catalog including sections and permissions.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "example": "Payments" }, "organization_only": { "type": "boolean" }, "permissions_catalog": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "view_payment_transactions" }, "title": { "type": "string", "example": "View payment transactions" }, "description": { "type": "string" }, "action_type": { "type": "string", "enum": [ "VIEW", "EDIT" ] } } } } } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/roles": { "get": { "summary": "List Roles", "operationId": "list-roles", "description": "List Yuno default and organization custom roles.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "rol_AbCdEfGhIjKl" }, "name": { "type": "string", "example": "Admin" }, "description": { "type": [ "string", "null" ] }, "admin": { "type": "boolean" }, "permission_ids": { "type": "array", "items": { "type": "string" } }, "testing_permission_ids": { "type": "array", "items": { "type": "string" } }, "role_type": { "type": "string", "enum": [ "account", "organization" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } } }, "tags": [ "Organizations" ] }, "post": { "summary": "Create Role", "operationId": "create-role", "description": "Create a custom role for the organization.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 255, "example": "Operator" }, "description": { "type": "string", "maxLength": 1024, "example": "Custom operator" }, "permission_ids": { "type": "array", "items": { "type": "string" }, "default": [] }, "testing_permission_ids": { "type": "array", "items": { "type": "string" }, "default": [] }, "role_type": { "type": "string", "enum": [ "account", "organization" ], "default": "account" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "admin": { "type": "boolean" }, "permission_ids": { "type": "array", "items": { "type": "string" } }, "testing_permission_ids": { "type": "array", "items": { "type": "string" } }, "role_type": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Bad Request - Duplicate name or validation failure" } }, "tags": [ "Organizations" ] } }, "/organizations/roles/{role_id}": { "patch": { "summary": "Update Role", "operationId": "update-role", "description": "Partial update of a custom role. Note: role_type is immutable.", "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the role." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "maxLength": 1024 }, "permission_ids": { "type": "array", "items": { "type": "string" } }, "testing_permission_ids": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "admin": { "type": "boolean" }, "permission_ids": { "type": "array", "items": { "type": "string" } }, "testing_permission_ids": { "type": "array", "items": { "type": "string" } }, "role_type": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Bad Request - Validation failure" }, "404": { "description": "Not Found - Role not found in organization" } }, "tags": [ "Organizations" ] }, "delete": { "summary": "Delete Role", "operationId": "delete-role", "description": "Delete a custom role. Users assigned to this role will be reassigned to ReadOnly.", "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the role to delete." } ], "responses": { "204": { "description": "No Content - Successfully deleted" } }, "tags": [ "Organizations" ] } }, "/organizations/users": { "get": { "summary": "List Users", "operationId": "list-users", "description": "Lists users. Optionally filter by account_group_id or account_id.", "parameters": [ { "name": "account_group_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filter by account group." }, { "name": "account_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filter by account." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number." }, { "name": "page_size", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 100 }, "description": "Page size." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "account_permissions": { "type": "array", "items": { "type": "object", "properties": { "account_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } }, "account_group_permissions": { "type": "array", "items": { "type": "object", "properties": { "account_group_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total_items": { "type": "integer" }, "total_pages": { "type": "integer" }, "has_next": { "type": "boolean" }, "has_previous": { "type": "boolean" } } } } } } } } }, "tags": [ "Organizations" ] }, "post": { "summary": "Create User", "operationId": "create-user", "description": "Creates a new user. Users created this way are not granted access to the Dashboard, and can only be authenticated using the [Authenticate Whitelabel User](/reference/organizations/authenticate-whitelabel-user) api. The user must be created with at least one permission assignment: either account_permissions, account_group_permissions, or both.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "first_name", "last_name" ], "properties": { "email": { "type": "string", "format": "email", "description": "User email address." }, "first_name": { "type": "string", "description": "First name." }, "last_name": { "type": "string", "description": "Last name." }, "account_permissions": { "type": "array", "description": "Direct account permission assignments.", "items": { "type": "object", "required": [ "account_id", "role_id" ], "properties": { "account_id": { "type": "string", "format": "uuid", "description": "Account UUID (must belong to the org)." }, "role_id": { "type": "string", "description": "Role ID (non-admin, non-staff, org-scoped)." } } } }, "account_group_permissions": { "type": "array", "description": "Account group permission assignments.", "items": { "type": "object", "required": [ "account_group_id", "role_id" ], "properties": { "account_group_id": { "type": "string", "format": "uuid", "description": "Account group UUID (must belong to the org)." }, "role_id": { "type": "string", "description": "Role ID (non-admin, non-staff, org-scoped)." } } } } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "account_permissions": { "type": "array", "items": { "type": "object", "properties": { "account_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } }, "account_group_permissions": { "type": "array", "items": { "type": "object", "properties": { "account_group_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/users/{user_id}": { "get": { "summary": "Retrieve User", "operationId": "retrieve-user", "description": "Get a specific user by UUID.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "account_permissions": { "type": "array", "items": { "type": "object", "properties": { "account_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } }, "account_group_permissions": { "type": "array", "items": { "type": "object", "properties": { "account_group_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] }, "patch": { "summary": "Update User", "operationId": "update-user", "description": "Updates a user.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name." }, "last_name": { "type": "string", "description": "Last name." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "account_permissions": { "type": "array", "items": { "type": "object", "properties": { "account_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } }, "account_group_permissions": { "type": "array", "items": { "type": "object", "properties": { "account_group_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } }, "tags": [ "Organizations" ] }, "delete": { "summary": "Delete User", "operationId": "delete-user", "description": "Deletes a user and its associated records.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "Organizations" ] } }, "/organizations/users/{user_id}/account-group-permissions": { "get": { "summary": "Retrieve User Account Group Permissions", "operationId": "retrieve-user-account-group-permissions", "description": "Returns all account group permission assignments for a user.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "object", "properties": { "account_group_id": { "type": "string", "format": "uuid" }, "account_group_name": { "type": "string" }, "role_id": { "type": "string" }, "role_name": { "type": "string" }, "accounts_count": { "type": "integer" } } } } } } } } } }, "tags": [ "Organizations" ] }, "put": { "summary": "Replace User Account Group Permissions", "operationId": "replace-user-account-group-permissions", "description": "Replaces all account group permission assignments for a user. Full replacement.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_group_permissions" ], "properties": { "account_group_permissions": { "type": "array", "items": { "type": "object", "required": [ "account_group_id", "role_id" ], "properties": { "account_group_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" } } } } } } }, "tags": [ "Organizations" ] }, "patch": { "summary": "Update User Account Group Permissions", "operationId": "update-user-account-group-permissions", "description": "Partially updates account group permissions. Adds or updates without removing existing ones.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_group_permissions" ], "properties": { "account_group_permissions": { "type": "array", "items": { "type": "object", "required": [ "account_group_id", "role_id" ], "properties": { "account_group_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "object", "properties": { "account_group_id": { "type": "string", "format": "uuid" }, "account_group_name": { "type": "string" }, "role_id": { "type": "string" }, "role_name": { "type": "string" }, "accounts_count": { "type": "integer" } } } } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/users/{user_id}/account-group-permissions/{account_group_id}": { "delete": { "summary": "Delete User Account Group Permission", "operationId": "delete-user-account-group-permission", "description": "Removes a specific account group permission from a user.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." }, { "name": "account_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account group UUID." } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "Organizations" ] } }, "/organizations/users/{user_id}/account-permissions": { "get": { "summary": "Retrieve User Account Permissions", "operationId": "retrieve-user-account-permissions", "description": "Returns all account permission assignments for a user.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "object", "properties": { "account_id": { "type": "string", "format": "uuid" }, "account_name": { "type": "string" }, "role_id": { "type": "string" }, "role_name": { "type": "string" } } } } } } } } } }, "tags": [ "Organizations" ] }, "put": { "summary": "Replace User Account Permissions", "operationId": "replace-user-account-permissions", "description": "Replaces all account permission assignments for a user. This is a full replacement.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_permissions" ], "properties": { "account_permissions": { "type": "array", "items": { "type": "object", "required": [ "account_id", "role_id" ], "properties": { "account_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" } } } } } } }, "tags": [ "Organizations" ] }, "patch": { "summary": "Update User Account Permissions", "operationId": "update-user-account-permissions", "description": "Partially updates account permissions. Adds or updates the specified entries without removing existing ones.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_permissions" ], "properties": { "account_permissions": { "type": "array", "items": { "type": "object", "required": [ "account_id", "role_id" ], "properties": { "account_id": { "type": "string", "format": "uuid" }, "role_id": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "object", "properties": { "account_id": { "type": "string", "format": "uuid" }, "account_name": { "type": "string" }, "role_id": { "type": "string" }, "role_name": { "type": "string" } } } } } } } } } }, "tags": [ "Organizations" ] } }, "/organizations/users/{user_id}/account-permissions/{account_id}": { "delete": { "summary": "Delete User Account Permission", "operationId": "delete-user-account-permission", "description": "Removes a specific account permission from a user.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "User UUID." }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account UUID." } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "Organizations" ] } }, "/payment-links": { "post": { "summary": "Create Payment Link", "description": "", "operationId": "create-payment-link", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "country", "amount", "payment_method_types" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on [the Yuno Dashboard](https://dashboard.y.uno/) (MAX 64; MIN 36)." }, "description": { "type": "string", "description": "The description of the payment link (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The customer's country code (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference)) **[Required]**.", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "merchant_order_id": { "type": "string", "description": "Identification of the payment link transaction defined by the merchant (MAX 255; MIN 3)." }, "amount": { "type": "object", "description": "Specifies the payment amount object, with the value and currency.", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The payment amount (multiple of 0.0001)", "format": "float" }, "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." } } }, "capture": { "type": "boolean", "description": "Decides whether to authorize the payment or capture it. Authorizing a card payment allows you to reserve funds in a customer's bank account. If not set, true by default." }, "type": { "type": "string", "description": "The type of the payment link." }, "status": { "type": "string", "description": "The status of the payment link." }, "payment_method": { "type": "object", "description": "Payment method object (optional)." }, "installments_plan": { "type": "object", "description": "Installments plan configuration (optional)." }, "timezone": { "type": "string", "description": "Timezone for availability (e.g., UTC +03:00)." }, "payments_number": { "type": "integer", "description": "Number of payments associated with this link." }, "split_payment_methods": { "type": "boolean", "description": "Allow split payment methods." }, "taxes": { "type": "array", "description": "Specifies the payment taxes list.", "items": { "properties": { "type": { "type": "string", "description": "Type of the tax." }, "tax_base": { "type": "number", "description": "The amount base to apply the tax defined.", "format": "float" }, "value": { "type": "number", "description": "The amount of the tax.", "format": "float" }, "percentage": { "type": "number", "description": "The percentage of the tax.", "format": "float" } }, "type": "object" } }, "customer_payer": { "type": "object", "description": "Specifies customer object for payments.", "properties": { "id": { "type": "string", "description": "The unique identifier of the customer (UUID | MAX 36; MIN 36)." }, "merchant_customer_id": { "type": "string", "description": "The unique identifier of the customer in the external merchant (MAX 255; MIN 3)." }, "first_name": { "type": "string", "description": "The customer's first name (MAX 255; MIN 1)." }, "last_name": { "type": "string", "description": "The customer's last name (MAX 255; MIN 1)." }, "gender": { "type": "string", "description": "The customer's gender (MAX 2; MIN 1; (M=Male/F=Female/NA=Not applicable/NK=Not Known))." }, "date_of_birth": { "type": "string", "description": "The customer's date of birth in the YYYY-MM-DD format (Length: 10)." }, "email": { "type": "string", "description": "The customer's e-mail (MAX 255; MIN 3)." }, "nationality": { "type": "string", "description": "The customer's nationality (MAX 2; MIN 2; ISO 3166-1)." }, "document": { "type": "object", "description": "Specifies the customer's document object, including its number and type.", "required": [ "document_number" ], "properties": { "document_number": { "type": "string", "description": "The document number (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "Document type (MAX 6; MIN 3; [Country reference](country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] } } }, "phone": { "type": "object", "description": "Specifies the customer's phone number object.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the phone (MAX 5; MIN 1). Check the [country reference](country-reference) to see the phone codes." }, "number": { "type": "string", "description": "The phone number, without the country code (MAX 32; MIN 1)." } } }, "billing_address": { "type": "object", "description": "Specifies the customer's billing address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary address line (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary address line (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state/province from the address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode for the address (MAX 10; MIN 5)." } } }, "shipping_address": { "type": "object", "description": "Specifies the customer's shipping address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary address line (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary address line (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state/province from the address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode for the address (MAX 10; MIN 5)." } } }, "ip_address": { "type": "string", "description": "Specifies the customer's IP address (MAX 45; MIN 1)." } } }, "additional_data": { "type": "object", "description": "Specifies the additional_data object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.", "properties": { "order": { "type": "object", "description": "Specifies the order object.", "properties": { "shipping_amount": { "type": "number", "description": "The shipping amount of the order (multiple of 0.0001)", "format": "float" }, "fee_amount": { "type": "number", "description": "The fee amount of the order (multiple of 0.0001)", "format": "float" }, "items": { "type": "array", "description": "Specifies the items array of object.", "items": { "properties": { "id": { "type": "string", "description": "The unique identifier of the item (MAX 255; MIN 1)." }, "name": { "type": "string", "description": "The name of the item (MAX 255; MIN 3)." }, "quantity": { "type": "integer", "description": "The quantity of the item.", "format": "int32" }, "unit_amount": { "type": "number", "description": "The unit amount of the item (multiple of 0.0001).", "format": "float" }, "category": { "type": "string", "description": "The category of the item. Check the Item category reference." }, "brand": { "type": "string", "description": "The brand of the item (MAX 255; MIN 1)." }, "sku_code": { "type": "string", "description": "The stock keeping unit (SKU) of the item (MAX 255; MIN 1)." }, "manufacture_part_number": { "type": "string", "description": "The manufacture part number of the item (MAX 255; MIN 1)." } }, "required": [ "id", "name", "quantity", "unit_amount" ], "type": "object" } } } }, "airline": { "type": "object", "description": "Specifies the airline object.", "properties": { "pnr": { "type": "string", "description": "Passenger name record (MAX 10; MIN 1)." }, "legs": { "type": "array", "description": "Specifies the legs object.", "items": { "properties": { "departure_airport": { "type": "string", "description": "IATA code. See http://www.iata.org (MAX 3; MIN 3)." }, "departure_datetime": { "type": "string", "description": "The departure date and time in UTC time (ISO 8601, MAX 27; MIN 27).", "format": "date" }, "departure_airport_timezone": { "type": "string", "description": "Airport timezone (MAX 6; MIN 6)." }, "arrival_airport": { "type": "string", "description": "IATA airport code. See http://www.iata.org (MAX 3; MIN 3)." }, "carrier_code": { "type": "string", "description": "IATA carrier code. See http://www.iata.org (MAX 2; MIN 2)." }, "flight_number": { "type": "string", "description": "The flight number assigned by the airline carrier (MAX 5; MIN 1)." }, "fare_basis_code": { "type": "string", "description": "Code base rate provides specific information on the fare in addition to the class service, both required for booking (MAX 15; MIN 1)." }, "fare_class_code": { "type": "string", "description": "The fare class code of the airline (MAX 3; MIN 1). The values can be letters (A-Z) but may vary depending on the airline's definition. Check the [Airline information reference](/reference/airline-information#fare-class-code)." }, "base_fare": { "type": "number", "description": "The transaction amount, excluding taxes and fees, the smallest unit of currency (multiple of 0.0001).", "format": "float" }, "base_fare_currency": { "type": "string", "description": "The currency used for the base fare amount (MAX 3; MIN 3; [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217))." }, "stopover_code": { "type": "string", "description": "1-letter code that indicates whether the passenger is allowed to make a stopover. Only two types of characters are allowed: O: Stopover allowed (the letter “O”, not zero) / X: Stopover not allowed. (MAX 1; MIN 1)." } }, "required": [ "departure_airport", "departure_datetime", "arrival_airport" ], "type": "object" } } } }, "device": { "type": "object", "description": "Specifies the device object.", "properties": { "locale": { "type": "string", "description": "The locale of the device (MAX 20; e.g. es-CL)." }, "geolocation": { "type": "string", "description": "The geolocation of the device in lat,long format (MAX 255)." }, "event_uuid": { "type": "string", "description": "The unique identifier of the event (MAX 64)." }, "user_agent": { "type": "string", "description": "The user agent of the device (MAX 512)." } } }, "payer_risk_data": { "type": "object", "description": "Specifies the payer risk data object.", "properties": { "login_platform": { "type": "string", "description": "The platform used to log in (MAX 64; e.g. WEB)." }, "approved_transactions_2m": { "type": "integer", "description": "Number of approved transactions in the last 2 months (MIN 0).", "minimum": 0 }, "recent_transactions_3h": { "type": "integer", "description": "Number of transactions in the last 3 hours (MIN 0).", "minimum": 0 }, "is_paid_user": { "type": "boolean", "description": "Indicates whether the payer is a paid user." }, "account_creation_date": { "type": "string", "description": "The account creation date in YYYYMMDD format (e.g. 20191005)." } } }, "seller_details": { "type": "object", "description": "Specifies the seller's details object. Only mandatory for PSPs with sub_merchant account information.", "properties": { "name": { "type": "string", "description": "The seller's legal name (MAX 255; MIN 1)." }, "email": { "type": "string", "description": "The seller's e-mail (MAX 255; MIN 1)." }, "reference": { "type": "string", "description": "The seller's identification code (MAX 255; MIN 1)." }, "website": { "type": "string", "description": "The seller's website URL (MAX 255; MIN 1)." }, "industry": { "type": "string", "description": "The seller's industry (MAX 255; MIN 3; Industry category reference)." }, "country": { "type": "string", "description": "The seller's country (MAX 255; MIN 3; ISO 3166-1)." }, "document": { "type": "object", "description": "Specifies the document object of the seller.", "required": [ "document_number" ], "properties": { "document_number": { "type": "string", "description": "The document number (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "Document type (MAX 6, MIN 1; [Country reference](country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] } } }, "phone": { "type": "object", "description": "Specifies the seller's phone number object.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the phone (MAX 5; MIN 1). Check the [Country reference](country-reference) to see the phone codes." }, "number": { "type": "string", "description": "The phone number, without the country code (MAX 32; MIN 1)." } } }, "address": { "type": "object", "description": "Specifies the seller's address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary address line (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary address line (MAX 255; MIN 1)." }, "city": { "type": "string", "description": "The city considered for the address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state/province from the address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode for the address (MAX 10; MIN 5)." } } } } } } }, "callback_url": { "type": "string", "description": "URL to redirect the customer after the payment (MAX 256)." }, "one_time_use": { "type": "boolean", "description": "`true` allows only one use, `false` multiple payments" }, "availability": { "type": "object", "description": "The availability object. Refers to the Payment Link expiration date.", "properties": { "start_at": { "type": "string", "description": "Start of the validity period of the payment link.", "format": "date-time" }, "finish_at": { "type": "string", "description": "End of the validity period of the payment link.", "format": "date-time" } } }, "payment_method_types": { "type": "array", "description": "The list of types of payment methods that customers can use. Check the available payment methods on [Payment type](/reference/payment-type-list). If no value is passed, Yuno will display the payment methods defined in the dashboard.", "items": { "type": "string" } }, "metadata": { "type": "array", "description": "Specifies a list of metadata objects. You can add up to 50 metadata objects.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48)." }, "value": { "type": "string", "description": "The metadata key value (MAX 512)." } }, "type": "object" } }, "vault_on_success": { "type": "boolean", "description": "Flag to enroll the card after a successful payment" } } }, "examples": { "CREATE PAYMENT LINK": { "value": { "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "AR", "merchant_order_id": "AA01", "amount": { "value": 5000, "currency": "ARS" }, "payment_method_types": [ "CARD" ], "availability": { "start_at": "2023-01-15T14:00:12Z", "finish_at": "2023-12-29T14:00:12Z" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "CREATE PAYMENT LINK": { "value": { "id": "555933df-4eed-4af4-ae83-a32072ef34af", "country": "US", "availability": { "start_at": "2023-01-15T14:00:12Z", "finish_at": "2023-12-29T14:00:12Z" }, "status": "CREATED", "merchant_order_id": "AA01", "description": "Test", "amount": { "currency": "USD", "value": 5000 }, "capture": true, "metadata": null, "split_payment_methods": false, "payment_method_types": [ "CARD" ], "one_time_use": false, "payments": null, "callback_url": "https://checkout.sandbox.y.uno/payment/status", "installments_plan": null, "customer_payer": null, "taxes": null, "additional_data": { "airline": null, "order": null, "seller_details": null }, "account_id": "493e9374-510a-4201-9e09-de669d75f256", "checkout_url": "https://checkout.sandbox.y.uno/payment?session=2f6d9754-43d0-4dca-b023-6aba4b107179", "payments_number": 0, "merchant_image": "" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "555933df-4eed-4af4-ae83-a32072ef34af" }, "country": { "type": "string", "example": "US" }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2023-01-15T14:00:12Z" }, "finish_at": { "type": "string", "example": "2023-12-29T14:00:12Z" } } }, "status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "AA01" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "capture": { "type": "boolean", "example": true, "default": true }, "metadata": {}, "split_payment_methods": { "type": "boolean", "example": false, "default": true }, "payment_method_types": { "type": "array", "items": { "type": "string", "example": "CARD" } }, "one_time_use": { "type": "boolean", "example": false, "default": true }, "payments": {}, "callback_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment/status" }, "installments_plan": {}, "customer_payer": {}, "taxes": {}, "additional_data": { "type": "object", "properties": { "airline": {}, "order": {}, "seller_details": {}, "device": { "type": "object", "properties": { "locale": { "type": "string", "example": "es-CL" }, "geolocation": { "type": "string" }, "event_uuid": { "type": "string" }, "user_agent": { "type": "string" } } }, "payer_risk_data": { "type": "object", "properties": { "login_platform": { "type": "string", "example": "WEB" }, "approved_transactions_2m": { "type": "integer", "default": 0 }, "recent_transactions_3h": { "type": "integer", "default": 0 }, "is_paid_user": { "type": "boolean" }, "account_creation_date": { "type": "string", "example": "20191005" } } } } }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "checkout_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=2f6d9754-43d0-4dca-b023-6aba4b107179" }, "payments_number": { "type": "integer", "example": 0, "default": 0 }, "merchant_image": { "type": "string", "example": "" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] }, "summary": "Invalid Request" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Payment Links" ] } }, "/payment-links/{code}": { "get": { "summary": "Retrieve Payment Link", "description": "", "operationId": "retrieve-payment-link", "parameters": [ { "name": "code", "in": "path", "description": "The code of the payment link (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "RETRIVE PAYMENT LINK": { "value": { "code": "aace3f6d-e26d-45d0-9a4f-66523909ddf9", "country": "US", "availability": { "start_at": "2023-01-15T14:00:12Z", "finish_at": "2023-10-29T14:00:12Z" }, "status": "CREATED", "description": "PRUEBA PAYMENT LINK 10/07", "amount": { "currency": "USD", "value": 5000 }, "metadata": [ { "key": "some key", "value": "some value" } ], "split_payment_methods": false, "payment_method_types": [ "PSE" ], "one_time_use": true, "callback_url": "https://checkout.sandbox.y.uno/payment/status", "installments_plan": null, "customer_payer": null, "taxes": null, "additional_data": { "airline": null, "order": null, "seller_details": null }, "organization_code": "b887a970-9722-44fe-ab17-106bf1b93577", "account_code": "8147da44-4de9-48ff-a194-51b2cd7d2a03", "checkout_url": "https://checkout.sandbox.y.uno/payment?session=ac63a0d7-b2d7-4e72-9062-2e2e3a448359", "payments_number": 0, "merchant_image": "" } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "aace3f6d-e26d-45d0-9a4f-66523909ddf9" }, "country": { "type": "string", "example": "US" }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2023-01-15T14:00:12Z" }, "finish_at": { "type": "string", "example": "2023-10-29T14:00:12Z" } } }, "status": { "type": "string", "example": "CREATED" }, "description": { "type": "string", "example": "PRUEBA PAYMENT LINK 10/07" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "some key" }, "value": { "type": "string", "example": "some value" } } } }, "split_payment_methods": { "type": "boolean", "example": false, "default": true }, "payment_method_types": { "type": "array", "items": { "type": "string", "example": "PSE" } }, "one_time_use": { "type": "boolean", "example": true, "default": true }, "callback_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment/status" }, "installments_plan": {}, "customer_payer": {}, "taxes": {}, "additional_data": { "type": "object", "properties": { "airline": {}, "order": {}, "seller_details": {}, "device": { "type": "object", "properties": { "locale": { "type": "string", "example": "es-CL" }, "geolocation": { "type": "string" }, "event_uuid": { "type": "string" }, "user_agent": { "type": "string" } } }, "payer_risk_data": { "type": "object", "properties": { "login_platform": { "type": "string", "example": "WEB" }, "approved_transactions_2m": { "type": "integer", "default": 0 }, "recent_transactions_3h": { "type": "integer", "default": 0 }, "is_paid_user": { "type": "boolean" }, "account_creation_date": { "type": "string", "example": "20191005" } } } } }, "organization_code": { "type": "string", "example": "b887a970-9722-44fe-ab17-106bf1b93577" }, "account_code": { "type": "string", "example": "8147da44-4de9-48ff-a194-51b2cd7d2a03" }, "checkout_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=ac63a0d7-b2d7-4e72-9062-2e2e3a448359" }, "payments_number": { "type": "integer", "example": 0, "default": 0 }, "merchant_image": { "type": "string", "example": "" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] }, "summary": "Invalid Request" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Payment Links" ] } }, "/payment-links/{code}/cancel": { "post": { "summary": "Cancel Payment Link", "description": "", "operationId": "cancel-payment-link", "parameters": [ { "name": "code", "in": "path", "description": "The code of the payment link (UUID, 36 chars)", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "CANCEL PAYMENT LINK": { "value": { "code": "aace3f6d-e26d-45d0-9a4f-66523909ddf9", "country": "US", "availability": { "start_at": "2023-01-15T14:00:12Z", "finish_at": "2023-10-29T14:00:12Z" }, "status": "CANCELED", "description": "PRUEBA PAYMENT LINK 10/07", "amount": { "currency": "USD", "value": 5000 }, "metadata": [ { "key": "some key", "value": "some value" } ], "split_payment_methods": false, "payment_method_types": [ "PSE" ], "one_time_use": true, "callback_url": "https://checkout.sandbox.y.uno/payment/status", "installments_plan": null, "customer_payer": null, "taxes": null, "additional_data": { "airline": null, "order": null, "seller_details": null }, "organization_code": "b887a970-9722-44fe-ab17-106bf1b93577", "account_code": "8147da44-4de9-48ff-a194-51b2cd7d2a03", "checkout_url": "https://checkout.sandbox.y.uno/payment?session=ac63a0d7-b2d7-4e72-9062-2e2e3a448359", "payments_number": 0, "merchant_image": "" } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "aace3f6d-e26d-45d0-9a4f-66523909ddf9" }, "country": { "type": "string", "example": "US" }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2023-01-15T14:00:12Z" }, "finish_at": { "type": "string", "example": "2023-10-29T14:00:12Z" } } }, "status": { "type": "string", "example": "CANCELED" }, "description": { "type": "string", "example": "PRUEBA PAYMENT LINK 10/07" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "some key" }, "value": { "type": "string", "example": "some value" } } } }, "split_payment_methods": { "type": "boolean", "example": false, "default": true }, "payment_method_types": { "type": "array", "items": { "type": "string", "example": "PSE" } }, "one_time_use": { "type": "boolean", "example": true, "default": true }, "callback_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment/status" }, "installments_plan": {}, "customer_payer": {}, "taxes": {}, "additional_data": { "type": "object", "properties": { "airline": {}, "order": {}, "seller_details": {} } }, "organization_code": { "type": "string", "example": "b887a970-9722-44fe-ab17-106bf1b93577" }, "account_code": { "type": "string", "example": "8147da44-4de9-48ff-a194-51b2cd7d2a03" }, "checkout_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=ac63a0d7-b2d7-4e72-9062-2e2e3a448359" }, "payments_number": { "type": "integer", "example": 0, "default": 0 }, "merchant_image": { "type": "string", "example": "" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] }, "summary": "Invalid Request" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Payment Links" ] } }, "/payment-methods/account-updater": { "post": { "summary": "Register Stored Cards for Account Updater", "description": "Register up to 100 stored cards for Card Account Updater in a single request, identified by their payment method id (`vaulted_token`). Validation is synchronous and all-or-nothing: if any id is invalid the whole request is rejected. Registration itself runs asynchronously, so a `200` response confirms the cards were accepted, not that the update completed. Your account must be enabled for Card Account Updater to use this endpoint.", "operationId": "register-cards-for-account-updater-api", "requestBody": { "required": true, "content": { "application/json": { "examples": { "Register cards": { "value": { "payment_method_ids": [ "cbdcc878-ceb4-4dd8-b0f0-49d444855de0", "03c3aae1-ed42-4be6-bc24-de5487f58491" ] } } }, "schema": { "type": "object", "required": [ "payment_method_ids" ], "properties": { "payment_method_ids": { "type": "array", "description": "List of stored payment method ids (`vaulted_token`) to register for Card Account Updater. Between 1 and 100 items; each must be a valid UUID.", "minItems": 1, "maxItems": 100, "items": { "type": "string", "format": "uuid", "example": "cbdcc878-ceb4-4dd8-b0f0-49d444855de0" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "accepted": 2 } } }, "schema": { "type": "object", "properties": { "accepted": { "type": "integer", "description": "Number of cards accepted for Card Account Updater registration.", "example": 2 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Direct Workflow" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/payment-methods/{payment_method_id}": { "get": { "summary": "Retrieve Payment Method By ID", "description": "", "operationId": "retrieve-payment-method-by-id-checkout", "parameters": [ { "name": "payment_method_id", "in": "path", "description": "The payment method id obtained while enrolling a new payment method (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "201", "content": { "application/json": { "examples": { "Ready to enroll": { "value": { "id": "0395199e-a99c-4a85-acac-6c916f43fa74", "idempotency_key": null, "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Visa Credit Card", "description": "Visa Credit Card", "type": "VISA", "category": "CARD", "country": "US", "status": "READY_TO_ENROLL", "created_at": "2024-06-06T13:14:18.799434Z", "updated_at": "2024-06-06T13:14:18.799437Z", "enrollment": { "session": "6641e30d-ca7a-440f-b97c-24231eac6dab", "sdk_required_action": false }, "provider": { "id": "YUNO", "type": "YUNO", "provider_status": null }, "verify": { "vault_on_success": false, "payment": null }, "preferred": null } }, "Enrolled": { "value": { "id": "77ee4a02-da3e-4a11-ac15-ba69e1813475", "idempotency_key": null, "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "VISA ****1111", "description": "VISA ****1111", "type": "CARD", "category": "CARD", "country": "US", "status": "ENROLLED", "created_at": "2024-06-06T13:28:57.149530Z", "updated_at": "2024-06-06T13:29:05.536493Z", "enrollment": { "session": "0685f1d6-11ff-4992-abc3-9eea1842205c", "sdk_required_action": true }, "provider": { "id": "YUNO", "type": "YUNO", "token": "e47299a5-269e-42a1-9be1-9f64e400413a", "provider_status": null }, "card_data": { "iin": "41111111", "lfd": "1111", "expiration_month": 10, "expiration_year": 25, "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer": "JPMORGAN CHASE BANK N A", "issuer_code": null, "category": "CREDIT", "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "verify": { "vault_on_success": false, "payment": null }, "preferred": null } } }, "schema": { "oneOf": [ { "title": "Ready to enroll", "type": "object", "properties": { "id": { "type": "string", "example": "0395199e-a99c-4a85-acac-6c916f43fa74" }, "idempotency_key": {}, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "example": "Visa Credit Card" }, "description": { "type": "string", "example": "Visa Credit Card" }, "type": { "type": "string", "example": "VISA" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_ENROLL" }, "created_at": { "type": "string", "example": "2024-06-06T13:14:18.799434Z" }, "updated_at": { "type": "string", "example": "2024-06-06T13:14:18.799437Z" }, "enrollment": { "type": "object", "properties": { "session": { "type": "string", "example": "6641e30d-ca7a-440f-b97c-24231eac6dab" }, "sdk_required_action": { "type": "boolean", "example": false, "default": true } } }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO" }, "type": { "type": "string", "example": "YUNO" }, "provider_status": {} } }, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": false, "default": true }, "payment": {} } }, "preferred": {} } }, { "title": "Enrolled", "type": "object", "properties": { "id": { "type": "string", "example": "77ee4a02-da3e-4a11-ac15-ba69e1813475" }, "idempotency_key": {}, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "example": "VISA ****1111" }, "description": { "type": "string", "example": "VISA ****1111" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "ENROLLED" }, "created_at": { "type": "string", "example": "2024-06-06T13:28:57.149530Z" }, "updated_at": { "type": "string", "example": "2024-06-06T13:29:05.536493Z" }, "enrollment": { "type": "object", "properties": { "session": { "type": "string", "example": "0685f1d6-11ff-4992-abc3-9eea1842205c" }, "sdk_required_action": { "type": "boolean", "example": true, "default": true } } }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO" }, "type": { "type": "string", "example": "YUNO" }, "token": { "type": "string", "example": "e47299a5-269e-42a1-9be1-9f64e400413a" }, "provider_status": {} } }, "card_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "expiration_month": { "type": "integer", "example": 10, "default": 0 }, "expiration_year": { "type": "integer", "example": 25, "default": 0 }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" } } }, "verify": { "type": "object", "properties": { "vault_on_success": { "type": "boolean", "example": false, "default": true }, "payment": {} } }, "preferred": {} } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Checkout" ] }, "patch": { "summary": "Reassign a Payment Method to Another Customer", "description": "Reassigns an enrolled payment method to a different customer of the same account. Only card payment methods can be reassigned. The reassignment fails when the payment method is already assigned to a customer that has data. Returns the payment method in the same shape as the Enroll Payment Method response, with the new owner in the `customer_id` field.", "operationId": "reassign-payment-method-api", "parameters": [ { "name": "payment_method_id", "in": "path", "description": "The unique identifier of the `payment_method`. This is the `vaulted_token` received when enrolling a payment method with [Enroll Payment Method](/reference/enroll-payment-method-api) (UUID).", "schema": { "type": "string" }, "required": true }, { "name": "X-account-code", "in": "header", "description": "The unique identifier of your account (UUID).", "schema": { "type": "string", "x-default": "" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReassignPaymentMethodInput" }, "example": { "customer_id": "b3f2c1a0-1234-4a5b-9c8d-000000000001" } } } }, "responses": { "200": { "description": "The reassigned payment method, including the new owner in the `customer_id` field.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" }, "example": { "idempotency_key": "a0000000-0000-4000-8000-000000000010", "name": "VISA ****1111", "description": "VISA ****1111", "type": "CARD", "category": "CARD", "country": "US", "parent_type": null, "status": "ENROLLED", "sub_status": "ENROLLED", "vaulted_token": "b0000000-0000-4000-8000-000000000002", "callback_url": null, "action": null, "redirect_url": null, "created_at": "2024-06-04T12:47:46.992602Z", "updated_at": "2024-06-04T12:47:46.992603Z", "card_data": { "iin": "41111111", "lfd": "1111", "holder_name": "JOHN DOE", "expiration_month": 3, "expiration_year": 26, "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer": "JPMORGAN CHASE BANK N A", "issuer_code": null, "country_code": "US", "category": "CREDIT", "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "last_successfully_used": null, "last_successfully_used_at": null, "preferred": null, "customer_id": "b3f2c1a0-1234-4a5b-9c8d-000000000001", "verify": null } } } }, "400": { "description": "The request is invalid, the target customer does not exist, or the payment method is not a card.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Missing customer_id": { "value": { "code": "INVALID_PARAMETERS", "messages": [ "The field 'customer_id' is required." ] } }, "Invalid customer_id": { "value": { "code": "INVALID_PARAMETERS", "messages": [ "The field 'customer_id' must be a valid uuid v4." ] } }, "Malformed request body": { "value": { "code": "BAD_REQUEST", "messages": [ "Bad request" ] } }, "Target customer does not exist": { "value": { "code": "CUSTOMER_NOT_FOUND", "messages": [ "Customer not found." ] } }, "Payment method is not a card": { "value": { "code": "PAYMENT_METHOD_NOT_REASSIGNABLE", "messages": [ "Only card payment methods can be reassigned." ] } } } } } }, "404": { "description": "The payment method does not exist for this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodNotFoundError" }, "examples": { "Payment method not found": { "value": { "code": "PAYMENT_METHOD_NOT_FOUND", "messages": [ "Payment method not found." ] } } } } } }, "409": { "description": "The payment method is already assigned to a customer that has data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodConflictError" }, "examples": { "Already assigned to a customer with data": { "value": { "code": "CONFLICT", "messages": [ "payment_method is already assigned to a customer with data" ] } } } } } } }, "deprecated": false, "tags": [ "Payment Methods Direct Workflow" ] } }, "/payments": { "get": { "summary": "Retrieve Payment by Merchant Order ID", "description": "", "operationId": "retrieve-payment-by-merchant-order-id", "parameters": [ { "name": "merchant_order_id", "in": "query", "description": "The unique identifier of the customer's order.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "SDK_Checkout - Required Fields": { "value": [ { "id": "e3f397ed-b7d0-4816-ab75-8457b0a30ec1", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-20T17:24:58.900553Z", "updated_at": "2023-07-20T17:25:13.447662Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 52000 }, "checkout": { "session": "954dc216-60ff-4ae4-a299-c603b93bd267", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "2cd31999-e44e-4de3-bbe4-179981ff4295", "payment_method_detail": { "bank_transfer": { "provider_image": "", "account_type": null, "bank_name": "Bank of America", "beneficiary_name": "John Doe", "bank_account": "123456789", "bank_account_2": null, "beneficiary_document_type": "SSN", "beneficiary_document": "123-45-6789", "payment_instruction": null, "redirect_url": "https://api-sandbox.wompi.co/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved" } } }, "customer_payer": { "id": "cfae0941-7234-427a-a739-ef4fce966c79", "merchant_customer_id": "1689873883", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "09135cb9-159c-4662-8fe3-da5523bb2266", "type": "PURCHASE", "status": "SUCCEEDED", "category": "BANK_TRANSFER", "amount": 52000, "provider_id": "BANK_OF_AMERICA", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "2cd31999-e44e-4de3-bbe4-179981ff4295", "detail": { "bank_transfer": { "provider_image": "", "account_type": null, "bank_name": "Bank of America", "beneficiary_name": "John Doe", "bank_account": "123456789", "bank_account_2": null, "beneficiary_document_type": "SSN", "beneficiary_document": "123-45-6789", "payment_instruction": null, "redirect_url": "https://api-sandbox.wompi.co/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved" } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "BANK_OF_AMERICA", "transaction_id": "117490-1689873907-17347", "account_id": "", "status": "APPROVED", "status_detail": "", "response_code": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "data": { "amount_in_cents": 5200000, "bill_id": null, "billing_data": null, "created_at": "2023-07-20T17:25:07.167Z", "currency": "USD", "customer_data": null, "customer_email": "johndoe@example.com", "finalized_at": null, "id": "117490-1689873907-17347", "payment_link_id": null, "payment_method": { "extra": { "is_three_ds": false }, "payment_description": "Test Bank of America", "sandbox_status": "APPROVED", "type": "BANK_TRANSFER", "user_type": "PERSON" }, "payment_method_type": "BANK_TRANSFER", "payment_source_id": null, "redirect_url": "https://google.com/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267", "reference": "09135cb9-159c-4662-8fe3-da5523bb2266", "shipping_address": null, "status": "PENDING", "status_message": null, "taxes": [] }, "meta": {} }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-20T17:25:05.410687Z", "updated_at": "2023-07-20T17:25:11.472652Z" } ], "split": [], "callback_url": "https://y.uno/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267", "workflow": "SDK_CHECKOUT", "metadata": [] } ] }, "Card - With card details": { "value": [ { "id": "bc0489ba-80bf-4bb9-98c5-ff8dfbceebf9", "account_id": "64761a45-6e49-4ea5-a6ff-6b52030b92ac", "description": "SUCCESSFUL", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "Order_id", "created_at": "2023-07-12T18:51:49.437886Z", "updated_at": "2023-07-12T18:51:54.679410Z", "amount": { "currency": "USD", "value": 20000, "refunded": 0, "captured": 0 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "517862", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMORGAN_CHASE_BANK_NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "token": null, "collect_url": null, "setup_reference_id": null, "developer_id": null, "solution_id": null, "code": null, "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "acs_id": null, "ds_id": null, "pares_status": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": "a76d79b7-902f-4152-922f-7e7eebc5f3dc", "merchant_customer_id": "1309", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": null, "device_fingerprint": null, "browser_info": { "user_agent": "string", "accept_header": "string", "accept_content": null, "accept_browser": null, "color_depth": "32", "screen_height": "32", "screen_width": "32", "javascript_enabled": true, "java_enabled": null, "browser_time_difference": null, "language": "string" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "", "country": "US", "city": "San Diego" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "", "country": "US", "city": "San Diego" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "c718b8e9-2943-4fdf-9b3c-426cf44940fb", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "DLOCAL", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "517862", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMORGAN_CHASE_BANK_NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "token": null, "collect_url": null, "setup_reference_id": null, "developer_id": null, "solution_id": null, "code": null, "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "acs_id": null, "ds_id": null, "pares_status": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "SUCCESSFUL", "merchant_reference": null, "provider_data": { "id": "DLOCAL", "transaction_id": "T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42", "account_id": "", "status": "PAID", "status_detail": "200", "response_message": "The payment was paid.", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "value": "{\"id\":\"T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42\",\"amount\":20000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":11,\"expiration_year\":2028,\"brand\":\"VI\",\"last4\":\"1111\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-12T18:51:52.000+0000\",\"approved_date\":\"2023-07-12T18:51:54.000+0000\",\"status\":\"PAID\",\"status_detail\":\"The payment was paid.\",\"status_code\":\"200\",\"order_id\":\"c718b8e9-2943-4fdf-9b3c-426cf44940fb\",\"description\":\"SUCCESSFUL\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"517862\"}}" }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-12T18:51:51.908784Z", "updated_at": "2023-07-12T18:51:54.426087Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Card - With airline data": { "value": [ { "id": "6e7cc5da-2b39-4b6e-b382-df8bb1feddf1", "account_id": "64761a45-6e49-4ea5-a6ff-6b52030b92ac", "description": "SUCCESSFUL", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "Order_id", "created_at": "2023-07-12T20:06:41.418163Z", "updated_at": "2023-07-12T20:06:41.806898Z", "amount": { "currency": "USD", "value": 2000, "refunded": 0, "captured": 0 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": false, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMORGAN_CHASE_BANK_NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "token": null, "collect_url": null, "setup_reference_id": null, "developer_id": null, "solution_id": null, "code": null, "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "acs_id": null, "ds_id": null, "pares_status": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": null, "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1998-01-01", "email": "test@test.com", "nationality": "US", "ip_address": "192.0.0.1", "device_fingerprint": null, "browser_info": { "user_agent": "string", "accept_header": "string", "accept_content": "string", "accept_browser": "string", "color_depth": "32", "screen_height": "32", "screen_width": "32", "javascript_enabled": true, "java_enabled": null, "browser_time_difference": null, "language": "string" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": null, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": { "airline": { "pnr": "ABC123", "legs": [ { "departure_airport": "LAX", "departure_datetime": "2023-10-31T01:30:00.000-08:00", "departure_airport_timezone": "GMT-08", "arrival_airport": "JFK", "arrival_datetime": "2023-10-31T09:30:00.000-08:00", "carrier_code": "AA", "flight_number": "AA123", "fare_basis_code": "Y", "fare_class_code": "S", "base_fare": 180, "base_fare_currency": "USD", "stopover_code": "O" } ], "passengers": [ { "first_name": "John", "last_name": "Doe", "middle_name": "Stephen", "type": "A", "date_of_birth": "1998-01-01", "nationality": "US", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "country": null, "loyalty_number": "79250001", "loyalty_tier": "DIAMOND", "email": "john.doe@company.com", "phone": { "number": "5559876543", "country_code": "1" } } ], "ticket": null, "tickets": [ { "ticket_number": "BRB0001", "e_ticket": true, "restricted": false, "total_fare_amount": 200, "total_tax_amount": 18, "total_fee_amount": 2, "issue": { "carrier_prefix_code": "001", "travel_agent_code": "A104121", "travel_agent_name": "Airline Travel", "date": "2023-10-31T01:30:00.000-08:00", "address": "123 Main St", "city": "Los Angeles", "country": "US", "zip_code": "90001" } } ] }, "order": null, "seller_details": null }, "taxes": null, "transactions": [], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Card - With 3DS direct": { "value": [ { "id": "cb3ca163-cb79-41d7-b9a3-0115e30a7c01", "idempotency_key": "fc0d89a1-8d18-4759-8d0a-ee1c6d0386e2", "account_code": "26a6626c-d3ec-4caa-bf7c-a994b145dc00", "account_id": "26a6626c-d3ec-4caa-bf7c-a994b145dc00", "description": "TEST_3DS", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-17T17:00:39.678379Z", "updated_at": "2023-07-17T17:41:48.453381Z", "amount": { "currency": "USD", "value": 5000, "refunded": 0, "captured": 0 }, "checkout": { "session": "b0751c96-0b00-4b8c-8372-c16f72f60598", "sdk_action_required": false }, "customer_payer": { "id": "fc7ef8ae-000d-4903-ab76-494ebc8d5fa3", "merchant_customer_id": "1689374657", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": null, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": null, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": { "airline": null, "order": null, "seller_details": null }, "taxes": null, "transactions": [ { "id": "caada737-27ab-46ca-91a9-744da64c4787", "type": "THREE_D_SECURE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "CYBERSOURCE_3DS", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "redirect_url": "https://checkout.staging.y.uno/payment?session=14c263bd-e01d-400f-885a-70205df8b417", "card_data": { "holder_name": "John Doe", "iin": "44565300", "lfd": "0007", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "three_d_secure_setup_id": "24127d61-b852-42fb-acd4-1ee661645376", "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": "Y" } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "TEST_3DS", "merchant_reference": "reference-5f6dd991-ab14-4da3-b7d8-9f24a04ebd92", "provider_data": { "id": "CYBERSOURCE_3DS", "transaction_id": "6896132402506977804951", "account_id": "", "status": "AUTHENTICATION_SUCCESSFUL", "status_detail": "", "response_message": "CONSUMER_AUTHENTICATION_REQUIRED", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "clientReferenceInformation": { "code": "24127d61-b852-42fb-acd4-1ee661645376" }, "consumerAuthenticationInformation": { "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxZmM5ZDVhMS04M2ZhLTQwYWEtYjI5Ny1iZDM1ZGIxODQ4ZjAiLCJpYXQiOjE2ODk2MTMyNDAsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTY4OTYxNjg0MCwiT3JnVW5pdElkIjoiNjQwYTM1NjlkODdhMjUwYTQyNTEwOWRjIiwiUGF5bG9hZCI6eyJBQ1NVcmwiOiJodHRwczovL21lcmNoYW50YWNzc3RhZy5jYXJkaW5hbGNvbW1lcmNlLmNvbS9NZXJjaGFudEFDU1dlYi9wYXJlcS5qc3A_dmFhPWImZ29sZD1BQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUEiLCJQYXlsb2FkIjoiZU5wVlVWMXZna0FRZkw5ZlFVd2ZHKzZBS3RHc2w5QnE2a2MwdHRCb254cUViU1dWRDQvRHFMKytkd2kxdmFlZHljN3R6aXdFTzRFNDhqR3FCSEpZWUZtR1gyZ2s4YkRqWC9KcHZqaVV6M0kyUzc4LzAvUE1ZeDBPSys4VkR4eU9LTW9rejdobE10TUcya0tpdmhEUkxzd2toekE2UEU2WC9LSFh0NjBlMEFZU1NGRk1SendZKzhHSE0vS0JYakdCTEV5UnYxZFpiaWphQ0xDVVFHdU9RSlJYbVJSbmJya01hQXNJVkdMUGQxSVc1WURTczZtVVFEVkZnTjYyV0ZXNktwVzVVeEx6TjZjNCt1ditNdG9zSi9HNG1HL1hNdDF1OXZPWHdCc0MxUjBFNGxBaXQ1bnRNTmR5RGNzZE1EWncra0JybmtDWTZ2bjhybXN5eHU2WldxaGhDQlI2bG5kRlhhWWYwTCtjTWxJSmdWblVPbWtSQVR3VmVZYXFSNFg1V3lzanQvV2ZKanJTU0txc1hPWTR6TEoxcGpXdTVZbUt4TzR4cTlZbmRUNVVhMmh6TWRvY1YxWC9qdjREQVEybVdnPT0iLCJUcmFuc2FjdGlvbklkIjoiU3pvSW9NcXNHdEpKbWtmbXlKQTAifSwiT2JqZWN0aWZ5UGF5bG9hZCI6dHJ1ZSwiUmV0dXJuVXJsIjoiaHR0cHM6Ly9zdGFnaW5nLnkudW5vL2N5YmVyc291cmNlLTNkcy13ZWJob29rL3YxL2NvbmZpcm1hdGlvbnMvYXV0aC8yNDEyN2Q2MS1iODUyLTQyZmItYWNkNC0xZWU2NjE2NDUzNzYifQ.5ehSTA5uUKc2DfvTRGJZ8dPKbxAJ5WproKSTLqu4egM", "acsUrl": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "authenticationPath": "ENROLLED", "authenticationTransactionId": "SzoIoMqsGtJJmkfmyJA0", "pareq": "eNpVUV1vgkAQfL9fQUwfG+6AKtGsl9Bq6kc0ttBonxqEbSWVD4/DqL++dwi1vaedyc7tziwEO4E48jGqBHJYYFmGX2gk8bDjX/JpvjiUz3I2S78/0/PMYx0OK+8VDxyOKMokz7hlMtMG2kKivhDRLswkhzA6PE6X/KHXt60e0AYSSFFMRzwY+8GHM/KBXjGBLEyRv1dZbijaCLCUQGuOQJRXmRRnbrkMaAsIVGLPd1IW5YDSs6mUQDVFgN62WFW6KpW5UxLzN6c4+uv+MtosJ/G4mG/XMt1u9vOXwBsC1R0E4lAit5ntMNdyDcsdMDZw+kBrnkCY6vn8rmsyxu6ZWqhhCBR6lndFXaYf0L+cMlIJgVnUOmkRATwVeYaqR4X5Wysjt/WfJjrSSKqsXOY4zLJ1pjWu5YmKxO4xq9YndT5Ua2hzMdocV1X/jv4DAQ2mWg==", "proofXml": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/vereq.jsp?acqid=CYBS1.0.2XXXXXXXXXXXX0007469216TEST_3DS0*/*Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.361.0.2Y7033012https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAThreeDSecure", "proxyPan": "7033012", "specificationVersion": "1.0.2", "stepUpUrl": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp", "strongAuthentication": { "OutageExemptionIndicator": "0" }, "token": "AxjzbwSTddcP6s4BiIKXABEBURzGv4QYVRP0JAY/LtaSZejFq0T8BEAAwwdp", "veresEnrolled": "Y", "xid": "U3pvSW9NcXNHdEpKbWtmbXlKQTA=" }, "errorInformation": { "message": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction.", "reason": "CONSUMER_AUTHENTICATION_REQUIRED" }, "id": "6896132402506977804951", "paymentInformation": { "card": { "bin": "445653", "type": "VISA" } }, "status": "PENDING_AUTHENTICATION", "submitTimeUtc": "2023-07-17T17:00:40Z" }, "third_party_transaction_id": null }, "three_d_secure_action_required": null, "created_at": "2023-07-17T17:00:39.765728Z", "updated_at": "2023-07-17T17:41:43.593769Z" }, { "id": "4081b900-3efa-44a2-83d8-bca350476b06", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "DLOCAL", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "445975", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "44565300", "lfd": "0007", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "three_d_secure_setup_id": "24127d61-b852-42fb-acd4-1ee661645376", "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": "Y" } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "TEST_3DS", "merchant_reference": null, "provider_data": { "id": "DLOCAL", "transaction_id": "T-385928-57934367-25ca-4445-a973-da5c1a4635b2", "account_id": "", "status": "PAID", "sub_status": "", "status_detail": "200", "response_message": "The payment was paid.", "raw_response": { "value": "{\"id\":\"T-385928-57934367-25ca-4445-a973-da5c1a4635b2\",\"amount\":5000,\"currency\":\"COP\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"CO\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":1,\"expiration_year\":2026,\"brand\":\"VI\",\"last4\":\"0007\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-17T17:41:44.000+0000\",\"approved_date\":\"2023-07-17T17:41:48.000+0000\",\"status\":\"PAID\",\"status_detail\":\"The payment was paid.\",\"status_code\":\"200\",\"order_id\":\"4081b900-3efa-44a2-83d8-bca350476b06\",\"description\":\"TEST_3DS\",\"notification_url\":\"https://staging.y.uno/dlocal-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"445975\"}}" }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-17T17:41:43.752435Z", "updated_at": "2023-07-17T17:41:48.395863Z" } ], "split": [], "callback_url": "https://google.com", "workflow": "REDIRECT", "fraud_screening": null, "metadata": [], "payment_link_code": "" } ] }, "Card - With customer, billing, and shipping details": { "value": [ { "id": "12113b61-015a-4a01-a69c-ab7423d0138d", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:03:02.291414Z", "updated_at": "2023-07-24T01:03:04.571022Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690160581", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502, Tower I", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502, Tower I", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "73e5cddf-32c7-4b12-9d8e-92335862928f", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-85ffbde3-2256-418f-b761-41ab2d8706dd", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "d570b77a-759e-45ae-abb9-ab4ab3034d0c", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:03:02.407480Z", "updated_at": "2023-07-24T01:03:04.499303Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Card - With customer, billing, shipping and order items": { "value": [ { "id": "cf205a5e-140e-4c08-9a5b-ee44b91256dc", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:08:17.039613Z", "updated_at": "2023-07-24T01:08:19.300337Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690160896", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502, Tower I", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502, Tower I", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": { "airline": null, "order": { "fee_amount": 0, "shipping_amount": 0, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 5000, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456" } ] }, "seller_details": null }, "taxes": null, "transactions": [ { "id": "bf442c7f-2393-4607-98b5-a4c2a8a97bbc", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-9260ef97-81b5-4e35-ac17-0d3d124a0d59", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "ade1dcf5-cbf5-408b-84af-f504abe01a26", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:08:17.147871Z", "updated_at": "2023-07-24T01:08:19.222926Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Card - With installments": { "value": [ { "id": "3707bcc5-f88c-4092-ba44-142d1f3ea229", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:10:50.152163Z", "updated_at": "2023-07-24T01:10:52.417211Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 3, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "a58043ab-e5c6-4476-adfb-623fa8cc320d", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 3, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-f3f9319f-f3f7-48a3-90c2-fac0a2f782be", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "9efdc397-2a74-479a-af00-bf5ae7e2a76e", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:10:50.273142Z", "updated_at": "2023-07-24T01:10:52.339967Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Card - With authorization": { "value": [ { "id": "c0409fc0-87d5-453f-bf91-8f0af2f09347", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "PENDING", "sub_status": "AUTHORIZED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:13:37.372312Z", "updated_at": "2023-07-24T01:13:39.654433Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": false, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1985-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "e9108a97-5d0d-492a-99bf-da1ee42af425", "type": "AUTHORIZE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": false, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-0b914bf9-0e86-4713-a908-0ec01d60c486", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "1b7011ff-4252-4ac6-99a4-d5de2086896b", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:13:37.492230Z", "updated_at": "2023-07-24T01:13:39.584118Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Card - With device fingerprint": { "value": [ { "id": "8e7fbcad-9c7b-43c6-8fbf-b864e87c5e41", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:20:02.671644Z", "updated_at": "2023-07-24T01:20:04.946852Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1985-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": "hi88287gbd8d7d782ge287gbd8d7d78", "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "36524be2-b33e-4d33-b9d7-9f7853035bbd", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-89ab43dc-57de-4ea0-8058-6f7fc0d972a7", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "20500c62-96d2-457b-8e64-b64480190e89", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:20:02.794825Z", "updated_at": "2023-07-24T01:20:04.873386Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Card - With vault on success": { "value": [ { "id": "96b56df3-0013-4401-b58e-646f5e716ab8", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:27:23.360857Z", "updated_at": "2023-07-24T01:27:25.682059Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1", "type": "CARD", "vault_on_success": true, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": "967ecd18-d898-4b88-9400-dd5b01b18edc", "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1985-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": "hi88287gbd8d7d782ge287gbd8d7d78", "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "85c19c82-dc31-4a50-aa7d-570d89dbc475", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1", "type": "CARD", "vault_on_success": true, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-7cf75e3a-c8eb-4c62-bd02-74928f68f174", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "604075b9-52e9-48f5-8fcf-3c2d9bacbe66", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:27:23.473451Z", "updated_at": "2023-07-24T01:27:25.550651Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Card - With vaulted token": { "value": [ { "id": "821ddfe4-309a-46a8-bd4b-819564aa9c5a", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:28:45.444722Z", "updated_at": "2023-07-24T01:28:47.712002Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": "967ecd18-d898-4b88-9400-dd5b01b18edc", "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1985-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": "hi88287gbd8d7d782ge287gbd8d7d78", "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "a47e879e-3cd1-49f3-ab72-fc33b0185057", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "", "issuer_code": null, "category": null, "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-22103236-c3fc-4871-9fc0-98ce48a9f553", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "f9bcb8a8-d5d8-4c53-b551-5932c9804f16", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:28:45.562437Z", "updated_at": "2023-07-24T01:28:47.639121Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } ] }, "Bank Transfer": { "value": [ { "id": "ac427adb-3ac9-4a7c-9389-0a923146b39b", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-23T23:56:25.405475Z", "updated_at": "2023-07-23T23:56:29.742339Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 52000 }, "checkout": { "session": "c21df85b-6c39-4cf5-aa7d-305aac6441e6", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "payment_method_detail": { "bank_transfer": { "provider_image": "", "account_type": null, "bank_name": null, "beneficiary_name": null, "bank_account": null, "bank_account_2": null, "beneficiary_document_type": null, "beneficiary_document": null, "payment_instruction": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=2cc7ac83-029d-4e13-8360-9b627bba8fc5" } } }, "customer_payer": { "id": null, "merchant_customer_id": "1689888489", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1985-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": "unique-fingerprint-value", "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "en-US" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "acbf992c-e448-4efc-a39c-05f74fa624cf", "type": "PURCHASE", "status": "CREATED", "category": "BANK_TRANSFER", "amount": 52000, "provider_id": "WOMPI", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": { "bank_transfer": { "provider_image": "", "account_type": null, "bank_name": null, "beneficiary_name": null, "bank_account": null, "bank_account_2": null, "beneficiary_document_type": null, "beneficiary_document": null, "payment_instruction": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=2cc7ac83-029d-4e13-8360-9b627bba8fc5" } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "WOMPI", "transaction_id": "117490-1690156586-55850", "account_id": "", "status": "APPROVED", "status_detail": "", "response_message": "", "iso8583_code": "", "iso8583_message": "", "raw_response": { "data": { "amount_in_cents": 5200000, "bill_id": null, "billing_data": null, "created_at": "2023-07-23T23:56:26.350Z", "currency": "USD", "customer_data": null, "customer_email": "johndoe@example.com", "finalized_at": null, "id": "117490-1690156586-55850", "payment_link_id": null, "payment_method": { "extra": { "is_three_ds": false }, "payment_description": "Test Bank of America", "sandbox_status": "APPROVED", "type": "BANK_TRANSFER", "user_type": "PERSON" }, "payment_method_type": "BANK_TRANSFER", "payment_source_id": null, "redirect_url": "https://demo.dev.y.uno/checkout/status?checkoutSession=", "reference": "acbf992c-e448-4efc-a39c-05f74fa624cf", "shipping_address": null, "status": "PENDING", "status_message": null, "taxes": [] }, "meta": {} }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:56:25.506471Z", "updated_at": "2023-07-23T23:56:29.673135Z" } ], "split": [], "workflow": "REDIRECT", "metadata": [] } ] }, "Buy Now Pay Later": { "value": [ { "id": "087be3a5-bed7-4c58-bbe0-c2ebcf376ebb", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-20T21:25:11.903819Z", "updated_at": "2023-07-20T21:25:12.983059Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 520 }, "checkout": { "session": "25e073ae-016c-4bca-89e7-64e05f766f11", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "payment_method_detail": { "bnpl": { "installments": null, "provider_image": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=82e244a2-9d5b-4998-93b7-8a293fb43b9c", "customer_data": null } } }, "customer_payer": { "id": null, "merchant_customer_id": "example00234", "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "test@gmail.com", "nationality": "US", "ip_address": null, "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": null, "shipping_address": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "1328382d-f6e8-4f09-91b7-c18b1308c031", "type": "PURCHASE", "status": "CREATED", "category": "BUY_NOW_PAY_LATER", "amount": 520, "provider_id": "BANK_OF_AMERICA", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": { "bnpl": { "installments": null, "provider_image": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=82e244a2-9d5b-4998-93b7-8a293fb43b9c", "customer_data": null } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "BANK_OF_AMERICA", "transaction_id": "0000022", "account_id": "", "status": "CREATED", "status_detail": "", "response_message": "", "iso8583_code": "", "iso8583_message": "", "raw_response": { "value": "" }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-20T21:25:12.008657Z", "updated_at": "2023-07-20T21:25:12.918362Z" } ], "split": [], "workflow": "REDIRECT", "metadata": [], "fraud_screening": null } ] }, "Payment Link": { "value": [ { "id": "9c1f6ba0-d483-42a9-8d06-d53a07c284e0", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-23T23:11:24.724037Z", "updated_at": "2023-07-23T23:11:26.318691Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 50 }, "checkout": { "session": "3c9eb446-388a-4c2e-9818-573d54300dd1", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "payment_method_detail": { "bnpl": { "installments": 3, "provider_image": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987", "customer_data": { "bank_user_id": "john_doe_123" } } } }, "customer_payer": { "id": null, "merchant_customer_id": null, "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": "1990-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": null, "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "1234567890", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 4B", "city": "New York", "state": "NY", "zip_code": "10001", "country": "US" }, "shipping_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 4B", "city": "New York", "state": "NY", "zip_code": "10001", "country": "US" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "762abda0-2de5-43ba-a52b-04279acfb869", "type": "PURCHASE", "status": "CREATED", "category": "BANK_TRANSFER", "amount": 50, "provider_id": "BANK_OF_AMERICA", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": { "bnpl": { "installments": 3, "provider_image": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987", "customer_data": { "bank_user_id": "john_doe_123" } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "BANK_OF_AMERICA", "transaction_id": "", "account_id": "", "status": "CREATED", "status_detail": "", "response_message": "", "iso8583_code": "00", "iso8583_message": "Approved or completed successfully", "raw_response": { "token": "01aba0f569c8a78370aa35461ca482b57d1b767365535de9a0540c03791a3d97", "url": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987" }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:11:24.842815Z", "updated_at": "2023-07-23T23:11:26.242431Z" } ], "split": [], "callback_url": "www.example.com", "workflow": "REDIRECT", "metadata": [] } ] }, "Ticket": { "value": [ { "id": "1c109200-3236-43f3-ab44-9a317991a288", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-23T23:35:25.021285Z", "updated_at": "2023-07-23T23:35:26.067120Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 52 }, "checkout": { "session": "3faeb04f-0a52-41fc-9aba-33e535386776", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "payment_method_detail": { "ticket": { "type": null, "date_of_expiration": "2023-07-30T23:59:59Z", "provider_number": "762c4604-d4ba-4a8f-ba2f-5d39931e9ed8", "provider_barcode": null, "provider_logo": null, "provider_format": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=3feff49c-a422-434a-9fad-eca87e2193d5" } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690155316", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1985-08-15", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.168.1.100", "device_fingerprint": "fingerprint123456", "browser_info": { "user_agent": "Mozilla/5.0", "accept_header": "text/html", "accept_content": "text/html", "accept_browser": "Chrome", "color_depth": "24", "screen_height": "1080", "screen_width": "1920", "javascript_enabled": true, "java_enabled": false, "browser_time_difference": "-300", "language": "en-US" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "1234567890", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 4B", "city": "New York", "state": "NY", "zip_code": "10001", "country": "US" }, "shipping_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 4B", "city": "New York", "state": "NY", "zip_code": "10001", "country": "US" } }, "additional_data": null, "taxes": null, "transactions": [ { "id": "762c4604-d4ba-4a8f-ba2f-5d39931e9ed8", "type": "PURCHASE", "status": "CREATED", "category": "BANK_TRANSFER", "amount": 52, "provider_id": "BANK_OF_AMERICA", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": {} }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "BANK_OF_AMERICA", "transaction_id": "", "account_id": "", "status": "", "status_detail": "", "response_message": "", "iso8583_code": "00", "iso8583_message": "Approved or completed successfully", "raw_response": { "redirect_url": "https://checkout.sandbox.y.uno/payment?session=3feff49c-a422-434a-9fad-eca87e2193d5" }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:35:25.116858Z", "updated_at": "2023-07-23T23:35:25.988725Z" } ], "split": [], "callback_url": "www.example.com", "workflow": "REDIRECT", "metadata": [] } ] }, "Wallet": { "value": [ { "id": "d0ff19c2-cf55-4015-a613-e35f22da0233", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000023", "created_at": "2023-07-23T23:02:39.401790Z", "updated_at": "2023-07-23T23:02:40.312593Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 3000 }, "checkout": { "session": "b7e15362-4ac0-4e23-886e-329695933ecb", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "payment_method_detail": { "wallet": { "verify": false, "capture": false, "installments": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "customer_data": null, "card_data": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } }, "customer_payer": { "id": null, "merchant_customer_id": null, "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "johndoe@example.com", "nationality": "US", "ip_address": null, "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": null, "phone": null, "billing_address": null, "shipping_address": null }, "additional_data": { "airline": null, "order": { "fee_amount": null, "shipping_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 3000, "category": null, "brand": null, "sku_code": null, "manufacture_part_number": null } ] }, "seller_details": null }, "taxes": null, "transactions": [ { "id": "286ad833-7cbc-4e66-92f9-01019eb7d7a3", "type": "PURCHASE", "status": "CREATED", "category": "WALLET", "amount": 3000, "provider_id": "BANK_OF_AMERICA", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": { "wallet": { "verify": false, "capture": false, "installments": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "customer_data": null, "card_data": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": "reference-d2b08e8e-c87a-4806-b1ea-b35a19a36a6d", "provider_data": { "id": "BANK_OF_AMERICA", "transaction_id": "", "account_id": "", "status": "", "status_detail": "", "response_message": "", "iso8583_code": "00", "iso8583_message": "Approved or completed successfully", "raw_response": { "value": "{\"additional_info\":\"\",\"auto_return\":\"approved\",\"back_urls\":{\"failure\":\"http://www.example.com\",\"pending\":\"http://www.example.com\",\"success\":\"http://www.example.com\"},\"binary_mode\":true,\"client_id\":\"3615163740385056\",\"collector_id\":1131498549,\"coupon_code\":null,\"coupon_labels\":null,\"date_created\":\"2023-07-23T19:02:40.082-04:00\",\"date_of_expiration\":null,\"expiration_date_from\":null,\"expiration_date_to\":null,\"expires\":false,\"external_reference\":\"286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"id\":\"1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"init_point\":\"https://www.bankofamerica.com/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"items\":[{\"id\":\"123AD\",\"category_id\":\"others\",\"currency_id\":\"USD\",\"description\":\"\",\"title\":\"Skirt\",\"quantity\":1,\"unit_price\":3000}]}" }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:02:39.582570Z", "updated_at": "2023-07-23T23:02:40.227158Z" } ], "split": [], "callback_url": "www.example.com", "workflow": "REDIRECT", "metadata": [] } ] } }, "schema": { "oneOf": [ { "title": "SDK_Checkout - Required Fields", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "e3f397ed-b7d0-4816-ab75-8457b0a30ec1" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-20T17:24:58.900553Z" }, "updated_at": { "type": "string", "example": "2023-07-20T17:25:13.447662Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 52000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "954dc216-60ff-4ae4-a299-c603b93bd267" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "2cd31999-e44e-4de3-bbe4-179981ff4295" }, "payment_method_detail": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "provider_image": { "type": "string", "example": "" }, "account_type": {}, "bank_name": { "type": "string", "example": "Bank of America" }, "beneficiary_name": { "type": "string", "example": "John Doe" }, "bank_account": { "type": "string", "example": "123456789" }, "bank_account_2": {}, "beneficiary_document_type": { "type": "string", "example": "SSN" }, "beneficiary_document": { "type": "string", "example": "123-45-6789" }, "payment_instruction": {}, "redirect_url": { "type": "string", "example": "https://api-sandbox.wompi.co/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "cfae0941-7234-427a-a739-ef4fce966c79" }, "merchant_customer_id": { "type": "string", "example": "1689873883" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "09135cb9-159c-4662-8fe3-da5523bb2266" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "BANK_TRANSFER" }, "amount": { "type": "integer", "example": 52000, "default": 0 }, "provider_id": { "type": "string", "example": "BANK_OF_AMERICA" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "2cd31999-e44e-4de3-bbe4-179981ff4295" }, "detail": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "provider_image": { "type": "string", "example": "" }, "account_type": {}, "bank_name": { "type": "string", "example": "Bank of America" }, "beneficiary_name": { "type": "string", "example": "John Doe" }, "bank_account": { "type": "string", "example": "123456789" }, "bank_account_2": {}, "beneficiary_document_type": { "type": "string", "example": "SSN" }, "beneficiary_document": { "type": "string", "example": "123-45-6789" }, "payment_instruction": {}, "redirect_url": { "type": "string", "example": "https://api-sandbox.wompi.co/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BANK_OF_AMERICA" }, "transaction_id": { "type": "string", "example": "117490-1689873907-17347" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "APPROVED" }, "status_detail": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "amount_in_cents": { "type": "integer", "example": 5200000, "default": 0 }, "bill_id": {}, "billing_data": {}, "created_at": { "type": "string", "example": "2023-07-20T17:25:07.167Z" }, "currency": { "type": "string", "example": "USD" }, "customer_data": {}, "customer_email": { "type": "string", "example": "johndoe@example.com" }, "finalized_at": {}, "id": { "type": "string", "example": "117490-1689873907-17347" }, "payment_link_id": {}, "payment_method": { "type": "object", "properties": { "extra": { "type": "object", "properties": { "is_three_ds": { "type": "boolean", "example": false, "default": true } } }, "payment_description": { "type": "string", "example": "Test Bank of America" }, "sandbox_status": { "type": "string", "example": "APPROVED" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "user_type": { "type": "string", "example": "PERSON" } } }, "payment_method_type": { "type": "string", "example": "BANK_TRANSFER" }, "payment_source_id": {}, "redirect_url": { "type": "string", "example": "https://google.com/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267" }, "reference": { "type": "string", "example": "09135cb9-159c-4662-8fe3-da5523bb2266" }, "shipping_address": {}, "status": { "type": "string", "example": "PENDING" }, "status_message": {}, "taxes": { "type": "array" } } }, "meta": { "type": "object", "properties": {} } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-20T17:25:05.410687Z" }, "updated_at": { "type": "string", "example": "2023-07-20T17:25:11.472652Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "https://y.uno/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267" }, "workflow": { "type": "string", "example": "SDK_CHECKOUT" }, "metadata": { "type": "array" } } } }, { "title": "Card - With card details", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "bc0489ba-80bf-4bb9-98c5-ff8dfbceebf9" }, "account_id": { "type": "string", "example": "64761a45-6e49-4ea5-a6ff-6b52030b92ac" }, "description": { "type": "string", "example": "SUCCESSFUL" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "Order_id" }, "created_at": { "type": "string", "example": "2023-07-12T18:51:49.437886Z" }, "updated_at": { "type": "string", "example": "2023-07-12T18:51:54.679410Z" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 20000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "517862" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN_CHASE_BANK_NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "token": {}, "collect_url": {}, "setup_reference_id": {}, "developer_id": {}, "solution_id": {}, "code": {}, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "acs_id": {}, "ds_id": {}, "pares_status": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "a76d79b7-902f-4152-922f-7e7eebc5f3dc" }, "merchant_customer_id": { "type": "string", "example": "1309" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": {}, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "string" }, "accept_header": { "type": "string", "example": "string" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "32" }, "screen_height": { "type": "string", "example": "32" }, "screen_width": { "type": "string", "example": "32" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "string" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "San Diego" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "San Diego" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "c718b8e9-2943-4fdf-9b3c-426cf44940fb" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 20000, "default": 0 }, "provider_id": { "type": "string", "example": "DLOCAL" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "517862" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN_CHASE_BANK_NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "token": {}, "collect_url": {}, "setup_reference_id": {}, "developer_id": {}, "solution_id": {}, "code": {}, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "acs_id": {}, "ds_id": {}, "pares_status": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCESSFUL" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "DLOCAL" }, "transaction_id": { "type": "string", "example": "T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PAID" }, "status_detail": { "type": "string", "example": "200" }, "response_message": { "type": "string", "example": "The payment was paid." }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "{\"id\":\"T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42\",\"amount\":20000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":11,\"expiration_year\":2028,\"brand\":\"VI\",\"last4\":\"1111\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-12T18:51:52.000+0000\",\"approved_date\":\"2023-07-12T18:51:54.000+0000\",\"status\":\"PAID\",\"status_detail\":\"The payment was paid.\",\"status_code\":\"200\",\"order_id\":\"c718b8e9-2943-4fdf-9b3c-426cf44940fb\",\"description\":\"SUCCESSFUL\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"517862\"}}" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-12T18:51:51.908784Z" }, "updated_at": { "type": "string", "example": "2023-07-12T18:51:54.426087Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With airline data", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6e7cc5da-2b39-4b6e-b382-df8bb1feddf1" }, "account_id": { "type": "string", "example": "64761a45-6e49-4ea5-a6ff-6b52030b92ac" }, "description": { "type": "string", "example": "SUCCESSFUL" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "Order_id" }, "created_at": { "type": "string", "example": "2023-07-12T20:06:41.418163Z" }, "updated_at": { "type": "string", "example": "2023-07-12T20:06:41.806898Z" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN_CHASE_BANK_NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "token": {}, "collect_url": {}, "setup_reference_id": {}, "developer_id": {}, "solution_id": {}, "code": {}, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "acs_id": {}, "ds_id": {}, "pares_status": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": {}, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1998-01-01" }, "email": { "type": "string", "example": "test@test.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.0.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "string" }, "accept_header": { "type": "string", "example": "string" }, "accept_content": { "type": "string", "example": "string" }, "accept_browser": { "type": "string", "example": "string" }, "color_depth": { "type": "string", "example": "32" }, "screen_height": { "type": "string", "example": "32" }, "screen_width": { "type": "string", "example": "32" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "string" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": {}, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "ABC123" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "LAX" }, "departure_datetime": { "type": "string", "example": "2023-10-31T01:30:00.000-08:00" }, "departure_airport_timezone": { "type": "string", "example": "GMT-08" }, "arrival_airport": { "type": "string", "example": "JFK" }, "arrival_datetime": { "type": "string", "example": "2023-10-31T09:30:00.000-08:00" }, "carrier_code": { "type": "string", "example": "AA" }, "flight_number": { "type": "string", "example": "AA123" }, "fare_basis_code": { "type": "string", "example": "Y" }, "fare_class_code": { "type": "string", "example": "S" }, "base_fare": { "type": "integer", "example": 180, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "O" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "middle_name": { "type": "string", "example": "Stephen" }, "type": { "type": "string", "example": "A" }, "date_of_birth": { "type": "string", "example": "1998-01-01" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "country": {}, "loyalty_number": { "type": "string", "example": "79250001" }, "loyalty_tier": { "type": "string", "example": "DIAMOND" }, "email": { "type": "string", "example": "john.doe@company.com" }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5559876543" }, "country_code": { "type": "string", "example": "1" } } } } } }, "ticket": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "BRB0001" }, "e_ticket": { "type": "boolean", "example": true, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 200, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 18, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 2, "default": 0 }, "issue": { "type": "object", "properties": { "carrier_prefix_code": { "type": "string", "example": "001" }, "travel_agent_code": { "type": "string", "example": "A104121" }, "travel_agent_name": { "type": "string", "example": "Airline Travel" }, "date": { "type": "string", "example": "2023-10-31T01:30:00.000-08:00" }, "address": { "type": "string", "example": "123 Main St" }, "city": { "type": "string", "example": "Los Angeles" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "90001" } } } } } } } }, "order": {}, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "array" }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With 3DS direct", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "cb3ca163-cb79-41d7-b9a3-0115e30a7c01" }, "idempotency_key": { "type": "string", "example": "fc0d89a1-8d18-4759-8d0a-ee1c6d0386e2" }, "account_code": { "type": "string", "example": "26a6626c-d3ec-4caa-bf7c-a994b145dc00" }, "account_id": { "type": "string", "example": "26a6626c-d3ec-4caa-bf7c-a994b145dc00" }, "description": { "type": "string", "example": "TEST_3DS" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-17T17:00:39.678379Z" }, "updated_at": { "type": "string", "example": "2023-07-17T17:41:48.453381Z" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 5000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "b0751c96-0b00-4b8c-8372-c16f72f60598" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "fc7ef8ae-000d-4903-ab76-494ebc8d5fa3" }, "merchant_customer_id": { "type": "string", "example": "1689374657" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": {}, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": {}, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": {}, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "caada737-27ab-46ca-91a9-744da64c4787" }, "type": { "type": "string", "example": "THREE_D_SECURE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "CYBERSOURCE_3DS" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "redirect_url": { "type": "string", "example": "https://checkout.staging.y.uno/payment?session=14c263bd-e01d-400f-885a-70205df8b417" }, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "44565300" }, "lfd": { "type": "string", "example": "0007" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "three_d_secure_setup_id": { "type": "string", "example": "24127d61-b852-42fb-acd4-1ee661645376" }, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": { "type": "string", "example": "Y" } } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "TEST_3DS" }, "merchant_reference": { "type": "string", "example": "reference-5f6dd991-ab14-4da3-b7d8-9f24a04ebd92" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "CYBERSOURCE_3DS" }, "transaction_id": { "type": "string", "example": "6896132402506977804951" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "AUTHENTICATION_SUCCESSFUL" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "CONSUMER_AUTHENTICATION_REQUIRED" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "clientReferenceInformation": { "type": "object", "properties": { "code": { "type": "string", "example": "24127d61-b852-42fb-acd4-1ee661645376" } } }, "consumerAuthenticationInformation": { "type": "object", "properties": { "accessToken": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxZmM5ZDVhMS04M2ZhLTQwYWEtYjI5Ny1iZDM1ZGIxODQ4ZjAiLCJpYXQiOjE2ODk2MTMyNDAsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTY4OTYxNjg0MCwiT3JnVW5pdElkIjoiNjQwYTM1NjlkODdhMjUwYTQyNTEwOWRjIiwiUGF5bG9hZCI6eyJBQ1NVcmwiOiJodHRwczovL21lcmNoYW50YWNzc3RhZy5jYXJkaW5hbGNvbW1lcmNlLmNvbS9NZXJjaGFudEFDU1dlYi9wYXJlcS5qc3A_dmFhPWImZ29sZD1BQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUEiLCJQYXlsb2FkIjoiZU5wVlVWMXZna0FRZkw5ZlFVd2ZHKzZBS3RHc2w5QnE2a2MwdHRCb254cUViU1dWRDQvRHFMKytkd2kxdmFlZHljN3R6aXdFTzRFNDhqR3FCSEpZWUZtR1gyZ2s4YkRqWC9KcHZqaVV6M0kyUzc4LzAvUE1ZeDBPSys4VkR4eU9LTW9rejdobE10TUcya0tpdmhEUkxzd2toekE2UEU2WC9LSFh0NjBlMEFZU1NGRk1SendZKzhHSE0vS0JYakdCTEV5UnYxZFpiaWphQ0xDVVFHdU9RSlJYbVJSbmJya01hQXNJVkdMUGQxSVc1WURTczZtVVFEVkZnTjYyV0ZXNktwVzVVeEx6TjZjNCt1ditNdG9zSi9HNG1HL1hNdDF1OXZPWHdCc0MxUjBFNGxBaXQ1bnRNTmR5RGNzZE1EWncra0JybmtDWTZ2bjhybXN5eHU2WldxaGhDQlI2bG5kRlhhWWYwTCtjTWxJSmdWblVPbWtSQVR3VmVZYXFSNFg1V3lzanQvV2ZKanJTU0txc1hPWTR6TEoxcGpXdTVZbUt4TzR4cTlZbmRUNVVhMmh6TWRvY1YxWC9qdjREQVEybVdnPT0iLCJUcmFuc2FjdGlvbklkIjoiU3pvSW9NcXNHdEpKbWtmbXlKQTAifSwiT2JqZWN0aWZ5UGF5bG9hZCI6dHJ1ZSwiUmV0dXJuVXJsIjoiaHR0cHM6Ly9zdGFnaW5nLnkudW5vL2N5YmVyc291cmNlLTNkcy13ZWJob29rL3YxL2NvbmZpcm1hdGlvbnMvYXV0aC8yNDEyN2Q2MS1iODUyLTQyZmItYWNkNC0xZWU2NjE2NDUzNzYifQ.5ehSTA5uUKc2DfvTRGJZ8dPKbxAJ5WproKSTLqu4egM" }, "acsUrl": { "type": "string", "example": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" }, "authenticationPath": { "type": "string", "example": "ENROLLED" }, "authenticationTransactionId": { "type": "string", "example": "SzoIoMqsGtJJmkfmyJA0" }, "pareq": { "type": "string", "example": "eNpVUV1vgkAQfL9fQUwfG+6AKtGsl9Bq6kc0ttBonxqEbSWVD4/DqL++dwi1vaedyc7tziwEO4E48jGqBHJYYFmGX2gk8bDjX/JpvjiUz3I2S78/0/PMYx0OK+8VDxyOKMokz7hlMtMG2kKivhDRLswkhzA6PE6X/KHXt60e0AYSSFFMRzwY+8GHM/KBXjGBLEyRv1dZbijaCLCUQGuOQJRXmRRnbrkMaAsIVGLPd1IW5YDSs6mUQDVFgN62WFW6KpW5UxLzN6c4+uv+MtosJ/G4mG/XMt1u9vOXwBsC1R0E4lAit5ntMNdyDcsdMDZw+kBrnkCY6vn8rmsyxu6ZWqhhCBR6lndFXaYf0L+cMlIJgVnUOmkRATwVeYaqR4X5Wysjt/WfJjrSSKqsXOY4zLJ1pjWu5YmKxO4xq9YndT5Ua2hzMdocV1X/jv4DAQ2mWg==" }, "proofXml": { "type": "string", "example": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/vereq.jsp?acqid=CYBS1.0.2XXXXXXXXXXXX0007469216TEST_3DS0*/*Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.361.0.2Y7033012https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAThreeDSecure" }, "proxyPan": { "type": "string", "example": "7033012" }, "specificationVersion": { "type": "string", "example": "1.0.2" }, "stepUpUrl": { "type": "string", "example": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp" }, "strongAuthentication": { "type": "object", "properties": { "OutageExemptionIndicator": { "type": "string", "example": "0" } } }, "token": { "type": "string", "example": "AxjzbwSTddcP6s4BiIKXABEBURzGv4QYVRP0JAY/LtaSZejFq0T8BEAAwwdp" }, "veresEnrolled": { "type": "string", "example": "Y" }, "xid": { "type": "string", "example": "U3pvSW9NcXNHdEpKbWtmbXlKQTA=" } } }, "errorInformation": { "type": "object", "properties": { "message": { "type": "string", "example": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction." }, "reason": { "type": "string", "example": "CONSUMER_AUTHENTICATION_REQUIRED" } } }, "id": { "type": "string", "example": "6896132402506977804951" }, "paymentInformation": { "type": "object", "properties": { "card": { "type": "object", "properties": { "bin": { "type": "string", "example": "445653" }, "type": { "type": "string", "example": "VISA" } } } } }, "status": { "type": "string", "example": "PENDING_AUTHENTICATION" }, "submitTimeUtc": { "type": "string", "example": "2023-07-17T17:00:40Z" } } }, "third_party_transaction_id": {} } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-17T17:00:39.765728Z" }, "updated_at": { "type": "string", "example": "2023-07-17T17:41:43.593769Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "https://google.com" }, "workflow": { "type": "string", "example": "REDIRECT" }, "fraud_screening": {}, "metadata": { "type": "array" }, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With customer, billing, and shipping details", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "12113b61-015a-4a01-a69c-ab7423d0138d" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:03:02.291414Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:03:04.571022Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690160581" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 502, Tower I" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 502, Tower I" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "73e5cddf-32c7-4b12-9d8e-92335862928f" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-85ffbde3-2256-418f-b761-41ab2d8706dd" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "d570b77a-759e-45ae-abb9-ab4ab3034d0c" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:03:02.407480Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:03:04.499303Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With customer, billing, shipping and order items", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "cf205a5e-140e-4c08-9a5b-ee44b91256dc" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:08:17.039613Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:08:19.300337Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690160896" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 502, Tower I" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 502, Tower I" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 0, "default": 0 }, "shipping_amount": { "type": "integer", "example": 0, "default": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 5000, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" } } } } } }, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "bf442c7f-2393-4607-98b5-a4c2a8a97bbc" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-9260ef97-81b5-4e35-ac17-0d3d124a0d59" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "ade1dcf5-cbf5-408b-84af-f504abe01a26" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:08:17.147871Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:08:19.222926Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With installments", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "3707bcc5-f88c-4092-ba44-142d1f3ea229" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:10:50.152163Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:10:52.417211Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 3, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-01-01" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "ABC123" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "passenger_id": { "type": "string", "example": "passenger_001" }, "departure_airport": { "type": "string", "example": "JFK" }, "arrival_airport": { "type": "string", "example": "LAX" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "passenger_001" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" } } } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "passenger_id": { "type": "string", "example": "passenger_001" }, "ticket_number": { "type": "string", "example": "1234567890123" } } } } } }, "transportations": { "type": "array", "items": { "type": "object", "properties": { "legs": { "type": "array", "items": { "type": "object", "properties": { "passenger_id": { "type": "string", "example": "passenger_001" }, "departure_station": { "type": "string", "example": "Central Station" }, "arrival_station": { "type": "string", "example": "North Station" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "passenger_001" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" } } } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "passenger_id": { "type": "string", "example": "passenger_001" }, "ticket_number": { "type": "string", "example": "12345678901234" } } } } } } } } }, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "a58043ab-e5c6-4476-adfb-623fa8cc320d" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 3, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-f3f9319f-f3f7-48a3-90c2-fac0a2f782be" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "9efdc397-2a74-479a-af00-bf5ae7e2a76e" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:10:50.273142Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:10:52.339967Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With authorization", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "c0409fc0-87d5-453f-bf91-8f0af2f09347" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "PENDING" }, "sub_status": { "type": "string", "example": "AUTHORIZED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:13:37.372312Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:13:39.654433Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1985-01-01" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "e9108a97-5d0d-492a-99bf-da1ee42af425" }, "type": { "type": "string", "example": "AUTHORIZE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-0b914bf9-0e86-4713-a908-0ec01d60c486" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "1b7011ff-4252-4ac6-99a4-d5de2086896b" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:13:37.492230Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:13:39.584118Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With device fingerprint", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "8e7fbcad-9c7b-43c6-8fbf-b864e87c5e41" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:20:02.671644Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:20:04.946852Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1985-01-01" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge287gbd8d7d78" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "36524be2-b33e-4d33-b9d7-9f7853035bbd" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-89ab43dc-57de-4ea0-8058-6f7fc0d972a7" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "20500c62-96d2-457b-8e64-b64480190e89" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:20:02.794825Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:20:04.873386Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With vault on success", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "96b56df3-0013-4401-b58e-646f5e716ab8" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:27:23.360857Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:27:25.682059Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "967ecd18-d898-4b88-9400-dd5b01b18edc" }, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1985-01-01" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge287gbd8d7d78" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "85c19c82-dc31-4a50-aa7d-570d89dbc475" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-7cf75e3a-c8eb-4c62-bd02-74928f68f174" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "604075b9-52e9-48f5-8fcf-3c2d9bacbe66" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:27:23.473451Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:27:25.550651Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Card - With vaulted token", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "821ddfe4-309a-46a8-bd4b-819564aa9c5a" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:28:45.444722Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:28:47.712002Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "967ecd18-d898-4b88-9400-dd5b01b18edc" }, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1985-01-01" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge287gbd8d7d78" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "a47e879e-3cd1-49f3-ab72-fc33b0185057" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-22103236-c3fc-4871-9fc0-98ce48a9f553" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "f9bcb8a8-d5d8-4c53-b551-5932c9804f16" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:28:45.562437Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:28:47.639121Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } } }, { "title": "Bank Transfer", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ac427adb-3ac9-4a7c-9389-0a923146b39b" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-23T23:56:25.405475Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:56:29.742339Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 52000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "c21df85b-6c39-4cf5-aa7d-305aac6441e6" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "provider_image": { "type": "string", "example": "" }, "account_type": {}, "bank_name": {}, "bank_id": { "type": "string", "description": "Identifier of the bank selected for the transfer when provided.", "example": "galicia" }, "beneficiary_name": {}, "bank_account": {}, "bank_account_2": {}, "beneficiary_document_type": {}, "beneficiary_document": {}, "payment_instruction": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=2cc7ac83-029d-4e13-8360-9b627bba8fc5" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1689888489" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1985-01-01" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": { "type": "string", "example": "unique-fingerprint-value" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "en-US" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "acbf992c-e448-4efc-a39c-05f74fa624cf" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "BANK_TRANSFER" }, "amount": { "type": "integer", "example": 52000, "default": 0 }, "provider_id": { "type": "string", "example": "WOMPI" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "provider_image": { "type": "string", "example": "" }, "account_type": {}, "bank_name": {}, "bank_id": { "type": "string", "description": "Identifier of the bank selected for the transfer when provided.", "example": "galicia" }, "beneficiary_name": {}, "bank_account": {}, "bank_account_2": {}, "beneficiary_document_type": {}, "beneficiary_document": {}, "payment_instruction": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=2cc7ac83-029d-4e13-8360-9b627bba8fc5" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "WOMPI" }, "transaction_id": { "type": "string", "example": "117490-1690156586-55850" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "APPROVED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "" }, "iso8583_message": { "type": "string", "example": "" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "amount_in_cents": { "type": "integer", "example": 5200000, "default": 0 }, "bill_id": {}, "billing_data": {}, "created_at": { "type": "string", "example": "2023-07-23T23:56:26.350Z" }, "currency": { "type": "string", "example": "USD" }, "customer_data": {}, "customer_email": { "type": "string", "example": "johndoe@example.com" }, "finalized_at": {}, "id": { "type": "string", "example": "117490-1690156586-55850" }, "payment_link_id": {}, "payment_method": { "type": "object", "properties": { "extra": { "type": "object", "properties": { "is_three_ds": { "type": "boolean", "example": false, "default": true } } }, "payment_description": { "type": "string", "example": "Test Bank of America" }, "sandbox_status": { "type": "string", "example": "APPROVED" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "user_type": { "type": "string", "example": "PERSON" } } }, "payment_method_type": { "type": "string", "example": "BANK_TRANSFER" }, "payment_source_id": {}, "redirect_url": { "type": "string", "example": "https://demo.dev.y.uno/checkout/status?checkoutSession=" }, "reference": { "type": "string", "example": "acbf992c-e448-4efc-a39c-05f74fa624cf" }, "shipping_address": {}, "status": { "type": "string", "example": "PENDING" }, "status_message": {}, "taxes": { "type": "array" } } }, "meta": { "type": "object", "properties": {} } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-23T23:56:25.506471Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:56:29.673135Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" } } } }, { "title": "Buy Now Pay Later", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "087be3a5-bed7-4c58-bbe0-c2ebcf376ebb" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-20T21:25:11.903819Z" }, "updated_at": { "type": "string", "example": "2023-07-20T21:25:12.983059Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 520, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "25e073ae-016c-4bca-89e7-64e05f766f11" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": {}, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=82e244a2-9d5b-4998-93b7-8a293fb43b9c" }, "customer_data": {} } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "example00234" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": {}, "date_of_birth": {}, "email": { "type": "string", "example": "test@gmail.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": {}, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": {}, "shipping_address": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "1328382d-f6e8-4f09-91b7-c18b1308c031" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "BUY_NOW_PAY_LATER" }, "amount": { "type": "integer", "example": 520, "default": 0 }, "provider_id": { "type": "string", "example": "BANK_OF_AMERICA" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": {}, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=82e244a2-9d5b-4998-93b7-8a293fb43b9c" }, "customer_data": {} } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BANK_OF_AMERICA" }, "transaction_id": { "type": "string", "example": "0000022" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "CREATED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "" }, "iso8583_message": { "type": "string", "example": "" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-20T21:25:12.008657Z" }, "updated_at": { "type": "string", "example": "2023-07-20T21:25:12.918362Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {} } } }, { "title": "Payment Link", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "9c1f6ba0-d483-42a9-8d06-d53a07c284e0" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-23T23:11:24.724037Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:11:26.318691Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 50, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "3c9eb446-388a-4c2e-9818-573d54300dd1" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": { "type": "integer", "example": 3, "default": 0 }, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987" }, "customer_data": { "type": "object", "properties": { "bank_user_id": { "type": "string", "example": "john_doe_123" } } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": {}, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": {}, "date_of_birth": { "type": "string", "example": "1990-01-01" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": {}, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "1234567890" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "city": { "type": "string", "example": "New York" }, "state": { "type": "string", "example": "NY" }, "zip_code": { "type": "string", "example": "10001" }, "country": { "type": "string", "example": "US" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "city": { "type": "string", "example": "New York" }, "state": { "type": "string", "example": "NY" }, "zip_code": { "type": "string", "example": "10001" }, "country": { "type": "string", "example": "US" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "762abda0-2de5-43ba-a52b-04279acfb869" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "BANK_TRANSFER" }, "amount": { "type": "integer", "example": 50, "default": 0 }, "provider_id": { "type": "string", "example": "BANK_OF_AMERICA" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": { "type": "integer", "example": 3, "default": 0 }, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987" }, "customer_data": { "type": "object", "properties": { "bank_user_id": { "type": "string", "example": "john_doe_123" } } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BANK_OF_AMERICA" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "CREATED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "00" }, "iso8583_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "token": { "type": "string", "example": "01aba0f569c8a78370aa35461ca482b57d1b767365535de9a0540c03791a3d97" }, "url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-23T23:11:24.842815Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:11:26.242431Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "www.example.com" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" } } } }, { "title": "Ticket", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "1c109200-3236-43f3-ab44-9a317991a288" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-23T23:35:25.021285Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:35:26.067120Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 52, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "3faeb04f-0a52-41fc-9aba-33e535386776" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "ticket": { "type": "object", "properties": { "type": {}, "date_of_expiration": { "type": "string", "example": "2023-07-30T23:59:59Z" }, "provider_number": { "type": "string", "example": "762c4604-d4ba-4a8f-ba2f-5d39931e9ed8" }, "provider_barcode": {}, "provider_logo": {}, "provider_format": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=3feff49c-a422-434a-9fad-eca87e2193d5" } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690155316" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1985-08-15" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.100" }, "device_fingerprint": { "type": "string", "example": "fingerprint123456" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "Mozilla/5.0" }, "accept_header": { "type": "string", "example": "text/html" }, "accept_content": { "type": "string", "example": "text/html" }, "accept_browser": { "type": "string", "example": "Chrome" }, "color_depth": { "type": "string", "example": "24" }, "screen_height": { "type": "string", "example": "1080" }, "screen_width": { "type": "string", "example": "1920" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": { "type": "boolean", "example": false, "default": true }, "browser_time_difference": { "type": "string", "example": "-300" }, "language": { "type": "string", "example": "en-US" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "1234567890" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "city": { "type": "string", "example": "New York" }, "state": { "type": "string", "example": "NY" }, "zip_code": { "type": "string", "example": "10001" }, "country": { "type": "string", "example": "US" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "city": { "type": "string", "example": "New York" }, "state": { "type": "string", "example": "NY" }, "zip_code": { "type": "string", "example": "10001" }, "country": { "type": "string", "example": "US" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "762c4604-d4ba-4a8f-ba2f-5d39931e9ed8" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "BANK_TRANSFER" }, "amount": { "type": "integer", "example": 52, "default": 0 }, "provider_id": { "type": "string", "example": "BANK_OF_AMERICA" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": {} } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BANK_OF_AMERICA" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "00" }, "iso8583_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=3feff49c-a422-434a-9fad-eca87e2193d5" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-23T23:35:25.116858Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:35:25.988725Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "www.example.com" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" } } } }, { "title": "Wallet", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "d0ff19c2-cf55-4015-a613-e35f22da0233" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-23T23:02:39.401790Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:02:40.312593Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 3000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "b7e15362-4ac0-4e23-886e-329695933ecb" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "wallet": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": {}, "payment_method_id": {}, "payment_method_detail": {}, "date_of_expiration": {}, "money_release_date": {}, "sponsor_id": {}, "authorization_code": {}, "customer_data": {}, "card_data": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": {}, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": {}, "date_of_birth": {}, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": {}, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": {}, "phone": {}, "billing_address": {}, "shipping_address": {} } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": { "type": "object", "properties": { "fee_amount": {}, "shipping_amount": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 3000, "default": 0 }, "category": {}, "brand": {}, "sku_code": {}, "manufacture_part_number": {} } } } } }, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "286ad833-7cbc-4e66-92f9-01019eb7d7a3" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "WALLET" }, "amount": { "type": "integer", "example": 3000, "default": 0 }, "provider_id": { "type": "string", "example": "BANK_OF_AMERICA" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "wallet": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": {}, "payment_method_id": {}, "payment_method_detail": {}, "date_of_expiration": {}, "money_release_date": {}, "sponsor_id": {}, "authorization_code": {}, "customer_data": {}, "card_data": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": { "type": "string", "example": "reference-d2b08e8e-c87a-4806-b1ea-b35a19a36a6d" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BANK_OF_AMERICA" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "00" }, "iso8583_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "{\"additional_info\":\"\",\"auto_return\":\"approved\",\"back_urls\":{\"failure\":\"http://www.example.com\",\"pending\":\"http://www.example.com\",\"success\":\"http://www.example.com\"},\"binary_mode\":true,\"client_id\":\"3615163740385056\",\"collector_id\":1131498549,\"coupon_code\":null,\"coupon_labels\":null,\"date_created\":\"2023-07-23T19:02:40.082-04:00\",\"date_of_expiration\":null,\"expiration_date_from\":null,\"expiration_date_to\":null,\"expires\":false,\"external_reference\":\"286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"id\":\"1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"init_point\":\"https://www.bankofamerica.com/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"items\":[{\"id\":\"123AD\",\"category_id\":\"others\",\"currency_id\":\"USD\",\"description\":\"\",\"title\":\"Skirt\",\"quantity\":1,\"unit_price\":3000}]}" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-23T23:02:39.582570Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:02:40.227158Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "www.example.com" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" } } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid Credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid Credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API" } } } } } } } }, "deprecated": false, "tags": [ "Payments" ] }, "post": { "summary": "Create Payment", "description": "", "operationId": "create-payment", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "description", "country", "merchant_order_id", "amount", "payment_method", "checkout" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on [the Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars).", "default": "{{account_id}}" }, "merchant_order_id": { "type": "string", "description": "The unique identifier of the customer's order (MAX 255; MIN 3).", "default": "" }, "description": { "type": "string", "description": "The description of the payment (MAX 255; MIN 3)." }, "amount": { "type": "object", "description": "Specifies the payment amount object, with the value and currency.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "description": "The payment amount (multiple of 0.0001).", "format": "float" }, "currency_conversion": { "type": "object", "description": "The currency conversion (DCC) object. Used when the cardholder pays in their home currency at the point of sale while the merchant settles in their own. `cardholder_currency` must differ from `amount.currency`.", "properties": { "id": { "type": "string", "description": "The unique identifier of the [conversion rate query](/docs/currency-conversion) from Yuno. (UUID, 36 chars)" }, "provider_currency_conversion_id": { "type": "string", "description": "The unique identifier of the conversion rate query from the provider (MAX 526 ; MIN 3)" }, "cardholder_currency": { "type": "string", "description": "Currency the cardholder is charged in. ISO 4217 alpha-3 code. Must differ from `amount.currency`. This field is required if the 'currency_conversion' object is included in the request." }, "cardholder_amount": { "type": "number", "description": "Total amount billed to the cardholder in `cardholder_currency` (multiple of 0.0001). Range: 0.0001 – 9,999,999,999. This field is required if the 'currency_conversion' object is included in the request.", "format": "float" }, "cardholder_accepted": { "type": "boolean", "description": "Cardholder's explicit consent to the DCC offer. `true` = accepted (charge in `cardholder_currency`); `false` = declined (payment proceeds in merchant currency)." }, "provider_data": { "type": "object", "description": "Additional data from the provider", "properties": { "id": { "type": "string", "description": "Identification of the provider", "enum": [ "CIBC", "MERCADO_PAGO" ] } } }, "rate": { "type": "number", "description": "Applied FX rate (markup included). Must be greater than 0.", "format": "float" }, "rate_margin_percentage": { "type": "number", "description": "Markup added over the wholesale rate, expressed as a percentage. Range: 0 – 100.", "format": "float" }, "rate_source": { "type": "string", "description": "Wholesale benchmark used for the quote. Required when `rate_margin_percentage > 0`. Free text, max 50 chars. Examples: `ECB`, `REUTERS`, `BLOOMBERG`, `PROVIDER_INTERNAL`." }, "provider": { "type": "string", "description": "DCC provider that issued the quote.", "enum": [ "FEXCO", "GLOBAL_BLUE", "PLANET", "EURONET", "CURRENCYFAIR", "EUROPEAN_PAYMENT_SERVICES", "OTHER" ] }, "description": { "type": "string", "description": "Verbatim disclosure text shown to the cardholder at the point of sale. Stored unchanged for audit. Max 4096 chars." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp when the DCC provider issued the quote (ISO 8601). Must be ≤ now()." }, "expires_at": { "type": "string", "format": "date-time", "description": "Timestamp when the quote expires (ISO 8601). Must be > `created_at`. The payment is rejected if `expires_at < now()` at validation time." } } } } }, "checkout": { "type": "object", "description": "Specifies the checkout object. This object is not mandatory for back to back payments. Required when `workflow` is defined as `SDK_CHECKOUT` or is not sent. not required for `DIRECT` or `REDIRECT` payments.", "properties": { "session": { "type": "string", "description": "The checkout session that has been created for the payment using the [Create Checkout Session](https://docs.y.uno/reference/create-checkout-session) endpoint (UUID, 36 chars). This field is required if the `checkout` object is included in the request." } } }, "additional_data": { "type": "object", "description": "Specifies the additional_data object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.", "properties": { "order": { "type": "object", "description": "Specifies the order object.", "properties": { "shipping_amount": { "type": "number", "description": "The shipping amount of the order (multiple of 0.0001). This field is for informational purposes, the shipping amount is already included in the final transaction amount and is not added separately.", "format": "float" }, "fee_amount": { "type": "number", "description": "The fee amount of the order (multiple of 0.0001). This field is for informational purposes, the fee amount is already included in the final transaction amount and is not added separately.", "format": "float" }, "tip_amount": { "type": "string", "description": "The tip amount of the order (multiple of 0.0001). This field is for informational purposes, the tip amount is already included in the final transaction amount and is not added separately." }, "taxes": { "type": "array", "description": "The taxes of the order. This struct is for informational purposes, the taxes amount is already included in the final transaction amount and is not added separately.", "items": { "properties": { "type": { "type": "string", "description": "Type of the tax.", "enum": [ "VAT", "AIRPORT_TAX", "CONSUMPTION_TAX", "VAT_LAW_17934", "VAT_LAW_19210", "VAT_EXEMPTION", "ISV" ] }, "tax_base": { "type": "number", "description": "The amount base to apply the tax defined.", "format": "float" }, "value": { "type": "number", "description": "The amount of the tax.", "format": "float" }, "percentage": { "type": "number", "description": "The percentage of the tax.", "format": "float" } }, "required": [ "type", "value" ], "type": "object" } }, "items": { "type": "array", "description": "Specifies the items array of object.", "items": { "properties": { "id": { "type": "string", "description": "The unique identifier of the item (MAX 255; MIN 3)." }, "name": { "type": "string", "description": "The name of the item (MAX 255; MIN 3)." }, "quantity": { "type": "integer", "description": "The quantity of the item.", "format": "int32" }, "unit_amount": { "type": "number", "description": "The unit amount of the item (multiple of 0.0001).", "format": "float" }, "category": { "type": "string", "description": "The category of the item. Check the [Item category reference](/reference/items-category-list).", "enum": [ "art", "baby", "coupons", "beauty_&_personal_care", "donations", "computing", "books", "grocery_&_gourmet_food", "cameras", "video_games", "television", "car_electronics", "electronics", "automotive", "toys_&_games", "musical_instruments", "handmade", "garden_&_outdoor", "entertainment", "industrial_&_scientific", "fashion", "games", "pet_supplies", "home", "musical", "phones", "services", "learnings", "tickets", "travels", "virtual_goods", "others", "" ] }, "brand": { "type": "string", "description": "The brand of the item (MAX 255; MIN 3)." }, "sku_code": { "type": "string", "description": "The stock keeping unit (SKU) of the item (MAX 255; MIN 3)." }, "manufacture_part_number": { "type": "string", "description": "The manufacture part number of the item." }, "url": { "type": "string", "description": "The item's URL available to the buyer (MAX 512; MIN 3)." }, "image_url": { "type": "string", "description": "URL of the product image. Complements the existing url field, which points to the product page (MAX 512; MIN 3).", "minLength": 3, "maxLength": 512 } }, "required": [ "id", "name", "quantity", "unit_amount", "category" ], "type": "object" } }, "shipping": { "type": "object", "description": "The shipping details object", "properties": { "type": { "type": "string", "description": "The type of shippment", "enum": [ "CUSTOM", "MILITARY", "ELECTRONIC", "EXPRESS", "STANDARD", "SCHEDULED", "ECONOMY", "PRIORITY", "SAME_DAY", "NEXT_DAY", "THIRD_DAY", "STORE_PICK_UP", "LOCKER_PICK_UP", "OTHER" ] }, "description": { "type": "string", "description": "The shipment description" }, "carrier": { "type": "string", "description": "Carrier used for the delivery", "enum": [ "UPS", "USPS", "FEDEX", "DHL", "PUROLATOR", "GREYHOUND", "AR_CORREO_ARGENTINO", "AR_OCA", "OTHER" ] }, "deliver_at": { "type": "string", "description": "Estimated date of delivery (ISO 8601 MAX 27; MIN 27)" } } }, "tickets": { "type": "array", "description": "The tickets detail object", "items": { "properties": { "id": { "type": "string", "description": "Id of the ticket (Min: 1, max:255)" }, "name": { "type": "string", "description": "Name of the ticket (Min: 1, max:255)" }, "description": { "type": "string", "description": "Description of the ticket (Min: 1, max:255)" }, "type": { "type": "string", "description": "Type of the ticket", "enum": [ "VIRTUAL", "PHYSICAL" ] }, "amount": { "type": "object", "description": "Amount of the ticket", "properties": { "value": { "type": "number", "description": "Amount of the payment", "format": "float" }, "currency": { "type": "string", "description": "The currency used to make the payment (ISO 4217 MAX 3; MIN 3)" } } }, "event": { "type": "object", "description": "The event information", "properties": { "id": { "type": "string", "description": "Id of the event related to the ticket" }, "name": { "type": "string", "description": "Name of the event" }, "description": { "type": "string", "description": "Description of the event" }, "type": { "type": "string", "description": "Type of the event", "enum": [ "PARTY", "UNIVERCITY", "FESTIVAL", "CIRCUS", "SPORTS", "CINEMA", "THEATER", "CONCERT", "OTHERS" ] }, "date": { "type": "string", "description": "Date of the event", "format": "date" }, "address": { "type": "object", "description": "Address of the event", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line (MAX 255; MIN 3)" }, "address_line_2": { "type": "string", "description": "The secondary billing address line (MAX 255; MIN 3)" }, "building_number_1": { "type": "string", "description": "The primary building number of the customer (MAX 255; MIN 3)" }, "building_number_2": { "type": "string", "description": "The secondary building number of the customer (MAX 255; MIN 3)" }, "city": { "type": "string", "description": "The city considered for the address (MAX 255; MIN 3)" }, "country": { "type": "string", "description": "The country consider for the address (ISO 3166-1 MAX 2; MIN 2)" }, "state": { "type": "string", "description": "The state / province considered for the address (MAX 255; MIN 3)" }, "zip_code": { "type": "string", "description": "The zipcode considered for the address (MAX 11; MIN 4)" }, "neighborhood": { "type": "string", "description": "The neighborhood address line (MAX 255; MIN 3)" } } } } } }, "type": "object" } }, "account_funding": { "type": "object", "description": "The account funding transaction details object necessary for [AFTs](/docs/account-funding-transactions-afts).", "properties": { "sender": { "type": "object", "description": "The sender object necessary for account funding transactions", "required": [ "first_name", "country" ], "properties": { "first_name": { "type": "string", "description": "Sender's name. (Max: 80)" }, "last_name": { "type": "string", "description": "Sender's last name. (Max: 80)" }, "national_entity": { "type": "string", "description": "Sender's national entity type.", "enum": [ "INDIVIDUAL", "ENTITY" ] }, "legal_name": { "type": "string", "description": "Sender's name. (Max: 80) Only necessary when national entity is ENTITY" }, "email": { "type": "string", "description": "The Sender's email (MAX 255; MIN 3)" }, "country": { "type": "string", "description": "The Sender's country (ISO 3166-1 MAX 2; MIN 2)" }, "date_of_birth": { "type": "string", "description": "The beneficiary's date of birth in the YYYY-MM-DD (MAX 10; MIN 10)" }, "document": { "type": "object", "description": "Sender's document object", "properties": { "document_number": { "type": "string", "description": "Document number for customer (MAX 40; MIN 3). This field is required if the 'document' object is included in the request." }, "document_type": { "type": "string", "description": "The customer's document type (MAX 6, MIN 2; [Country reference](/reference/country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] } } }, "phone": { "type": "object", "description": "Sender's phone object", "properties": { "country_code": { "type": "string", "description": "The country calling code of the customer's phone (MAX 3; MIN 1). Check the [Country reference](country-reference) to see the phone codes. This field is required if the 'phone' object is included in the request." }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1). This field is required if the 'phone' object is included in the request." } } }, "address": { "type": "object", "description": "Sender's address object", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 1). This field is required if the 'billing_address' object is included in the request." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 1)." }, "building_number_1": { "type": "string", "description": "The primary building number of the customer (MAX 255; MIN 3)" }, "building_number_2": { "type": "string", "description": "The secondary building number of the customer (MAX 255; MIN 3)" }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 1). This field is required if the 'billing_address' object is included in the request." }, "country": { "type": "string", "description": "The country considered for the billing address (MAX 2; MIN 2; [ISO 3166-1](country-reference)). This field is required if the 'billing_address' object is included in the request.", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "state": { "type": "string", "description": "State or province code. Use ISO 3166-2 subdivision codes (https://en.wikipedia.org/wiki/ISO_3166-2)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the billing address (MAX 11; MIN 3)." }, "neighborhood": { "type": "string", "description": "The neighborhood of the address line of the customer(MAX 255; MIN 1)" } } } } }, "beneficiary": { "type": "object", "description": "The beneficiary object necessary for account funding transactions.", "required": [ "first_name", "country" ], "properties": { "first_name": { "type": "string", "description": "Beneficiary's name. (Max: 80)" }, "last_name": { "type": "string", "description": "Beneficiary's last name. (Max: 80)" }, "national_entity": { "type": "string", "description": "Beneficiary's national entity type.", "enum": [ "INDIVIDUAL", "ENTITY" ] }, "legal_name": { "type": "string", "description": "Beneficiary's name. (Max: 80) Only necessary when national entity is ENTITY" }, "email": { "type": "string", "description": "The Beneficiary's email (MAX 255; MIN 3)" }, "country": { "type": "string", "description": "The Beneficiary's country (ISO 3166-1 MAX 2; MIN 2)" }, "date_of_birth": { "type": "string", "description": "The beneficiary's date of birth in the YYYY-MM-DD (MAX 10; MIN 10)" }, "document": { "type": "object", "description": "The beneficiary's document object.", "properties": { "document_number": { "type": "string", "description": "Document number for customer (MAX 40; MIN 3). This field is required if the 'document' object is included in the request." }, "document_type": { "type": "string", "description": "The customer's document type (MAX 6, MIN 2; [Country reference](/reference/country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] } } }, "phone": { "type": "object", "description": "The beneficiary's phone object.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the customer's phone (MAX 3; MIN 1). Check the [Country reference](country-reference) to see the phone codes. This field is required if the 'phone' object is included in the request." }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1). This field is required if the 'phone' object is included in the request." } } }, "address": { "type": "object", "description": "The beneficiary's address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 1). This field is required if the 'billing_address' object is included in the request." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 1)." }, "building_number_1": { "type": "string", "description": "The primary building number of the customer (MAX 255; MIN 3)" }, "building_number_2": { "type": "string", "description": "The secondary building number of the customer (MAX 255; MIN 3)" }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 1). This field is required if the 'billing_address' object is included in the request." }, "country": { "type": "string", "description": "The country considered for the billing address (MAX 2; MIN 2; [ISO 3166-1](country-reference)). This field is required if the 'billing_address' object is included in the request.", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "state": { "type": "string", "description": "State or province code. Use ISO 3166-2 subdivision codes (https://en.wikipedia.org/wiki/ISO_3166-2)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the billing address (MAX 11; MIN 3)." }, "neighborhood": { "type": "string", "description": "The neighborhood of the address line of the customer(MAX 255; MIN 1)" } } } } } } }, "discounts": { "type": "array", "description": "Specifies the discounts array of objects.", "items": { "properties": { "id": { "type": "string", "description": "ID of the discount (MAX 255; MIN 1)." }, "name": { "type": "string", "description": "Name of the discount (MAX 255; MIN 1)." }, "unit_amount": { "type": "number", "description": "The unit amount of the discount (multiple of 0.0001).", "format": "float" } }, "required": [ "unit_amount" ], "type": "object" } }, "sales_channel": { "type": "string", "description": "Sales channel id of the payment. (MIN:3 y MAX:255)" } } }, "airline": { "type": "object", "description": "Specifies the airline object.", "required": [ "pnr" ], "properties": { "pnr": { "type": "string", "description": "Passenger name record (MAX 10; MIN 1)." }, "type": { "type": "string", "description": "Type of trip.", "enum": [ "ONE_WAY", "ROUNDTRIP", "MULTIPLE_DESTINATIONS" ] }, "legs": { "type": "array", "description": "Specifies the legs object.", "items": { "properties": { "passenger_id": { "type": "string", "description": "Reference to passenger ID (MAX 128; MIN 1).", "example": "passenger_001" }, "departure_airport": { "type": "string", "description": "IATA code. See http://www.iata.org (MAX 3; MIN 3)." }, "departure_datetime": { "type": "string", "description": "The departure date and time in UTC time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), MAX 27; MIN 27).", "format": "date-time" }, "departure_airport_country": { "type": "string", "description": "Country of the departure airport (MAX 2; MIN 2; ISO 3166-1)." }, "departure_airport_city": { "type": "string", "description": "The city considered for the departure airport (MAX 255; MIN 3)." }, "departure_airport_timezone": { "type": "string", "description": "Airport timezone (MAX 6; MIN 6)." }, "arrival_airport": { "type": "string", "description": "IATA airport code. See http://www.iata.org (MAX 3; MIN 3)." }, "arrival_airport_country": { "type": "string", "description": "Country of the arrival airport (MAX 2; MIN 2; ISO 3166-1)." }, "arrival_airport_city": { "type": "string", "description": "The city considered for the arrival airport (MAX 255; MIN 3)." }, "arrival_airport_timezone": { "type": "string", "description": "Airport timezone (MAX 6; MIN 6)." }, "arrival_datetime": { "type": "string", "description": "The arrival date and time in UTC time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), MAX 27; MIN 27)." }, "carrier_code": { "type": "string", "description": "IATA carrier code. See http://www.iata.org (MAX 2; MIN 2)." }, "flight_number": { "type": "string", "description": "The flight number assigned by the airline carrier (MAX 5; MIN 1)." }, "fare_basis_code": { "type": "string", "description": "Code base rate provides specific information on the fare in addition to the class service, both required for booking (MAX 15; MIN 1)." }, "fare_class_code": { "type": "string", "description": "The fare class code of the airline (MAX 1; MIN 1). The values can be a letter (A-Z) but may vary depending on the airline's definition. Check the [Airline information reference](/reference/airline-information#fare-class-code)." }, "base_fare": { "type": "number", "description": "The transaction amount, excluding taxes and fees, the smallest unit of currency (multipleOf 0.0001).", "format": "float" }, "base_fare_currency": { "type": "string", "description": "The currency used to transaction amount (MAX 3; MIN 3)." }, "stopover_code": { "type": "string", "description": "1-letter code indicating whether the passenger is allowed to make a stopover. Only two types of characters are allowed: O: Stopover allowed (the letter 'O', not zero) / X: Stopover not allowed. (MAX 1; MIN 1)." }, "order": { "type": "integer", "description": "A running index (starts with 1), describing the order of legs in the same route.", "format": "int32" }, "route_order": { "type": "integer", "description": "A running index (starts with 1), describing the order of routes by time. E.g: If an order contains 2 Routes: New-York->London->Paris (connection in London) New-York->London should have route_order=1, order=1; London->Paris should have route_order=1, order=2; Paris->London->New-York: Paris->London should have route_order=2, order=1; London->New-York should have route_order=2, order=2.", "format": "int32" } }, "required": [ "departure_airport", "departure_datetime", "departure_airport_timezone", "arrival_airport", "carrier_code", "flight_number", "fare_basis_code", "fare_class_code" ], "type": "object" } }, "passengers": { "type": "array", "description": "Specifies the passengers array of objects.", "items": { "properties": { "id": { "type": "string", "description": "Passenger ID for identification (MAX 128; MIN 1).", "example": "passenger_001" }, "first_name": { "type": "string", "description": "The passenger first name (MAX 255; MIN 3)." }, "last_name": { "type": "string", "description": "The passenger last name (MAX 255; MIN 3)." }, "middle_name": { "type": "string", "description": "The passenger middle name (MAX 255; MIN 3)." }, "email": { "type": "string", "description": "The passenger email (MAX 255; MIN 3)." }, "type": { "type": "string", "description": "The passenger type (MAX 1; MIN 1). Check the [Airline information reference](/reference/airline-information#passenger-type).", "enum": [ "A", "C", "I", "" ] }, "date_of_birth": { "type": "string", "description": "The passenger date of birth in the YYYY-MM-DD (MAX 10; MIN 10).", "format": "date" }, "nationality": { "type": "string", "description": "The passenger nationality (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "document": { "type": "object", "description": "Specifies the document object of the passenger.", "properties": { "document_number": { "type": "string", "description": "Document number for passenger (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "The passenger's document type (MAX 6, MIN 2; [Country reference](/reference/country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] } } }, "loyalty_number": { "type": "string", "description": "Number of passenger loyalty program." }, "loyalty_tier": { "type": "string", "description": "Tier of passenger loyalty program. Check the [Airline information reference](/reference/airline-information#loyalty-tier).", "enum": [ "1", "2", "3" ] }, "phone": { "type": "object", "description": "Specifies the phone object for the passenger.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the passenger's phone (MAX 3; MIN 1). Possible values: Check the [Country reference](/reference/country-reference)." }, "number": { "type": "string", "description": "The passenger's phone number, without the country code (MAX 32; MIN 1)." } } } }, "type": "object" } }, "tickets": { "type": "array", "description": "Specifies the array of ticket objects.", "items": { "properties": { "passenger_id": { "type": "string", "description": "Reference to passenger ID (MAX 128; MIN 1).", "example": "passenger_001" }, "ticket_number": { "type": "string", "description": "Ticket number (MAX 14; MIN 1)." }, "e_ticket": { "type": "boolean", "description": "Is this an e-ticket?" }, "restricted": { "type": "boolean", "description": "Indicates if the ticket is refunfable or not." }, "total_fare_amount": { "type": "number", "description": "Total fare amount in the smallest unit of currency (multiple of 0.0001).", "format": "float" }, "total_tax_amount": { "type": "number", "description": "Total taxes amount in the smallest unit of currency (multiple of 0.0001).", "format": "float" }, "total_fee_amount": { "type": "number", "description": "Total fee amount in the smallest unit of currency (multiple of 0.0001).", "format": "float" }, "issue": { "type": "object", "description": "Specifies the issue object.", "properties": { "carrier_prefix_code": { "type": "string", "description": "Issuing or Validating carrier. This is the AWB Prefix (Air waybill) 3-numeric code (MAX 3; MIN 3)." }, "travel_agent_code": { "type": "string", "description": "Code of the travel agent issuing the ticket (MAX 9; MIN 8)." }, "travel_agent_name": { "type": "string", "description": "The name under which the point of sale appears on the agency list or franchise name (MAX 32; MIN 1)." }, "booking_system_code": { "type": "string", "description": "Code of the booking system issuing the ticket. (MAX 255; MIN 1)." }, "booking_system_name": { "type": "string", "description": "Name of the booking system issuing the ticket. (MAX 255; MIN 1)." }, "date": { "type": "string", "description": "Ticket issuing date (MAX 27; MIN 27).", "format": "date-time" }, "address": { "type": "string", "description": "Address of the agent whose sold the ticket (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "City name of the agent whose sold the ticket (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "Country code alpha 2 where the ticket was issued (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] } } } }, "type": "object" } } } }, "transportations": { "type": "array", "description": "Specifies the transportations array of objects.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the transportation booking (MAX 255; MIN 1).", "example": "AAA0001" }, "description": { "type": "string", "description": "The description of the transportation booking (MAX 255; MIN 1).", "example": "Bus ticket" }, "type": { "type": "string", "description": "The type of transportation booking.", "enum": [ "ONE_WAY", "ROUNDTRIP", "MULTIPLE_DESTINATIONS" ], "example": "ROUNDTRIP" }, "legs": { "type": "array", "description": "Specifies the legs array of objects.", "items": { "type": "object", "properties": { "passenger_id": { "type": "string", "description": "Reference to passenger ID (MAX 128; MIN 1).", "example": "passenger_001" }, "order": { "type": "integer", "description": "A running index (starts with 1), describing the order of legs in the same route.", "example": 2 }, "route_order": { "type": "integer", "description": "A running index (starts with 1), describing the order of routes by time.", "example": 1 }, "departure_country": { "type": "string", "description": "Country of the departure (MAX 2; MIN 2; ISO 3166-1).", "example": "CO" }, "departure_city": { "type": "string", "description": "The city of the departure (MAX 255; MIN 1).", "example": "Bogota" }, "departure_timezone": { "type": "string", "description": "Departure timezone (MAX 6; MIN 6).", "example": "-03:00" }, "departure_datetime": { "type": "string", "description": "The departure date and time in local time at the departure.", "format": "date-time", "example": "2022-05-09T20:46:54.786342Z" }, "departure_reference": { "type": "string", "description": "The reference of the departure (MAX 255; MIN 1).", "example": "AAA001-2" }, "arrival_country": { "type": "string", "description": "Country of the arrival (MAX 2; MIN 2; ISO 3166-1).", "example": "CO" }, "arrival_city": { "type": "string", "description": "The city of the arrival (MAX 255; MIN 1).", "example": "Medellin" }, "arrival_timezone": { "type": "string", "description": "Arrival timezone (MAX 6; MIN 6).", "example": "-03:00" }, "arrival_datetime": { "type": "string", "description": "The arrival date and time in local time at the arrival.", "format": "date-time", "example": "2022-05-09T24:46:54.786342Z" }, "arrival_reference": { "type": "string", "description": "The reference of the arrival (MAX 255; MIN 1).", "example": "AAA001-4" }, "transport": { "type": "object", "description": "Specifies the transport object.", "properties": { "id": { "type": "string", "description": "The id of the transportation vehicle (MAX 255; MIN 1).", "example": "ASONDAKS-1234" } } } } } }, "transport": { "type": "object", "description": "Specifies the transport object.", "properties": { "id": { "type": "string", "description": "The id of the transportation vehicle (MAX 255; MIN 1).", "example": "ASONDAKS-1234" }, "type": { "type": "string", "description": "The type of transportation vehicle.", "enum": [ "SHIP", "BUS", "TRAIN", "TRAM", "CAR" ], "example": "BUS" }, "description": { "type": "string", "description": "The description of the transportation vehicle (MAX 255; MIN 1).", "example": "BUS 2022" } } }, "passengers": { "type": "array", "description": "Specifies the passengers array of objects.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Passenger ID for identification (MAX 128; MIN 1).", "example": "passenger_001" }, "first_name": { "type": "string", "description": "The passenger first name (MAX 255; MIN 3).", "example": "John" }, "last_name": { "type": "string", "description": "The passenger last name (MAX 255; MIN 3).", "example": "Doe" }, "middle_name": { "type": "string", "description": "The passenger middle name (MAX 255; MIN 3).", "example": "A" }, "email": { "type": "string", "description": "The passenger email (MAX 255; MIN 3).", "example": "john.doe@example.com" }, "type": { "type": "string", "description": "The passenger type (MAX 1; MIN 1). Check the Airline information reference.", "example": "A" }, "date_of_birth": { "type": "string", "description": "The passenger date of birth in the YYYY-MM-DD (MAX 10; MIN 10).", "example": "1990-01-01" }, "nationality": { "type": "string", "description": "The passenger nationality (MAX 2; MIN 2; ISO 3166-1).", "example": "CO" }, "document": { "type": "object", "description": "Specifies the document object of the passenger.", "properties": { "document_number": { "type": "string", "description": "Document number for passenger (MAX 40; MIN 3).", "example": "123456789" }, "document_type": { "type": "string", "description": "The passenger's document type (MAX 6, MIN 2; [Document Type List](https://docs.y.uno/reference/country-reference)).", "example": "CC" } } }, "loyalty_number": { "type": "string", "description": "Number of passenger loyalty program.", "example": "L123456" }, "loyalty_tier": { "type": "string", "description": "Tier of passenger loyalty program. Check the Airline information reference.", "example": "GOLD" }, "phone": { "type": "object", "description": "Specifies the phone object for the passenger.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the passenger's phone (MAX 3; MIN 1).", "example": "57" }, "number": { "type": "string", "description": "The passenger's phone number, without the country code (MAX 32; MIN 1).", "example": "3001234567" } } } } } }, "tickets": { "type": "array", "description": "Specifies the array of ticket objects.", "items": { "type": "object", "properties": { "passenger_id": { "type": "string", "description": "Reference to passenger ID (MAX 128; MIN 1).", "example": "passenger_001" }, "ticket_number": { "type": "string", "description": "Ticket number (MAX 14; MIN 1).", "example": "12345678901234" }, "e_ticket": { "type": "boolean", "description": "Is this an e-ticket?", "example": true }, "restricted": { "type": "boolean", "description": "Indicates if the ticket is refundable or not.", "example": false }, "total_fare_amount": { "type": "number", "description": "Total fare amount in the smallest unit of currency (multiple of 0.0001).", "format": "float", "example": 50000 }, "total_tax_amount": { "type": "number", "description": "Total taxes amount in the smallest unit of currency (multiple of 0.0001).", "format": "float", "example": 5000 }, "total_fee_amount": { "type": "number", "description": "Total fee amount in the smallest unit of currency (multiple of 0.0001).", "format": "float", "example": 1000 } } } } } } }, "seller_details": { "type": "object", "description": "Specifies the seller's details object. ", "properties": { "name": { "type": "string", "description": "The seller's legal name (MAX 255; MIN 3)." }, "email": { "type": "string", "description": "The seller's e-mail (MAX 255; MIN 3)." }, "reference": { "type": "string", "description": "The seller's identification code (MAX 255; MIN 3)." }, "website": { "type": "string", "description": "The seller's website URL (MAX 255; MIN 3)." }, "industry": { "type": "string", "description": "The seller's industry (MAX 235; MIN 1) For more information access the [Industry category reference page](/reference/industry-category-list).", "enum": [ "ADVERTISING", "ART", "AUTOMOTIVE", "ANTIVIRUS", "BABY", "BEAUTY_&_PERSONAL_CARE", "BOOKS", "CAMERAS", "CAR_ELECTRONICS", "COMPUTING", "COUPONS", "DONATIONS", "DELIVERY", "ELECTRONICS", "ENTERTAINMENT", "EDUCATION", "FASHION", "GAMES", "GARDEN_&_OUTDOOR", "GROCERY_&_GOURMET_FOOD", "HANDMADE", "HOME", "INDUSTRIAL_&_SCIENTIFIC", "INVESTING_AND_FINANCIAL", "LEARNINGS", "MUSICAL", "OTHERS", "PET_SUPPLIES", "PHONES", "PAYROLL", "SERVICES", "SAAS", "TELEVISION", "STREAMING", "TICKETS", "TOYS_&_GAMES", "TRAVELS", "VIDEO_GAMES", "VIRTUAL_GOODS", "" ] }, "merchant_category_code": { "type": "string", "description": "MCC - The merchant category code (MAX 235; MIN 1)." }, "country": { "type": "string", "description": "The seller's country (MAX 255; MIN 2; [ISO 3166-1](/reference/country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "document": { "type": "object", "description": "Specifies the document object of the seller.", "properties": { "document_number": { "type": "string", "description": "The seller's document number (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "The seller's document type (MAX 6, MIN 2; [Document Type List](https://docs.y.uno/reference/country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] } } }, "phone": { "type": "object", "description": "Specifies the seller's phone number object.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the seller's phone (MAX 3; MIN 1). Check the [Country reference](country-reference) to see the phone codes." }, "number": { "type": "string", "description": "The seller's phone number, without the country code (MAX 32; MIN 1)." } } }, "address": { "type": "object", "description": "Specifies the seller's address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary address line of the seller (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the seller (MAX 255; MIN 3)." }, "building_number_1": { "type": "string", "description": "The primary building number of the customer (MAX 255; MIN 3)" }, "building_number_2": { "type": "string", "description": "The secondary building number of the customer (MAX 255; MIN 3)" }, "city": { "type": "string", "description": "The city considered for the seller's address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the seller's address (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "state": { "type": "string", "description": "The state considered for the seller's address (MAX 255; MIN 1)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the seller's address (MAX 11; MIN 4)." } }, "required": [ "address_line_1", "city", "country" ] } }, "required": [ "address" ] } }, "required": [ "seller_details" ] }, "country": { "type": "string", "description": "Country where the transaction must be processed (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "merchant_reference": { "type": "string", "description": "Identification of the payment transaction defined by the merchant (MAX 255; MIN 3). Optional to complement the merchant_order_id." }, "customer_payer": { "type": "object", "description": "Specifies customer object for payments.", "properties": { "id": { "type": "string", "description": "The unique identifier of the customer (UUID, 36 chars). This `id` is returned in Yuno's [Create Customer](/reference/create-customer) endpoint. This object is not mandatory for DIRECT payments. If the `id` of a customer is sent, it is not necessary to complete the rest of the `customer_payer` object, the information of the previously created customer will be taken into account for the payment.
Example: `be8a1640-43d2-4a75-9694-c6468d82cba3`." }, "merchant_customer_id": { "type": "string", "description": "The unique identifier for a customer in the merchant's system, assigned by the merchant (MAX 255; MIN 1)." }, "merchant_customer_created_at": { "type": "string", "description": "Customer´s registration date on the merchants platform (ISO 8601 MAX 27; MIN 27)", "format": "date-time" }, "merchant_customer_validations": { "type": "object", "description": "Fraud validations for the customer payer", "properties": { "account_is_verified": { "type": "boolean", "description": "If the customer's account has been validated before on the merchant's side. True by default", "default": true }, "email_is_verified": { "type": "boolean", "description": "If the customer's email has been validated before on the merchant's side. True by default", "default": true }, "phone_is_verified": { "type": "boolean", "description": "If the customer's phone has been validated before on the merchant's side. True by default", "default": true } } }, "first_name": { "type": "string", "description": "The customer's first name (MAX 255; MIN 1)." }, "last_name": { "type": "string", "description": "The customer's last name (MAX 255; MIN 1)." }, "gender": { "type": "string", "description": "The customer's gender (MAX 2; MIN 1; (M=Male/F=Female/NB=Non Binary/NA=Not applicable/NK=Not Known/U=Undefined)).", "enum": [ "M", "F", "NB", "NA", "NK", "U" ] }, "date_of_birth": { "type": "string", "description": "The customer's date of birth in the YYYY-MM-DD format (Length: 10).", "format": "date" }, "email": { "type": "string", "description": "The customer's e-mail (MAX 255; MIN 1)." }, "nationality": { "type": "string", "description": "The customer's nationality (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "ip_address": { "type": "string", "description": "The customer's IP address (MAX 45; MIN 1)." }, "device_fingerprints": { "type": "array", "description": "The customer's [device fingerprints](/docs/direct-flow#important-add-ons) (MAX 4000; MIN 1). In case you are using a DIRECT integration and want to support fraud providers in the payment flow, you can use this object to specify the necessary information. For integrations using Yuno checkout the value is obtained automatically, do not send this field.", "items": { "properties": { "provider_id": { "type": "string", "description": "The fraud screening provider id", "enum": [ "CLEARSALE", "CYBERSOURCE", "RISKIFIED", "SIGNIFYD", "VESTA", "KONDUTO", "BAYONET", "MERCADO_PAGO", "OPEN_PAY" ] }, "id": { "type": "string", "description": "The device fingerprint associated to the provider" } }, "required": [ "provider_id", "id" ], "type": "object" } }, "browser_info": { "type": "object", "description": "Specifies the browser_info object.", "properties": { "user_agent": { "type": "string", "description": "The user agent value of the customer's browser (MAX 255; MIN 3)." }, "accept_header": { "type": "string", "description": "The accept header value of the customer's browser." }, "platform": { "type": "string", "description": "The platform from which the customer is making the payment.", "enum": [ "WEB", "IOS", "ANDROID" ] }, "color_depth": { "type": "string", "description": "The color depth of the customer's browser in bits per pixel. This should be obtained by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth. (MAX 5; MIN 1)." }, "screen_height": { "type": "string", "description": "The total height of the customer's device screen in pixels. (MAX 255; MIN 3)." }, "screen_width": { "type": "string", "description": "The total width of the customer's device screen in pixels. (MAX 255; MIN 3)." }, "javascript_enabled": { "type": "boolean", "description": "Indicates if Javascript is enabled or not in the device." }, "language": { "type": "string", "description": "The navigator.language value of the customer's browser (as defined in IETF BCP 47) (MAX 5; MIN 1)." }, "accept_browser": { "type": "string", "description": "The accept browser value of the customer's browser" }, "accept_content": { "type": "string", "description": "The accept content value of the customer's browser" }, "java_enabled": { "type": "boolean", "description": "Indicates if Java is enabled or not in the device" }, "browser_time_difference": { "type": "string", "description": "Indicates the browser time difference" } } }, "document": { "type": "object", "description": "Specifies the customer's document object, including its number and type.", "properties": { "document_number": { "type": "string", "description": "Document number for customer (MAX 40; MIN 3). This field is required if the 'document' object is included in the request." }, "document_type": { "type": "string", "description": "The customer's document type (MAX 6, MIN 2; [Country reference](/reference/country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] } } }, "billing_address": { "type": "object", "description": "Specifies the customer's billing address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 3). This field is required if the 'billing_address' object is included in the request." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 3)." }, "building_number_1": { "type": "string", "description": "The primary building number of the customer (MAX 255; MIN 3)." }, "building_number_2": { "type": "string", "description": "The secondary building number of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 3). This field is required if the 'billing_address' object is included in the request." }, "country": { "type": "string", "description": "The country considered for the billing address (MAX 2; MIN 2; [ISO 3166-1](country-reference)). This field is required if the 'billing_address' object is included in the request.", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "state": { "type": "string", "description": "State or province code. Use ISO 3166-2 subdivision codes (https://en.wikipedia.org/wiki/ISO_3166-2)." }, "zip_code": { "type": "string", "description": "The zip code considered for the billing address (MAX 10; MIN 5)." }, "neighborhood": { "type": "string", "description": "The neighborhood of the address line of the customer (MAX 255; MIN 2)" } } }, "shipping_address": { "type": "object", "description": "Specifies the customer's shipping address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary shipping address line of the customer (MAX 255; MIN 3). This field is required if the 'shipping_address' object is included in the request." }, "address_line_2": { "type": "string", "description": "The secondary shipping address line of the customer (MAX 255; MIN 3)." }, "building_number_1": { "type": "string", "description": "The primary building number of the customer (MAX 255; MIN 3)." }, "building_number_2": { "type": "string", "description": "The secondary building number of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the shipping address (MAX 255; MIN 3). This field is required if the 'shipping_address' object is included in the request." }, "country": { "type": "string", "description": "The country considered for the shipping address (MAX 2; MIN 2; [ISO 3166-1](country-reference)). **[Required]**.", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "state": { "type": "string", "description": "State or province code. Use ISO 3166-2 subdivision codes (https://en.wikipedia.org/wiki/ISO_3166-2)." }, "zip_code": { "type": "string", "description": "The zip code considered for the shipping address (MAX 10; MIN 5)." }, "neighborhood": { "type": "string", "description": "The neighborhood of the address line of the customer (MAX 255; MIN 2)" } } }, "phone": { "type": "object", "description": "Specifies the customer's phone number object.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the customer's phone (MAX 3; MIN 1). Check the [Country reference](country-reference) to see the phone codes. This field is required if the 'phone' object is included in the request." }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1). This field is required if the 'phone' object is included in the request." } } }, "geolocation": { "type": "object", "description": "Customer's geolocation.", "properties": { "latitude": { "type": "string", "description": "Angular distance of a location on the earth south or north of the equator (MIN: 1, MAX:11)" }, "longitude": { "type": "string", "description": "Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory. (MIN: 1, MAX:11)" } } } } }, "workflow": { "type": "string", "description": "The payment workflow. Indicates whether the integration will use Yuno´s SDK or will be a back to back connection. [Guides](/docs/sdks/overview/quickstart) ", "default": "SDK_CHECKOUT", "enum": [ "SDK_CHECKOUT", "CHECKOUT", "REDIRECT", "DIRECT", "SDK_SEAMLESS" ] }, "payment_method": { "type": "object", "description": "The payment method object.", "properties": { "token": { "type": "string", "description": "The one time use payment method token **provided by Yuno sdk**. If a payment is created using a token, it is not necessary to send a vaulted_token as well, it can be defined as null. Not necessary for back to back payments (MAX: 64; MIN: 36)." }, "vaulted_token": { "type": "string", "description": "The vaulted token for a **previously stored payment_method**. If a payment is created using a vaulted_token, it is not necessary to send a token as well, it can be defined as null (MAX: 64; MIN: 36)." }, "type": { "type": "string", "description": "Type of the payment method. Only required for `DIRECT` or `REDIRECT` workflow. Required when integrating wallets, even when using the SDK.", "enum": [ "ACUOTAZ", "ADDI", "APPLE_PAY", "BANCOLOMBIA_TOKEN_BOX", "BANCOLOMBIA_TRANSFER", "CARD", "CASH", "CODI", "DAVIPLATA", "EFECTY", "GOOGLE_PAY", "MERCADO_PAGO_CHECKOUT_PRO", "MERCADO_PAGO_WALLET", "NEQUI", "NU_PAY", "NU_PAY_ENROLLMENT", "OXXO", "PAYPAL", "PAYVALIDA", "PIX", "PSE", "SAFETYPAY", "SPEI", "TARJETA_CLAVE", "WEBPAY", "WIBOND", "CRYPTO" ] }, "detail": { "type": "object", "description": "Specifies the payment method detail object.", "properties": { "card": { "type": "object", "description": "Specifies the card object.", "properties": { "capture": { "type": "boolean", "description": "Determines whether the card payment is captured immediately (`TRUE` = purchase) or only authorized (`FALSE` = requires capture or cancel)." }, "delayed_capture_settings": { "type": "object", "description": "Configuration for automatically capturing the full authorized amount after a delay. Only valid when capture = `FALSE`.", "properties": { "delay": { "type": "string", "description": "Delay before Yuno performs the capture (ISO 8601 format).", "example": "P20D" }, "simplified_mode": { "type": "boolean", "description": "If true, Yuno retries the capture if it fails." } } }, "delayed_cancel_settings": { "type": "object", "description": "Configuration for automatically canceling the authorization after a delay. Only valid when capture = `FALSE`.", "properties": { "delay": { "type": "string", "description": "Delay before Yuno performs the cancel (ISO 8601 format).", "example": "P20D" }, "simplified_mode": { "type": "boolean", "description": "If true, Yuno retries the capture if it fails." } } }, "installments": { "type": "integer", "description": "The card installments.", "format": "int32" }, "first_installment_deferral": { "type": "integer", "description": "Number of months to be waited to debit the first installment.", "format": "int32" }, "soft_descriptor": { "type": "string", "description": "Statement descriptor passed per transaction. It is presented on the cardholder's bank statement (MAX 255). For merchant-initiated (MIT) recurring charges, set it on each payment; for Yuno subscription-engine rebills, set it on the subscription instead. Behavior and length limits vary by provider. See [Statement descriptor on recurring payments](/docs/payment-features/subscriptions/soft-descriptor)." }, "card_data": { "type": "object", "description": "Specifies the card_data object.", "required": [ "number", "holder_name" ], "properties": { "number": { "type": "string", "description": "Card's number without any separators. (MAX 19; MIN 8) - only available for PCI certified merchants." }, "expiration_month": { "type": "integer", "description": "Card's expiration month - MM (MAX 2; MIN 2) - only available for PCI certified merchants.", "format": "int32" }, "expiration_year": { "type": "integer", "description": "Card's expiration year - YYYY (MAX 4; MIN 2) - only available for PCI certified merchants.", "format": "int32" }, "security_code": { "type": "string", "description": "Card's security code (MAX 4; MIN 3) - only available for PCI certified merchants." }, "holder_name": { "type": "string", "description": "Cardholder's full name as it appears on the card (MAX 26; MIN 3) - only available for PCI certified merchants." }, "type": { "type": "string", "description": "The card type. For dual cards (like in Brazil), you can specify the type of card that is being processed so we can inform the providers.", "enum": [ "CREDIT", "DEBIT" ] } } }, "network_token": { "type": "object", "description": "The network token object. Only available for merchants that handle the network token generation/management from their side. [Direct Network token guide](https://docs.y.uno/docs/network-tokens#2--use-your-existing-network-tokens)", "properties": { "token_data": { "type": "object", "description": "Specifies the token_data object.", "required": [ "number", "expiration_month", "expiration_year", "cryptogram" ], "properties": { "number": { "type": "string", "description": "[Mandatory] - Token's number without any separators. (MAX 19; MIN 8) - only available for PCI certified merchants" }, "holder_name": { "type": "string", "description": "Cardholder's full name as it appears on the Token (MAX 26; MIN 3)" }, "expiration_month": { "type": "string", "description": "Token's expiration month - MM (MAX 2; MIN 2)" }, "expiration_year": { "type": "string", "description": "Token's expiration year - YYYY (MAX 4; MIN 4) - only available for PCI certified merchants" }, "cryptogram": { "type": "string", "description": "[Mandatory] - The unique cryptogram generated by the issuer for the network token in use in the transaction." }, "electronic_commerce_indicator": { "type": "string", "description": "[Only required for certain providers] - In case the token has been authenticated by Mastercard the field should be set to 02. For Visa or not authenticated tokens, is not necessary to send the field." }, "token_requestor_id": { "type": "string", "description": "[Only required for certain providers] - Token requestor ID of the merchant" } } } } }, "three_d_secure": { "type": "object", "description": "3DS secure information", "properties": { "three_d_secure_setup_id": { "type": "string", "description": "The identifier returned by [POST /v1/three-d-secure/setups](/reference/three-d-secure-setups/create-three-d-secure-setup). Required when using 3D Secure 2 (3DS2) authentication in a server-to-server integration where you collect browser and device data on your side." }, "version": { "type": "string", "description": "[Optional for 3DS integration without Yuno's JS] - Refers to the protocol version of the EMV 3-D Secure specification used. 1.0, 2.0, 2.1.0, 2.2.0, 2.2.1, 2.3.0 y 2.3.1", "enum": [ "1.0", "2.0", "2.1.0", "2.2.0", "2.2.1", "2.3.0", "2.3.1" ] }, "electronic_commerce_indicator": { "type": "string", "description": "[Optional for 3DS integration without Yuno's JS] - This field must be completed with the result of the ECI field provided by the 3d Secure service. The Electronic Commerce Indicator (ECI) informs the card issuer if the transaction was protected by a security protocol like VbV or MCSC. It is mandated by Visa and MasterCard that all 3-D Secure transactions have this value populated in the authorization request. (Min: 0, max: 2)." }, "cryptogram": { "type": "string", "description": "[Optional for 3DS integration without Yuno's JS] - This field must be completed with the result of the cryptogram field provided by the 3DSecure service. In Visa transactions, it represents the Cardholder Authentication Verification Value (CAVV), a cryptographic value generated by the Issuer as evidence of payment authentication during online purchase to qualify for chargeback protection. MasterCard transactions have a similar value called Accountholder Authentication Value (AAV) or the Universal Cardholder Authentication Field (UCAF). When submitting a transaction for authorization, the merchant must include the CAVV or AAV/UCAF to demonstrate that the cardholder has been authenticated. It is typically base64-encoded. (Min: 0, Max: 40)." }, "transaction_id": { "type": "string", "description": "[Optional for 3DS integration without Yuno's JS] - For 3DS v1: This is the Unique Transaction Identifier. It is automatically generated by the MPI. It is typically 28 bytes in length and base64-encoded. Is commonly referred to as XID. (Min: 0, Max: 40). For 3DS v2: Universally unique transaction identifier assigned by the DS to identify a single transaction. (Min: 36, Max:36)." }, "directory_server_transaction_id": { "type": "string", "description": "[Optional for 3DS integration without Yuno's JS] - Transaction ID generated by the Mastercard directory server during authentication (MAX 255; MIN 3)." } } }, "verify": { "type": "boolean", "description": "Using amount = 0 and verify = true, you can verify the user's card without authorizing a real amount. If the field is not sent, we will take it as false.", "default": false }, "acquirer_reference_number": { "type": "string", "description": "Unique identifier assigned by the card acquirer to track the transaction through the card network. Used for reconciliation and chargebacks." }, "stored_credentials": { "type": "object", "description": "Indicates the processing type of the transaction. Refer to the Stored credentials documentation for more information.", "properties": { "reason": { "type": "string", "description": "Indicates the processing type of the transaction.", "enum": [ "CARD_ON_FILE", "SUBSCRIPTION", "UNSCHEDULED_CARD_ON_FILE" ] }, "usage": { "type": "string", "description": "This field Iets you indicate if this is the first time the vaulted_token/network_token is used for a payment.", "enum": [ "FIRST", "USED" ] }, "subscription_agreement_id": { "type": "string", "description": "This field lets you indicate the identification of the agreement with the customer for a subscription. Mainly for MX.(MAX 255; MIN 3). [Stored credentials](/docs/stored-credentials)" }, "network_transaction_id": { "type": "string", "description": "Unique identifier assigned to a transaction by the card network. It is used to track and reference specific transactions, particularly in recurring payment scenarios, ensuring consistency and traceability across the payment lifecycle. (MAX 255; MIN 3). [Stored credentials](/docs/stored-credentials)" } } }, "external_providers_data": { "type": "array", "description": "Array of provider-issued tokens for inline card payments. Use when a provider-issued token is available for this single payment without prior enrollment. Mutually exclusive with raw card data (`card_data.number`, `card_data.security_code`, etc.). Minimum 1 item, maximum 5. Each `(provider_id, connection_id)` pair must be unique.", "minItems": 1, "maxItems": 5, "items": { "type": "object", "required": [ "connection_id", "provider_id", "provider_token" ], "properties": { "connection_id": { "type": "string", "format": "uuid", "description": "The Yuno connection / account-integration identifier that owns the token." }, "provider_id": { "type": "string", "description": "Provider identifier (e.g., `ADYEN`, `CHECKOUT`)." }, "provider_token": { "type": "string", "description": "The token issued by the provider for this card." } } } } } }, "ticket": { "type": "object", "description": "Specifies the ticket object", "properties": { "benefit_type": { "type": "string", "description": "Specifies the user's benefit type for Pluxee Chile.", "enum": [ "PRIVATE", "JUNAEB" ] }, "expires_at": { "type": "string", "description": "Payment methods expiration date. \"yyyy-MM-dd HH:mm:ss.SSSz\". Only available when the provider associated to the payment supports it. Please feel free to reach out to your technical account manager for further questions.", "format": "date-time" } } }, "wallet": { "type": "object", "description": "Specifies the wallet object", "properties": { "payment_token": { "type": "string", "description": "Complete wallet response payload as a JSON string, exactly as returned by the wallet provider" }, "expires_at": { "type": "string", "description": "Payment methods expiration date. \"yyyy-MM-dd HH:mm:ss.SSSz\". Only available when the provider associated to the payment supports it. Please feel free to reach out to your technical account manager for further questions.", "format": "date-time" }, "capture": { "type": "boolean", "description": "Indicates whether the wallet payment should be captured immediately (true) or only authorized for later capture (false)" }, "soft_descriptor": { "type": "string", "description": "Statement descriptor passed per transaction. It is presented on the cardholder's bank statement (MAX 255). Apple Pay / Google Pay rebills ride the card / network-token rail, so the descriptor is applied the same way as for cards. Behavior and length limits vary by provider. See [Statement descriptor on recurring payments](/docs/payment-features/subscriptions/soft-descriptor)." }, "domain_url": { "type": "string", "description": "Registered domain used during the wallet flow. (MAX 255; MIN 3)." }, "verify": { "type": "boolean", "description": "Enables card verification flow through the wallet. When true, a verification transaction (e.g., zero-dollar auth) is performed instead of a regular payment." }, "stored_credentials": { "type": "object", "description": "Indicates the processing type of the transaction. Refer to the Stored credentials documentation for more information.", "properties": { "reason": { "type": "string", "description": "Indicates the processing type of the transaction.", "enum": [ "CARD_ON_FILE", "SUBSCRIPTION", "UNSCHEDULED_CARD_ON_FILE" ] }, "usage": { "type": "string", "description": "This field Iets you indicate if this is the first time the vaulted_token/network_token is used for a payment.", "enum": [ "FIRST", "USED" ] }, "subscription_agreement_id": { "type": "string", "description": "This field lets you indicate the identification of the agreement with the customer for a subscription. Mainly for MX.(MAX 255; MIN 3). [Stored credentials](/docs/stored-credentials)" }, "network_transaction_id": { "type": "string", "description": "Unique identifier assigned to a transaction by the card network. It is used to track and reference specific transactions, particularly in recurring payment scenarios, ensuring consistency and traceability across the payment lifecycle. (MAX 255; MIN 3). [Stored credentials](/docs/stored-credentials)" }, "additional_data": { "type": "object", "description": "This structure is used to send additional information about recurrence. It's optional, and few providers require it (e.g. Mercado Pago). Contact your TAM to confirm if it's needed for your integration.", "properties": { "billing_cycles": { "type": "object", "description": "Specifies the `billing_cycles` object. Defines the number of charges associated to the subscription. If using this object, you must enter data on all fields.", "properties": { "current": { "type": "integer", "example": 1 }, "total": { "type": "integer", "description": "The total number of billing cycles for the subscription (MIN 1).", "format": "int32" } } }, "frequency": { "type": "object", "description": "Specifies the frequency type (e.g., DAY, WEEK, MONTH, YEAR) and value. Enter data on all fields if using this object.", "properties": { "type": { "type": "string", "example": "MONTH", "description": "Specifies the frequency type (e.g., DAY, WEEK, MONTH, YEAR)." }, "value": { "type": "string", "description": "Specifies the frequency value." } } }, "availability": { "type": "object", "description": "Specifies the `availability` object. Defines a date interval based on starting and ending dates when the subscription is available to use.", "properties": { "start_at": { "type": "string", "description": "The start date that the subscription plan will be available to use. If not set, the subscription is available from the moment it is created. `start_at` becomes mandatory when using `finish_at`.", "format": "date-time" }, "finish_at": { "type": "string", "description": "The end date until the subscription plan will be available to use. If not defined, the subscription does not have an expiration date. `finish_at` becomes mandatory when using `start_at`.", "format": "date-time" } } } } } } }, "card_data": { "type": "object", "description": "Card information provided by the merchant for the wallet payment.", "properties": { "lfd": { "type": "string", "description": "Last four digits of the cardholder's real card (FPAN), exactly 4 numeric digits. Google Pay server-to-server only: for CRYPTOGRAM_3DS device tokens the encrypted token decrypts to the DPAN, so send the value from paymentMethodData.info.cardDetails in Google's response and Yuno uses it in place of the DPAN-derived last four. Ignored for PAN_ONLY credentials and for other wallets. See [Card last four digits for device tokens](/docs/wallets/google-pay/google-pay-direct-integration#card-last-four-digits-for-device-tokens)." } } } } }, "bank_transfer": { "type": "object", "description": "Specifies the bank transfer object.", "properties": { "pre_debit_notification_id": { "type": "string", "format": "uuid", "description": "ID of the pre-debit notification that precedes this recurring debit, as returned by the Create pre-debit notification endpoint. Required for UPI Autopay recurring debits (NPCI compliance). Yuno validates that the notification exists, belongs to your account, and is in SENT status; otherwise the payment is rejected with PRE_DEBIT_NOTIFICATION_NOT_FOUND or PRE_DEBIT_NOTIFICATION_NOT_SENT (422)." }, "soft_descriptor": { "type": "string", "description": "Human-readable reference associated with the bank transfer. Commonly used for reconciliation and operational purposes (MAX 255; MIN 1)." }, "expires_at": { "type": "string", "description": "Payment methods expiration date. \"yyyy-MM-dd HH:mm:ss.SSSz\". Only available when the provider associated to the payment supports it. Please feel free to reach out to your technical account manager for further questions.", "format": "date-time" }, "account_type": { "type": "string", "description": "Type of the bank account (MAX 255; MIN 3). CHECKINGS/SAVINGS", "enum": [ "CHECKINGS", "SAVINGS" ] }, "bank_account": { "type": "string", "description": "The number of the bank account (MAX 255; MIN 3).", "minLength": 3, "maxLength": 255 }, "bank_id": { "type": "string", "description": "Identifier of the bank selected for the transfer when the provider requires choosing one." }, "routing_number": { "type": "string", "description": "The routing_number of the bank account (MAX 255; MIN 3).", "minLength": 3, "maxLength": 255 }, "code": { "type": "string", "description": "The beneficiary's specific financial institution code (MAX 8)." }, "branch": { "type": "string", "description": "The beneficiary's specific financial institution branch (MAX 8)." }, "branch_digit": { "type": "string", "description": "The beneficiary's specific financial institution branch digit (MAX 2)." }, "beneficiary_name": { "type": "string", "description": "Name of the account holder (MAX 255; MIN 3).", "minLength": 3, "maxLength": 255 }, "beneficiary_type": { "type": "string", "description": "Type of the beneficiary (MAX 255; MIN 3).", "enum": [ "INDIVIDUAL", "ENTITY" ] }, "third_party_token_id": { "type": "string", "description": "Tokenized ID of the destination account (MAX 255; MIN 3)." }, "account_holder_type": { "type": "string", "description": "Bank account holder type (for ACH payments).", "enum": [ "INDIVIDUAL", "COMPANY" ] }, "stored_credentials": { "type": "object", "description": "Indicates the processing type of the transaction. Refer to the [stored credentials](/docs/stored-credentials#create-a-payment-with-processing-type) documentation for more information.", "properties": { "reason": { "type": "string", "description": "Indicates the processing type of the transaction.", "enum": [ "SUBSCRIPTION" ] }, "usage": { "type": "string", "description": "This field Iets you indicate if this is the first time the vaulted_token/network_token is used for a payment.", "enum": [ "FIRST", "USED" ] }, "subscription_agreement_id": { "type": "string", "description": "This field lets you indicate the identification of the agreement with the customer for a subscription (MAX 255; MIN 3). See [Stored credentials](/docs/stored-credentials) for more info." }, "additional_data": { "type": "object", "properties": { "billing_cycles": { "type": "object", "properties": { "current": { "type": "string", "description": "Current billing cycles for the subscription." }, "total": { "type": "string", "description": "The total number of billing cycles for the subscription." } }, "description": "Defines the number of charges associated to the subscription. If using this object, you must enter data on all fields." }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "description": "Specifies the frequency type (e.g., DAY, WEEK, MONTH, YEAR)." }, "value": { "type": "string", "description": "Specifies the frequency value." } }, "description": "Specifies the frequency type (e.g., DAY, WEEK, MONTH, YEAR) and value. Enter data on all fields if using this object." }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "description": "The start date that the subscription plan will be available to use. If not set, the subscription is available from the moment it is created. `start_at` becomes mandatory when using `finish_at`." }, "finish_at": { "type": "string", "description": "The end date until the subscription plan will be available to use. If not defined, the subscription does not have an expiration date. `finish_at` becomes mandatory when using `start_at`." } }, "description": "Defines a date interval based on starting and ending dates when the subscription is available to use." } }, "description": "This object is used to send additional information about recurrence." } } }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } }, "strong_customer_authentication_exemptions": { "type": "array", "description": "Array of Strong Customer Authentication (SCA) exemptions that can be applied to the transaction to reduce friction while maintaining security compliance.", "items": { "type": "string", "enum": [ "LOW_VALUE", "TRANSACTION_RISK_ANALYSIS", "STRONG_CUSTOMER_AUTHENTICATION", "OUT_OF_SCOPE", "SECURE_CORPORATE", "TRUSTED_BENEFICIARY", "RECURRING_PAYMENT", "NO_PREFERENCE", "TRANSACTION_RISK_ASSESSMENT" ] } } } }, "vault_on_success": { "type": "boolean", "description": "Flag to enroll the card after a successful payment (requires `customer_payer.id`)." }, "account_updater": { "type": "boolean", "description": "Per-card control for Card Account Updater. When set to `false`, the card enrolled or used in this payment is excluded from Card Account Updater and will not receive automatic card-detail updates. When omitted, the card follows your account's Account Updater configuration." }, "otp": { "type": "object", "properties": { "is_required": { "type": "boolean", "description": "Specifies if a one time password is required in the flow", "default": "false" } }, "description": "Specifies the OTP object." } }, "if": { "properties": { "type": { "enum": [ "NU_PAY", "NU_PAY_ENROLLMENT", "APPLE_PAY", "GOOGLE_PAY" ] } } }, "then": { "required": [ "type" ] } }, "subscription": { "type": "object", "description": "Specifies the subscription object.", "properties": { "frequency": { "type": "object", "description": "Specifies the frequency object (used when creating a payment along with the subscription).", "required": [ "type", "execution" ], "properties": { "type": { "type": "string", "description": "Frequency of the subscription payment.", "enum": [ "MONTH" ] }, "value": { "type": "integer", "description": "Number of `type` units between charges. Always send it when creating a subscription — omitting it is not rejected up front, the payment is charged and the subscription creation then fails. Whole numbers only." }, "execution": { "type": "string", "description": "Indicates if the payment is made by Yuno or the merchant.", "enum": [ "YUNO", "MERCHANT" ] } } }, "availability": { "type": "object", "description": "Specifies the availability object (used when creating a payment along with the subscription).", "properties": { "start_at": { "type": "string", "description": "Start date of the subscription in UTC time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), MAX 27; MIN 27).", "format": "date-time" }, "finish_at": { "type": "string", "description": "End date of the subscription in UTC time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), MAX 27; MIN 27).", "format": "date-time" } } }, "amount": { "type": "object", "description": "Specifies the amount object (used when creating a payment along with the subscription).", "required": [ "value", "currency", "type" ], "properties": { "value": { "type": "number", "description": "The amount of each recurring charge. When `type` is `FIXED` this must equal the payment's `amount.value`, otherwise the request is rejected with `400` before any charge.", "format": "float" }, "currency": { "type": "string", "description": "The currency used to make the payment. Must match the payment's `amount.currency`, otherwise the request is rejected with `400` before any charge. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "type": { "type": "string", "description": "Type of the subscription payment", "enum": [ "FIXED", "VARIABLE" ] } } }, "billing_cycles": { "type": "object", "description": "Specifies the billing cycles object (used when creating a payment along with the subscription).", "properties": { "total": { "type": "integer", "minimum": 1, "description": "Total number of cycles to bill before the subscription completes. Validated after the charge — a value lower than 1 leaves the payment charged and the subscription not created." } } }, "id": { "type": "string", "description": "Identifier of an existing subscription to charge (omit when creating a new one)." }, "billing_date": { "type": "object", "description": "Specifies the billing date object (used when creating a payment for an existing subscription). Ignored when a new subscription is created.", "properties": { "type": { "type": "string", "description": "Type of the billing date" }, "day": { "type": "integer", "minimum": 1, "maximum": 31, "description": "Day of the month when the subscription payment is made" } } } } }, "callback_url": { "type": "string", "description": "The URL where to redirect the customer after the payment. Only required for DIRECT integrations that have a redirection (MAX 526; MIN 3)." }, "fraud_screening": { "type": "object", "description": "Fraud screening object.", "properties": { "stand_alone": { "type": "boolean", "description": "Optional field to send in the payment indicating if the fraud screening is stand alone, meaning that a payment will not be excecuted after the fraud screening is made. You can use this field while creating your CARD route." } } }, "split_marketplace": { "type": "array", "description": "Split marketplace array of objects", "items": { "properties": { "recipient_id": { "type": "string", "description": "The unique identifier of the recipient in the Yuno system.
You must provide the [`recipient_id`](/reference/create-recipient-1) (Yuno-generated) or the `provider_recipient_id` (external provider's ID) when creating a payment." }, "provider_recipient_id": { "type": "string", "description": "The recipient ID provided by the external payment provider, if applicable.
You must provide the `provider_recipient_id` or the [`recipient_id`](/reference/create-recipients) (Yuno-generated) when creating a payment." }, "description": { "type": "string", "description": "Description for the split. (MAX 255; MIN 3)." }, "type": { "type": "string", "description": "The type of split. `recipient_id` is mandatory for `PURCHASE` and `MARKETPLACE`.", "enum": [ "PURCHASE", "PAYMENTFEE", "VAT", "COMMISSION", "MARKETPLACE", "SHIPPING" ] }, "merchant_reference": { "type": "string", "description": "Optional unique identifier for the split transaction (MAX 255; MIN 3)." }, "recipient_type": { "type": "string", "description": "The type of recipient for the provider.", "enum": [ "MEAL", "FOOD", "MULTI_BENEFITS", "FLEET" ], "example": "MEAL" }, "amount": { "type": "object", "description": "Defines the amount of the split. This field is optional if the recipient has a `split_configuration` defined, as the amount will be calculated automatically.", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The split amount (multiple of 0.0001).", "format": "float" }, "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." } } }, "liability": { "type": "object", "description": "Optional information regarding the recipient's liability for fees and chargebacks.", "properties": { "processing_fee": { "type": "string", "description": "Indicates who will be charged the transaction fee.", "enum": [ "MERCHANT", "RECIPIENT", "SHARED" ] }, "chargebacks": { "type": "boolean", "description": "The recipient is responsible in case of a chargeback." } } } }, "required": [ "type" ], "type": "object" } }, "metadata": { "type": "array", "description": "Custom key–value tags to track this payment or add context (e.g., order_id, invoice, campaign). Up to 120 items.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48. Value: MIN:1, MAX:48). **[Case Sensitive]**" }, "value": { "type": "string", "description": "The metadata key value (MAX 512. Value: MIN:1, MAX:512). **[Case Sensitive]**" } }, "required": [ "key", "value" ], "type": "object" } } } }, "examples": { "Example - Placeholders": { "value": { "description": "Test Payment", "account_id": "{{account-code}}", "merchant_order_id": "AA01", "merchant_reference": "Test_AAB", "country": "US", "additional_data": { "airline": { "legs": [ { "arrival_airport": "AMS", "base_fare": 200, "base_fare_currency": "USD", "carrier_code": "KL", "departure_airport": "EZE", "departure_airport_timezone": "-03:00", "departure_datetime": "2024-07-03T05:00:00", "arrival_datetime": "2024-08-03T05:00:00", "fare_basis_code": "HL7LNR", "fare_class_code": "FR", "flight_number": "842", "stopover_code": "s" } ], "passengers": [ { "country": "US", "date_of_birth": "1984-05-01", "document": { "document_number": "123456789", "document_type": "SSN", "country": "US" }, "phone": { "country_code": "1", "number": "5551234567" }, "first_name": "John", "last_name": "Doe", "loyalty_number": "123456", "loyalty_tier": "GOLD", "middle_name": "Theodore", "nationality": "US", "type": "s" } ], "pnr": "1P-2UUGJW", "tickets": [ { "ticket_number": "123456", "restricted": false, "total_fare_amount": 80, "total_tax_amount": 22, "total_fee_amount": 14, "issue": null, "e_ticket": false } ] }, "order": { "fee_amount": 100, "tip_amount": 50, "items": [ { "brand": "XYZ", "category": "Clothes", "id": "123AD", "manufacture_part_number": "XYZ123456", "image_url": "https://cdn.example.com/img/skirt-01.jpg", "name": "Skirt", "quantity": 1, "sku_code": "8765432109", "unit_amount": 4800 } ], "shipping_amount": 50 }, "seller_details": { "name": "Test_company", "email": "testcompany@example.com", "reference": "AAOO", "website": "www.testcompany.com", "industry": "ELECTRONICS", "merchant_category_code": "TTRR", "country": "US", "document": { "document_number": "123456789", "document_type": "EIN" }, "phone": { "country_code": "1", "number": "5551234567" } } }, "amount": { "currency": "USD", "value": 5000 }, "checkout": { "session": "{{checkout_session}}" }, "customer_payer": { "id": "{{customer_id}}", "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "city": "New York", "country": "US", "state": "NY", "zip_code": "10001", "neighborhood": "Midtown" }, "browser_info": { "accept_header": "true", "color_depth": "24", "javascript_enabled": true, "language": "en-US", "screen_height": "2048", "screen_width": "1152", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9" }, "date_of_birth": "1990-02-28", "device_fingerprints": [ { "provider_id": "CLEARSALE", "id": "hi88287gbd8d7d782ge287gbd8d7d78" } ], "document": { "document_type": "SSN", "document_number": "123456789" }, "email": "johndoe@example.com", "first_name": "John", "gender": "MALE", "ip_address": "192.168.123.167", "last_name": "Doe", "merchant_customer_id": "example00234", "merchant_customer_created_at": "2014-05-12 13:05:00", "nationality": "US", "phone": { "country_code": "1", "number": "5551234567" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "city": "New York", "country": "US", "state": "NY", "zip_code": "10001", "neighborhood": "Midtown" } }, "payment_method": { "token": "{{onetime_token}}" }, "metadata": [ { "key": "ID", "value": "SD00" } ], "callback_url": "www.example.com" } }, "Bank Transfer with additional fields": { "value": { "account_id": "{{account-code}}", "amount": { "currency": "BRL", "value": 160 }, "customer_payer": { "id": "{{customer_id}}" }, "workflow": "DIRECT", "payment_method": { "type": "PIX", "detail": { "bank_transfer": { "code": "PIX2", "branch": "PIX2", "branch_digit": "1234", "country": "BRL", "account": { "number": "646180142000000006", "digit": "123456", "type": "SAVINGS" }, "bank_account_mask_number": "****6789", "mandate": { "id": "MND-123", "info": "free text mandate info", "received_status": "RECEIVED", "existing_status": "ACTIVE", "created_at": "2026-07-09T00:00:00Z", "updated_at": "2026-07-09T00:00:00Z" } } } }, "merchant_order_id": "40f93981-7bef-4ca4-a8a5-8978fe16890c", "country": "CO", "description": "test description" } }, "Voucher payment": { "value": { "account_id": "48d47836-0c4b-45af-b6b8-098fd17a8fa2", "description": "dlocal", "country": "BR", "merchant_order_id": "12271562679", "amount": { "value": 26.9, "currency": "BRL" }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "capture": true, "verify": false, "card_data": { "number": "5067555612342011", "expiration_month": 9, "expiration_year": 33, "security_code": "123", "holder_name": "MARIANA SORRENTINO" } } } }, "additional_data": { "seller_details": { "reference": "53568972000143", "merchant_category_code": "5814" } } } }, "Card - With card details": { "value": { "country": "US", "amount": { "currency": "USD", "value": "20000" }, "customer_payer": { "id": "", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com" }, "payment_method": { "detail": { "card": { "card_data": { "number": "4111111111111111", "expiration_month": 11, "expiration_year": 28, "security_code": "123", "holder_name": "John Doe" } } }, "type": "CARD" }, "account_id": "", "description": "Payment with card details", "merchant_order_id": "000023", "workflow": "DIRECT" } }, "Card – Capture and cancel": { "value": { "country": "US", "amount": { "currency": "USD", "value": "20000" }, "customer_payer": { "merchant_customer_validations": { "account_is_verified": true, "email_is_verified": true, "phone_is_verified": true }, "id": "", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com" }, "workflow": "DIRECT", "payment_method": { "detail": { "card": { "capture": false, "delayed_capture_settings": { "delay": "P20D", "simplified_mode": true }, "delayed_cancel_settings": { "delay": "P40D", "simplified_mode": true }, "card_data": { "number": "4111111111111111", "expiration_month": 11, "expiration_year": 28, "security_code": "123", "holder_name": "John Doe" }, "verify": false } }, "type": "CARD" }, "account_id": "", "description": "Payment with card details", "merchant_order_id": "000023" } }, "Card - With airline data": { "value": { "additional_data": { "airline": { "legs": [ { "departure_airport": "LAX", "departure_datetime": "2024-07-03T05:00:00", "departure_airport_timezone": "GMT-08", "arrival_airport": "JFK", "carrier_code": "AA", "flight_number": "AA100", "fare_basis_code": "Y", "fare_class_code": "S", "base_fare": 500, "base_fare_currency": "USD", "stopover_code": "O" } ], "passengers": [ { "document": { "document_number": "123456789", "document_type": "PASSPORT", "country": "US" }, "first_name": "John", "last_name": "Doe", "middle_name": "Stephen", "type": "A", "date_of_birth": "1998-01-01", "nationality": "US", "loyalty_number": "79250001", "loyalty_tier": "DIAMOND", "email": "john.doe@example.com", "phone": { "country_code": "1", "number": "5551234567" } } ], "tickets": [ { "issue": { "carrier_prefix_code": "001", "travel_agent_code": "A12345", "travel_agent_name": "Best Travel Agency", "date": "2023-10-31T01:30:00.000-08:00", "address": "123 Main St", "city": "Los Angeles", "country": "US", "zip_code": "90001" }, "ticket_number": "AA123456", "e_ticket": true, "restricted": false, "total_fare_amount": 700, "total_tax_amount": 100, "total_fee_amount": 50 } ], "pnr": "DEF456" } }, "country": "US", "amount": { "currency": "USD", "value": "2000" }, "customer_payer": { "document": { "document_number": "987654321", "document_type": "DRIVER_LICENSE" }, "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1998-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.0.1" }, "payment_method": { "detail": { "card": { "card_data": { "number": "4111111111111111", "expiration_month": 11, "expiration_year": 28, "security_code": "123", "holder_name": "John Doe" } } }, "type": "CARD" }, "account_id": "", "description": "Flight Booking Payment", "merchant_order_id": "", "merchant_reference": "reference-001", "workflow": "DIRECT" } }, "Card - With 3DS direct": { "value": { "description": "Card payment with 3DS", "account_id": "", "merchant_order_id": "0000022", "merchant_reference": "29ZVMO", "country": "US", "amount": { "currency": "USD", "value": 100 }, "customer_payer": { "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "ip_address": "192.168.1.1", "document": { "document_type": "PAS", "document_number": "123456789" }, "billing_address": { "address_line_1": "1295 Charleston Road", "address_line_2": "", "city": "Mountain View", "country": "US", "zip_code": "94043", "state": "CA" } }, "callback_url": "https://www.y.uno", "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "capture": false, "three_d_secure": { "three_d_secure_setup_id": "005219f5-babf-4598-bc52-5dd49c19ba7a" }, "card_data": { "number": "4000000000001026", "holder_name": "John Doe", "expiration_month": 1, "expiration_year": 26, "security_code": "123" } } } } } }, "Card - With customer, billing, and shipping details": { "value": { "description": "Card payment with customer, billing and shipping details", "account_id": "", "merchant_order_id": "0000023", "country": "US", "merchant_reference": "reference-001", "amount": { "currency": "USD", "value": 5000 }, "customer_payer": { "merchant_customer_id": "1690160581", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": null, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "1234567890", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001" } }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "card_data": { "number": "4111111111111111", "holder_name": "John Doe", "expiration_month": 10, "expiration_year": 26, "security_code": "456" } } } } } }, "Card - With customer, billing, shipping and order items": { "value": { "description": "Card payment with customer, billing, shipping and order items", "account_id": "", "merchant_order_id": "0000023", "country": "US", "merchant_reference": "reference-001", "amount": { "currency": "USD", "value": 5000 }, "additional_data": { "order": { "fee_amount": 0, "items": [ { "brand": "XYZ", "category": "Clothes", "id": "123AD", "manufacture_part_number": "XYZ123456", "image_url": "https://cdn.example.com/img/skirt-01.jpg", "name": "Skirt", "quantity": 1, "sku_code": "8765432109", "unit_amount": 5000 } ], "shipping_amount": 0 } }, "customer_payer": { "merchant_customer_id": "", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": null, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "1234567890", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001" } }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "card_data": { "number": "4111111111111111", "holder_name": "John Doe", "expiration_month": 10, "expiration_year": 26, "security_code": "456" } } } } } }, "Card - With installments": { "value": { "description": "Card payment with installments", "account_id": "", "merchant_order_id": "0000023", "country": "US", "merchant_reference": "reference-001", "amount": { "currency": "USD", "value": 5000 }, "customer_payer": { "merchant_customer_id": "", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com" }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "card_data": { "number": "4111111111111111", "holder_name": "John Doe", "expiration_month": 10, "expiration_year": 26, "security_code": "456" }, "installments": 3 } } } } }, "Card - With authorization": { "value": { "description": "Card payment with authorization", "account_id": "", "merchant_order_id": "0000023", "country": "US", "merchant_reference": "reference-001", "amount": { "currency": "USD", "value": 5000 }, "customer_payer": { "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com" }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "card_data": { "number": "4111111111111111", "holder_name": "John Doe", "expiration_month": 10, "expiration_year": 26, "security_code": "456" }, "capture": false } } } } }, "Card - With device fingerprint": { "value": { "description": "Card payment with device fingerprint", "account_id": "", "merchant_order_id": "0000023", "country": "US", "merchant_reference": "reference-001", "amount": { "currency": "USD", "value": 5000 }, "customer_payer": { "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "device_fingerprints": [ { "provider_id": "CLEARSALE", "id": "hi88287gbd8d7d782ge287gbd8d7d78" } ] }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "card_data": { "number": "4111111111111111", "holder_name": "John Doe", "expiration_month": 10, "expiration_year": 26, "security_code": "456" } } } } } }, "Card - With vault on success": { "value": { "description": "Card payment with vault on success", "account_id": "", "merchant_order_id": "0000023", "country": "US", "merchant_reference": "reference-001", "amount": { "currency": "USD", "value": 5000 }, "customer_payer": { "id": "", "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com" }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "vault_on_success": true, "detail": { "card": { "card_data": { "number": "4111111111111111", "holder_name": "John Doe", "expiration_month": 10, "expiration_year": 26, "security_code": "456" } } } } } }, "Card - With vaulted token": { "value": { "description": "Card payment with vaulted token", "account_id": "", "merchant_order_id": "0000023", "country": "US", "merchant_reference": "reference-001", "amount": { "currency": "USD", "value": 5000 }, "customer_payer": { "id": "", "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com" }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "vaulted_token": "" } } }, "Alternative payment method": { "value": { "description": "Payment with alternative method", "account_id": "", "merchant_order_id": "0000022", "country": "US", "amount": { "currency": "USD", "value": 52000 }, "customer_payer": { "merchant_customer_id": "12367482", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com" }, "payment_method": { "type": "CASH" }, "workflow": "REDIRECT", "callback_url": "www.example.com" } }, "Card - With shipping, fee and tip amount": { "value": { "additional_data": { "order": { "fee_amount": 500, "shipping_amount": 100, "tip_amount": 50, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 5000, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456", "image_url": "https://cdn.example.com/img/skirt-01.jpg" } ] }, "airline": null, "seller_details": null }, "country": "US", "amount": { "currency": "USD", "value": 100 }, "customer_payer": { "id": "", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com" }, "checkout": { "session": "{{checkout_session}}" }, "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "card_data": { "number": "4111111111111111", "holder_name": "John Doe", "expiration_month": 10, "expiration_year": 26, "security_code": "456" }, "verify": false } } }, "description": "Test Cards", "account_id": "", "merchant_order_id": "0000022", "merchant_reference": "Payment Test 001" } }, "Wallet - Direct": { "value": { "country": "US", "amount": { "currency": "USD", "value": 100 }, "customer_payer": { "merchant_customer_validations": { "account_is_verified": true, "email_is_verified": true, "phone_is_verified": true } }, "workflow": "DIRECT", "payment_method": { "detail": { "card": { "verify": false } }, "type": "APPLE_PAY" }, "account_id": "", "description": "ApplePaytest", "merchant_order_id": "TEST01" } }, "Wallet - Google Pay with card last four": { "summary": "Wallet - Google Pay device token with card last four", "value": { "description": "Google Pay server-to-server payment with merchant-provided card last four", "account_id": "", "merchant_order_id": "0000024", "country": "US", "amount": { "currency": "USD", "value": 5000 }, "customer_payer": { "email": "johndoe@example.com" }, "workflow": "DIRECT", "payment_method": { "type": "GOOGLE_PAY", "detail": { "wallet": { "payment_token": "{\"signature\":\"...\",\"intermediateSigningKey\":{...},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"...\"}", "card_data": { "lfd": "1515" } } } } } }, "Split marketplace": { "value": { "description": "Split marketplace payment", "account_id": "", "merchant_order_id": "000022", "country": "US", "additional_data": { "order": { "items": [ { "brand": "XYZ", "category": "Clothes", "id": "123AD", "manufacture_part_number": "XYZ123456", "image_url": "https://cdn.example.com/img/skirt-01.jpg", "name": "Skirt", "quantity": 1, "sku_code": "8765432109", "unit_amount": 5000 } ] } }, "customer_payer": { "billing_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 502", "city": "New York", "country": "US", "state": "NY", "zip_code": "10001" }, "browser_info": { "accept_header": "string", "color_depth": "string", "javascript_enabled": true, "language": "string", "screen_height": "string", "screen_width": "string", "user_agent": "string" }, "date_of_birth": "1990-02-28", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "email": "johndoe@example.com", "first_name": "John", "gender": "M", "id": "", "ip_address": "192.168.123.167", "last_name": "Doe", "merchant_customer_id": "example00234", "nationality": "US", "phone": { "country_code": "1", "number": "5551234567" }, "shipping_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 502", "city": "New York", "country": "US", "state": "NY", "zip_code": "10001" } }, "amount": { "currency": "USD", "value": 5000 }, "split_marketplace": [ { "provider_recipient_id": "re_us16nrp0u0tl60k9t1lopi9ld", "merchant_reference": "REF-01", "recipient_type": "MEAL", "type": "PURCHASE", "amount": { "currency": "USD", "value": 4000 } }, { "provider_recipient_id": "re_us16nu2f10tjv0k9t49fjeora", "recipient_type": "FOOD", "type": "COMMISSION", "amount": { "currency": "USD", "value": 1000 } } ], "workflow": "DIRECT", "payment_method": { "type": "CARD", "detail": { "card": { "capture": true, "card_data": { "holder_name": "John Doe", "number": "4000000000000010", "expiration_month": 3, "expiration_year": 30, "security_code": "737" } } } } } }, "Card - Create Payment with Subscription": { "value": { "id": "821f9afd-f0cb-4fa9-9330-f173b90b0356", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Payment with card details", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "000023", "created_at": "2025-06-18T18:25:01.729174Z", "updated_at": "2025-06-18T18:25:02.066450Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": { "code": "ccv_01HVK3Z9M2...", "cardholder_currency": "QAR", "cardholder_amount": 3640, "cardholder_accepted": true, "rate": 3.64, "rate_margin_percentage": 3.75, "rate_source": "ECB", "provider": "FEXCO", "description": "You have chosen to pay in QAR. Amount: 3640.00 QAR. Rate: 3.6400.", "created_at": "2026-04-24T14:30:00Z", "expires_at": "2026-04-24T15:30:00Z", "status": "APPLIED", "error_reason": null, "provider_data": { "acquirer_id": "MPGS_01" } }, "refunded": 0, "value": 20000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "33a9e979-6558-4694-b00c-3d0844524681", "merchant_customer_id": "1749820178", "first_name": "John", "last_name": "Doe", "gender": "F", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "CO", "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "CC", "document_number": "1010268952" }, "phone": { "number": "3132450765", "country_code": "57" }, "billing_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "shipping_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "953131e6-94d5-420f-a228-28f67c66b723", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with card details", "merchant_reference": "000023", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "31c00baa-ced9-4477-ac1c-e963c4838dde", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_request": { "amount": { "currency": "BRL", "value": 2100 }, "reference": "34343434" }, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T18:25:01.934784Z", "updated_at": "2025-06-18T18:25:02.018823Z" }, "transactions_history": [ { "id": "953131e6-94d5-420f-a228-28f67c66b723", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with card details", "merchant_reference": "000023", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "31c00baa-ced9-4477-ac1c-e963c4838dde", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T18:25:01.934784Z", "updated_at": "2025-06-18T18:25:02.018823Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false, "subscription": { "frequency": { "type": "MONTH", "value": 1, "execution": "YUNO" }, "availability": { "start_at": "2027-05-23T20:17:30.277678Z", "finish_at": "2029-05-23T20:17:30.277678Z" }, "amount": { "value": 20000, "currency": "USD", "type": "FIXED" } } } }, "Card - Create Payment for Existing Subscription": { "value": { "id": "821f9afd-f0cb-4fa9-9330-f173b90b0356", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Payment with card details", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "000023", "created_at": "2025-06-18T18:25:01.729174Z", "updated_at": "2025-06-18T18:25:02.066450Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 20000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "33a9e979-6558-4694-b00c-3d0844524681", "merchant_customer_id": "1749820178", "first_name": "John", "last_name": "Doe", "gender": "F", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "CO", "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "CC", "document_number": "1010268952" }, "phone": { "number": "3132450765", "country_code": "57" }, "billing_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "shipping_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "953131e6-94d5-420f-a228-28f67c66b723", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with card details", "merchant_reference": "000023", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "31c00baa-ced9-4477-ac1c-e963c4838dde", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T18:25:01.934784Z", "updated_at": "2025-06-18T18:25:02.018823Z" }, "transactions_history": [ { "id": "953131e6-94d5-420f-a228-28f67c66b723", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with card details", "merchant_reference": "000023", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "31c00baa-ced9-4477-ac1c-e963c4838dde", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T18:25:01.934784Z", "updated_at": "2025-06-18T18:25:02.018823Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false, "subscription": { "id": "1c9f0b2e-7d5a-4c3b-8e1f-9a0b1c2d3e4f" } } }, "Create payment with split": { "value": { "description": "SUCCEDED", "account_id": "{{account-code}}", "merchant_order_id": "1753363203", "country": "US", "workflow": "DIRECT", "amount": { "currency": "USD", "value": 1000 }, "metadata": [ { "key": "PROVIDER", "value": "STRIPE" } ], "payment_method": { "type": "CARD", "vault_on_success": false, "detail": { "card": { "capture": true, "card_data": { "holder_name": "John", "number": "4242424242424242", "expiration_month": 12, "expiration_year": 30, "security_code": "123" }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01" } } } }, "split_marketplace": [ { "amount": { "currency": "USD", "value": 900 }, "recipient_id": "c8440141-127b-4dfe-b585-b8622c1db4c9", "recipient_type": "MEAL", "type": "PURCHASE" }, { "amount": { "currency": "USD", "value": 100 }, "recipient_id": "", "type": "COMMISSION" } ], "customer_payer": { "document": { "document_type": "SSN", "document_number": "93095135270" }, "email": "test_recipient@y.uno", "first_name": "john", "gender": "M", "ip_address": "192.168.123.167", "last_name": "Doe", "merchant_customer_id": "example00234", "nationality": "US", "phone": { "country_code": "1", "number": "3132450765" } } } }, "Card - With external providers data": { "summary": "Card payment using provider-issued tokens (no prior enrollment)", "value": { "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482", "amount": { "currency": "COP", "value": "10000" }, "country": "CO", "customer_payer": { "id": "1a71c7b7-80c2-4ba5-b601-4d34d48c0e18" }, "payment_method": { "type": "CARD", "vault_on_success": false, "detail": { "card": { "capture": true, "external_providers_data": [ { "connection_id": "091cd992-a5ca-41e0-8957-05959b463e31", "provider_id": "CHECKOUT", "provider_token": "tok_ck_..." }, { "connection_id": "f00d04b4-584f-4790-b51d-ceede8fd8f0f", "provider_id": "ADYEN", "provider_token": "tok_ay_..." } ] } } }, "workflow": "DIRECT" } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Payment": { "value": { "id": "6c44ed29-cc51-4479-a5eb-108afdaadd50", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Card Payment", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "1744403449", "created_at": "2025-04-11T20:30:49.825637Z", "updated_at": "2025-04-11T20:30:51.953868Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 15000 }, "checkout": { "session": "7fb7093e-dc67-4c7a-80c5-d25cf5e6ff27", "sdk_action_required": false }, "payment_method": { "vaulted_token": "dcc06b32-43ad-4627-aa75-c631eb50c2ac", "type": "CARD", "vault_on_success": true, "token": "8cabcd5c-1b40-4407-b14a-14ab21741865", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "835631", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "Fannie Weissnat", "iin": "41961111", "lfd": "0010", "number_length": 16, "security_code_length": 1, "brand": "VISA", "issuer_name": "METABANK", "issuer_code": null, "country_code": "US", "category": "PREPAID RELOADABLE", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12", "expiration_month": 3, "expiration_year": 24 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "94121f98-98f7-4d57-aa5f-228401d35b12", "merchant_customer_id": "1744402154", "first_name": "John", "last_name": "Doe", "gender": "", "date_of_birth": "1990-02-28", "email": "john.doe2@gmail.com", "nationality": "US", "ip_address": "192.168.123.167", "device_fingerprint": "hi88287gbd8d7d782ge....", "device_fingerprints": [], "browser_info": { "user_agent": "string", "accept_header": "string", "accept_content": null, "accept_browser": null, "color_depth": "string", "screen_height": "string", "screen_width": "string", "javascript_enabled": true, "java_enabled": null, "browser_time_difference": null, "language": "string" }, "document": { "document_type": "SSN", "document_number": "38799992" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001", "neighborhood": "Test" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001", "neighborhood": "Test" }, "merchant_customer_created_at": "2023-08-05T14:43:58.980718Z" }, "additional_data": { "airline": { "pnr": "1P-2UUGJW", "legs": [ { "departure_airport": "EZE", "departure_datetime": "2014-05-12 13:05:00", "departure_airport_timezone": "-03:00", "arrival_airport": "AMS", "arrival_airport_timezone": "+00:00", "arrival_datetime": "", "carrier_code": "KL", "flight_number": "842", "fare_basis_code": "HL7LNR", "fare_class_code": "FR", "base_fare": 200, "base_fare_currency": "USD", "stopover_code": "s" } ], "passengers": [ { "first_name": "string", "last_name": "string", "middle_name": "string", "type": "s", "date_of_birth": "stringstri", "nationality": "US", "document": { "document_type": "SSN", "document_number": "351040753" }, "country": "US", "loyalty_number": "string", "loyalty_tier": "strin", "email": null, "phone": null } ], "ticket": { "ticket_number": "123456", "e_ticket": false, "restricted": false, "total_fare_amount": 80, "total_tax_amount": 22, "total_fee_amount": 14, "issue": null }, "tickets": null }, "order": { "fee_amount": 40.5, "shipping_amount": 10.35, "tip_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 3, "unit_amount": 20, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456", "image_url": "https://cdn.example.com/img/skirt-01.jpg" } ], "account_funding": null, "tickets": null, "fulfillment": null, "discounts": null }, "seller_details": null }, "transactions": { "id": "9dc9524a-504d-4eaf-84ef-c881b46aab25", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 15000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "dcc06b32-43ad-4627-aa75-c631eb50c2ac", "type": "CARD", "vault_on_success": true, "token": "8cabcd5c-1b40-4407-b14a-14ab21741865", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "835631", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "Fannie Weissnat", "iin": "41961111", "lfd": "0010", "number_length": 16, "security_code_length": 1, "brand": "VISA", "issuer_name": "METABANK", "issuer_code": null, "country_code": "US", "category": "PREPAID RELOADABLE", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12", "expiration_month": 3, "expiration_year": 24 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Payment", "merchant_reference": "1744403449", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "04d94195-a6ce-455a-b027-5f237f91a576", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "90defca1-c913-4894-965c-ed536b65951a", "name": null }, "created_at": "2025-04-11T20:30:51.097215Z", "updated_at": "2025-04-11T20:30:51.199007Z" }, "transactions_history": [ { "id": "9dc9524a-504d-4eaf-84ef-c881b46aab25", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 15000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "dcc06b32-43ad-4627-aa75-c631eb50c2ac", "type": "CARD", "vault_on_success": true, "token": "8cabcd5c-1b40-4407-b14a-14ab21741865", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "835631", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "Fannie Weissnat", "iin": "41961111", "lfd": "0010", "number_length": 16, "security_code_length": 1, "brand": "VISA", "issuer_name": "METABANK", "issuer_code": null, "country_code": "US", "category": "PREPAID RELOADABLE", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12", "expiration_month": 3, "expiration_year": 24 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Payment", "merchant_reference": "1744403449", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "04d94195-a6ce-455a-b027-5f237f91a576", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "90defca1-c913-4894-965c-ed536b65951a", "name": null }, "created_at": "2025-04-11T20:30:51.097215Z", "updated_at": "2025-04-11T20:30:51.199007Z" } ], "callback_url": "http://www.google.com/?checkoutSession=7fb7093e-dc67-4c7a-80c5-d25cf5e6ff27", "workflow": "SDK_CHECKOUT", "metadata": [ { "key": "ID", "value": "1234" } ], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 146526, "name": null, "description": null } }, "simplified_mode": false } }, "Card - With card details": { "value": { "id": "821f9afd-f0cb-4fa9-9330-f173b90b0356", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Payment with card details", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "000023", "created_at": "2025-06-18T18:25:01.729174Z", "updated_at": "2025-06-18T18:25:02.066450Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 20000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "33a9e979-6558-4694-b00c-3d0844524681", "merchant_customer_id": "1749820178", "first_name": "John", "last_name": "Doe", "gender": "F", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "CO", "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "CC", "document_number": "1010268952" }, "phone": { "number": "3132450765", "country_code": "57" }, "billing_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "shipping_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "953131e6-94d5-420f-a228-28f67c66b723", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with card details", "merchant_reference": "000023", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "31c00baa-ced9-4477-ac1c-e963c4838dde", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T18:25:01.934784Z", "updated_at": "2025-06-18T18:25:02.018823Z" }, "transactions_history": [ { "id": "953131e6-94d5-420f-a228-28f67c66b723", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with card details", "merchant_reference": "000023", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "31c00baa-ced9-4477-ac1c-e963c4838dde", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T18:25:01.934784Z", "updated_at": "2025-06-18T18:25:02.018823Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With airline data": { "value": { "id": "096ab480-3fdc-4955-8114-681acc5645f3", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Flight Booking Payment", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "merchant_order_id", "created_at": "2025-06-18T19:01:02.367139Z", "updated_at": "2025-06-18T19:01:02.638270Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 2000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "483790", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": null, "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1998-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.0.1", "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "DRIVER_LICENSE", "document_number": "987654321" }, "phone": null, "billing_address": null, "shipping_address": null, "merchant_customer_created_at": null }, "additional_data": { "airline": { "pnr": "DEF456", "legs": [ { "departure_airport": "LAX", "departure_datetime": "2024-07-03T05:00:00", "departure_airport_timezone": "GMT-08", "arrival_airport": "JFK", "arrival_airport_timezone": "+00:00", "arrival_datetime": "", "carrier_code": "AA", "flight_number": "AA100", "fare_basis_code": "Y", "fare_class_code": "S", "base_fare": 500, "base_fare_currency": "USD", "stopover_code": "O", "departure_airport_country": null, "departure_airport_city": null, "arrival_airport_country": null, "arrival_airport_city": null } ], "passengers": [ { "first_name": "John", "last_name": "Doe", "middle_name": "Stephen", "type": "A", "date_of_birth": "1998-01-01", "nationality": "US", "document": { "document_type": "PASSPORT", "document_number": "123456789" }, "country": null, "loyalty_number": "79250001", "loyalty_tier": "DIAMOND", "email": "john.doe@example.com", "phone": { "number": "5551234567", "country_code": "1" } } ], "ticket": null, "tickets": [ { "ticket_number": "AA123456", "e_ticket": true, "restricted": false, "total_fare_amount": 700, "total_tax_amount": 100, "total_fee_amount": 50, "issue": { "carrier_prefix_code": "001", "travel_agent_code": "A12345", "travel_agent_name": "Best Travel Agency", "date": "2023-10-31T01:30:00.000-08:00", "address": "123 Main St", "city": "Los Angeles", "country": "US", "zip_code": "90001", "booking_system_code": null, "booking_system_name": null } } ] }, "order": null, "seller_details": null }, "transactions": { "id": "6f0015cb-51b1-465a-b493-d6348aa771c0", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 2000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "483790", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Flight Booking Payment", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "22c6f649-9cb8-44a8-b3bc-e1100224a565", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:01:02.528544Z", "updated_at": "2025-06-18T19:01:02.582688Z" }, "transactions_history": [ { "id": "6f0015cb-51b1-465a-b493-d6348aa771c0", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 2000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "483790", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Flight Booking Payment", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "22c6f649-9cb8-44a8-b3bc-e1100224a565", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:01:02.528544Z", "updated_at": "2025-06-18T19:01:02.582688Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With 3DS direct": { "value": { "id": "454db62f-16f4-4e7d-8663-bac9de8fe453", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with 3DS", "country": "US", "status": "PENDING", "sub_status": "AUTHORIZED", "merchant_order_id": "0000022", "created_at": "2025-06-18T19:03:54.754024Z", "updated_at": "2025-06-18T19:03:55.100929Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 100 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "964016", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40000000", "lfd": "1026", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "INTL HDQTRSCENTER OWNED", "issuer_code": null, "country_code": "FR", "category": "TRADITIONAL", "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "3dbc4137-3c51-47b5-8f5f-a48b723e9022", "expiration_month": 1, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": null, "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "johndoe@example.com", "nationality": null, "ip_address": "192.168.1.1", "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "PAS", "document_number": "123456789" }, "phone": null, "billing_address": { "address_line_1": "1295 Charleston Road", "address_line_2": "", "country": "US", "state": "CA", "city": "Mountain View", "zip_code": "94043", "neighborhood": null }, "shipping_address": null, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "1946c60b-c242-42f5-bdfe-53060ed8378f", "type": "AUTHORIZE", "status": "SUCCEEDED", "category": "CARD", "amount": 100, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "964016", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40000000", "lfd": "1026", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "INTL HDQTRSCENTER OWNED", "issuer_code": null, "country_code": "FR", "category": "TRADITIONAL", "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "3dbc4137-3c51-47b5-8f5f-a48b723e9022", "expiration_month": 1, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with 3DS", "merchant_reference": "29ZVMO", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "901c17f1-ac52-4c4d-a39b-a4aaed19c686", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:03:54.931079Z", "updated_at": "2025-06-18T19:03:54.991271Z" }, "transactions_history": [ { "id": "1946c60b-c242-42f5-bdfe-53060ed8378f", "type": "AUTHORIZE", "status": "SUCCEEDED", "category": "CARD", "amount": 100, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "964016", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40000000", "lfd": "1026", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "INTL HDQTRSCENTER OWNED", "issuer_code": null, "country_code": "FR", "category": "TRADITIONAL", "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "3dbc4137-3c51-47b5-8f5f-a48b723e9022", "expiration_month": 1, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with 3DS", "merchant_reference": "29ZVMO", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "901c17f1-ac52-4c4d-a39b-a4aaed19c686", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:03:54.931079Z", "updated_at": "2025-06-18T19:03:54.991271Z" } ], "callback_url": "https://www.y.uno", "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With customer, billing, and shipping details": { "value": { "id": "72c4a364-475d-4988-ac67-5f7b0e214b3b", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with customer, billing and shipping details", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2025-06-18T19:12:43.926630Z", "updated_at": "2025-06-18T19:12:44.226783Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "880788", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690160581", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "1234567890", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001", "neighborhood": null }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "ac8ccf5e-0829-4455-8f1e-ff34a8f19091", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "880788", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with customer, billing and shipping details", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "6f6ee117-625e-4ffb-af34-d5225a762757", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:12:44.104820Z", "updated_at": "2025-06-18T19:12:44.180078Z" }, "transactions_history": [ { "id": "ac8ccf5e-0829-4455-8f1e-ff34a8f19091", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "880788", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with customer, billing and shipping details", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "6f6ee117-625e-4ffb-af34-d5225a762757", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:12:44.104820Z", "updated_at": "2025-06-18T19:12:44.180078Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With customer, billing, shipping and order items": { "value": { "id": "577d02e1-1114-4fbd-90aa-5c291dfccd52", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with customer, billing and shipping and order items", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2025-06-18T19:13:37.224688Z", "updated_at": "2025-06-18T19:13:37.649587Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "620399", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "33a9e979-6558-4694-b00c-3d0844524681", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "1234567890", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001", "neighborhood": null }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 502", "country": "US", "state": "CA", "city": "Los Angeles", "zip_code": "90001", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": { "airline": null, "order": { "fee_amount": 0, "shipping_amount": 0, "tip_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 5000, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456", "image_url": "https://cdn.example.com/img/skirt-01.jpg" } ], "account_funding": null, "tickets": null, "fulfillment": null, "discounts": null, "sales_channel": null }, "seller_details": null }, "transactions": { "id": "982a8b81-4176-4b00-a287-dc66daadf332", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "620399", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with customer, billing, shipping and order items", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "888a2c91-c121-42c1-b85b-aa7d760ea186", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:13:37.523339Z", "updated_at": "2025-06-18T19:13:37.591018Z" }, "transactions_history": [ { "id": "982a8b81-4176-4b00-a287-dc66daadf332", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "620399", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with customer, billing, shipping and order items", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "888a2c91-c121-42c1-b85b-aa7d760ea186", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:13:37.523339Z", "updated_at": "2025-06-18T19:13:37.591018Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With installments": { "value": { "id": "6a3871a3-9aec-4e45-adf5-1e652c02b69d", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with installments", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2025-06-18T19:16:19.093013Z", "updated_at": "2025-06-18T19:16:19.388282Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 3, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "360480", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "33a9e979-6558-4694-b00c-3d0844524681", "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "johndoe@example.com", "nationality": null, "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": null, "phone": null, "billing_address": null, "shipping_address": null, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "1acf6cfb-0e35-4bcc-8ee4-a46d931b498a", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 3, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "360480", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with installments", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "1fcfd342-3883-4a77-8769-3df6a49859fa", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:16:19.268256Z", "updated_at": "2025-06-18T19:16:19.341676Z" }, "transactions_history": [ { "id": "1acf6cfb-0e35-4bcc-8ee4-a46d931b498a", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 3, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "360480", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with installments", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "1fcfd342-3883-4a77-8769-3df6a49859fa", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:16:19.268256Z", "updated_at": "2025-06-18T19:16:19.341676Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With authorization": { "value": { "id": "72367fa4-bd87-422e-ab1f-9cfe2bfbbf1c", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with authorization", "country": "US", "status": "PENDING", "sub_status": "AUTHORIZED", "merchant_order_id": "0000023", "created_at": "2025-06-18T19:19:27.467914Z", "updated_at": "2025-06-18T19:19:27.753439Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "744160", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "johndoe@example.com", "nationality": null, "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": null, "phone": null, "billing_address": null, "shipping_address": null, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "c08063a0-468c-4330-aec6-18a263a25bd2", "type": "AUTHORIZE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "744160", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with authorization", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "ea81255e-77c3-4f7b-baf7-d27a27988da9", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:19:27.651142Z", "updated_at": "2025-06-18T19:19:27.710702Z" }, "transactions_history": [ { "id": "c08063a0-468c-4330-aec6-18a263a25bd2", "type": "AUTHORIZE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "744160", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with authorization", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "ea81255e-77c3-4f7b-baf7-d27a27988da9", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:19:27.651142Z", "updated_at": "2025-06-18T19:19:27.710702Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With merchant advice code (MAC)": { "value": { "id": "72367fa4-bd87-422e-ab1f-9cfe2bfbbf1c", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with authorization (declined)", "country": "US", "status": "PENDING", "sub_status": "DECLINED", "merchant_order_id": "0000023", "created_at": "2025-06-18T19:19:27.467914Z", "updated_at": "2025-06-18T19:19:27.753439Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "744160", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "johndoe@example.com", "nationality": null, "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": null, "phone": null, "billing_address": null, "shipping_address": null, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "c08063a0-468c-4330-aec6-18a263a25bd2", "type": "AUTHORIZE", "status": "DECLINED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "744160", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "DECLINED", "response_message": "Transaction declined", "reason": null, "description": "Card payment with authorization (declined)", "merchant_reference": "reference-001", "merchant_advice_code": "TRY_AGAIN_LATER", "merchant_advice_code_message": "Retry within 30 days", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "ea81255e-77c3-4f7b-baf7-d27a27988da9", "account_id": "", "status": "DECLINED", "sub_status": "", "status_detail": "", "merchant_advice_code": "51", "merchant_advice_code_message": "Insufficient funds – try again later", "response_message": "Insufficient funds", "response_code": "51", "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:19:27.651142Z", "updated_at": "2025-06-18T19:19:27.710702Z" }, "transactions_history": [ { "id": "c08063a0-468c-4330-aec6-18a263a25bd2", "type": "AUTHORIZE", "status": "DECLINED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "744160", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "DECLINED", "response_message": "Transaction declined", "reason": null, "description": "Card payment with authorization (declined)", "merchant_reference": "reference-001", "merchant_advice_code": "TRY_AGAIN_LATER", "merchant_advice_code_message": "Retry within 30 days", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "ea81255e-77c3-4f7b-baf7-d27a27988da9", "account_id": "", "status": "DECLINED", "sub_status": "", "status_detail": "", "merchant_advice_code": "51", "merchant_advice_code_message": "Insufficient funds – try again later", "response_message": "Insufficient funds", "response_code": "51", "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:19:27.651142Z", "updated_at": "2025-06-18T19:19:27.710702Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With device fingerprint": { "value": { "id": "24e0e48c-6dc7-4339-a816-42ff3b5e4a43", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with device fingerprint", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2025-06-18T19:22:17.244754Z", "updated_at": "2025-06-18T19:22:17.601756Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "655119", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "johndoe@example.com", "nationality": null, "ip_address": null, "device_fingerprint": "hi88287gbd8d7d782ge287gbd8d7d78", "device_fingerprints": [ { "provider_id": "CLEARSALE", "id": "hi88287gbd8d7d782ge287gbd8d7d78" } ], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": null, "phone": null, "billing_address": null, "shipping_address": null, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "a8a11931-703d-441f-a707-206397cdc907", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "655119", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with device fingerprint", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "41047d54-4885-4149-a1e2-4949caeb18a1", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:22:17.502970Z", "updated_at": "2025-06-18T19:22:17.558586Z" }, "transactions_history": [ { "id": "a8a11931-703d-441f-a707-206397cdc907", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "655119", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with device fingerprint", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "41047d54-4885-4149-a1e2-4949caeb18a1", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:22:17.502970Z", "updated_at": "2025-06-18T19:22:17.558586Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With vault on success": { "value": { "id": "83b45448-6288-4f91-bbac-6b75063a0db2", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with vault on success", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2025-06-18T19:23:24.576097Z", "updated_at": "2025-06-18T19:23:25.014707Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "ede60aeb-2b4a-4e96-a00d-e88ed1f6e163", "type": "CARD", "vault_on_success": true, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "267390", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "33a9e979-6558-4694-b00c-3d0844524681", "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "F", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "CO", "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "CC", "document_number": "1010268952" }, "phone": { "number": "3132450765", "country_code": "57" }, "billing_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "shipping_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "f07d81bc-dcdb-48a8-86bd-2bd506bc1c8c", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "ede60aeb-2b4a-4e96-a00d-e88ed1f6e163", "type": "CARD", "vault_on_success": true, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "267390", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with vault on success", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "007aa355-5916-49b5-9fb0-9c5e0242a861", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:23:24.747667Z", "updated_at": "2025-06-18T19:23:24.797155Z" }, "transactions_history": [ { "id": "f07d81bc-dcdb-48a8-86bd-2bd506bc1c8c", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "ede60aeb-2b4a-4e96-a00d-e88ed1f6e163", "type": "CARD", "vault_on_success": true, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "267390", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with vault on success", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "007aa355-5916-49b5-9fb0-9c5e0242a861", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:23:24.747667Z", "updated_at": "2025-06-18T19:23:24.797155Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - With vaulted token": { "value": { "id": "ec32830e-aa3f-4a50-9349-470a747ee603", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Card payment with vaulted token", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2025-06-18T19:24:45.941124Z", "updated_at": "2025-06-18T19:24:46.248935Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "ede60aeb-2b4a-4e96-a00d-e88ed1f6e163", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "248213", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 0, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "33a9e979-6558-4694-b00c-3d0844524681", "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "F", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "CO", "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "CC", "document_number": "1010268952" }, "phone": { "number": "3132450765", "country_code": "57" }, "billing_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "shipping_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "ea0c5af1-aa9d-4514-9fd0-205339c43d6c", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "ede60aeb-2b4a-4e96-a00d-e88ed1f6e163", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "248213", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 0, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with vaulted token", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "879556c0-19cc-4a21-bb29-a90dedfa5cd5", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:24:46.151503Z", "updated_at": "2025-06-18T19:24:46.203744Z" }, "transactions_history": [ { "id": "ea0c5af1-aa9d-4514-9fd0-205339c43d6c", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "ede60aeb-2b4a-4e96-a00d-e88ed1f6e163", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "248213", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 0, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 10, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Card payment with vaulted token", "merchant_reference": "reference-001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "879556c0-19cc-4a21-bb29-a90dedfa5cd5", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:24:46.151503Z", "updated_at": "2025-06-18T19:24:46.203744Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Card - Create Payment with Subscription": { "value": { "id": "821f9afd-f0cb-4fa9-9330-f173b90b0356", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Payment with card details", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "000023", "created_at": "2025-06-18T18:25:01.729174Z", "updated_at": "2025-06-18T18:25:02.066450Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": { "code": "ccv_01HVK3Z9M2...", "cardholder_currency": "QAR", "cardholder_amount": 3640, "cardholder_accepted": true, "rate": 3.64, "rate_margin_percentage": 3.75, "rate_source": "ECB", "provider": "FEXCO", "description": "You have chosen to pay in QAR. Amount: 3640.00 QAR. Rate: 3.6400.", "created_at": "2026-04-24T14:30:00Z", "expires_at": "2026-04-24T15:30:00Z", "status": "APPLIED", "error_reason": null, "provider_data": { "acquirer_id": "MPGS_01" } }, "refunded": 0, "value": 20000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "33a9e979-6558-4694-b00c-3d0844524681", "merchant_customer_id": "1749820178", "first_name": "John", "last_name": "Doe", "gender": "F", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "CO", "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": { "document_type": "CC", "document_number": "1010268952" }, "phone": { "number": "3132450765", "country_code": "57" }, "billing_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "shipping_address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "111111", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "953131e6-94d5-420f-a228-28f67c66b723", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with card details", "merchant_reference": "000023", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "31c00baa-ced9-4477-ac1c-e963c4838dde", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_request": { "amount": { "currency": "BRL", "value": 2100 }, "reference": "34343434" }, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T18:25:01.934784Z", "updated_at": "2025-06-18T18:25:02.018823Z" }, "transactions_history": [ { "id": "953131e6-94d5-420f-a228-28f67c66b723", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "748912", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CONOTOXIA SP Z O O", "issuer_code": null, "country_code": "PL", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "a2ede54f-4b2a-4673-ae2c-c0704338ec7d", "expiration_month": 11, "expiration_year": 28 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with card details", "merchant_reference": "000023", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "31c00baa-ced9-4477-ac1c-e963c4838dde", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T18:25:01.934784Z", "updated_at": "2025-06-18T18:25:02.018823Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": "1c9f0b2e-7d5a-4c3b-8e1f-9a0b1c2d3e4f", "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false, "subscription": { "frequency": { "type": "MONTH", "value": 1, "execution": "YUNO" }, "availability": { "start_at": "2025-05-23T20:17:30.277678Z", "finish_at": "2027-05-23T20:17:30.277678Z" }, "amount": { "value": 20000, "currency": "USD", "type": "FIXED" } } } }, "Alternative payment method": { "value": { "id": "02469d14-fb2e-4d6e-9b85-615a466a8802", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Payment with alternative method", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2025-06-18T19:32:37.851530Z", "updated_at": "2025-06-18T19:32:38.337110Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 52000 }, "checkout": { "session": "859a7d1e-bf60-47db-8c74-5db075df359a", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "CASH", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "ticket": { "type": null, "benefit_type": null, "date_of_expiration": null, "payment_instruction": null, "provider_number": "AP001123456750436580293122302514", "provider_barcode": null, "provider_logo": null, "provider_format": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=56fc620e-d940-4dd4-b2a0-caed3acd274a", "expires_at": null } } }, "customer_payer": { "id": null, "merchant_customer_id": "12367482", "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "johndoe@example.com", "nationality": null, "ip_address": null, "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "", "platform": null }, "document": null, "phone": null, "billing_address": null, "shipping_address": null, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "462eeecc-a7de-4571-b94e-48870dc27cdf", "type": "PURCHASE", "status": "CREATED", "category": "TICKET", "amount": 52000, "provider_id": "ARCUS", "payment_method": { "vaulted_token": "", "type": "CASH", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "ticket": { "type": null, "benefit_type": null, "date_of_expiration": null, "payment_instruction": null, "provider_number": "AP001123456750436580293122302514", "provider_barcode": null, "provider_logo": null, "provider_format": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=56fc620e-d940-4dd4-b2a0-caed3acd274a", "expires_at": null } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with alternative method", "merchant_reference": "0000022", "provider_data": { "id": "ARCUS", "transaction_id": "AP001123456750436580293122302514", "account_id": "", "status": "", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": null, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "48425c89-8fd0-4c6f-a8f3-17a25e5ac7ce", "name": null }, "created_at": "2025-06-18T19:32:38.026782Z", "updated_at": "2025-06-18T19:32:38.297636Z" }, "transactions_history": [ { "id": "462eeecc-a7de-4571-b94e-48870dc27cdf", "type": "PURCHASE", "status": "CREATED", "category": "TICKET", "amount": 52000, "provider_id": "ARCUS", "payment_method": { "vaulted_token": "", "type": "CASH", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "ticket": { "type": null, "benefit_type": null, "date_of_expiration": null, "payment_instruction": null, "provider_number": "AP001123456750436580293122302514", "provider_barcode": null, "provider_logo": null, "provider_format": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=56fc620e-d940-4dd4-b2a0-caed3acd274a", "expires_at": null } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Payment with alternative method", "merchant_reference": "0000022", "provider_data": { "id": "ARCUS", "transaction_id": "AP001123456750436580293122302514", "account_id": "", "status": "", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": null, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "48425c89-8fd0-4c6f-a8f3-17a25e5ac7ce", "name": null }, "created_at": "2025-06-18T19:32:38.026782Z", "updated_at": "2025-06-18T19:32:38.297636Z" } ], "callback_url": "www.example.com", "workflow": "REDIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 191919, "name": null, "description": null } }, "simplified_mode": false } }, "Card - With shipping, fee and tip amount": { "value": { "id": "591b4df0-6b18-494b-8a30-b88d7f999e03", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Card payment with tip and fee amount", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000022", "created_at": "2024-06-07T12:48:21.476913Z", "updated_at": "2024-06-07T12:48:22.097913Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 100 }, "checkout": { "session": "10edfb5f-e658-446e-99b6-999598efc145", "sdk_action_required": false }, "payment_method": { "vaulted_token": "ec9f354e-52e5-4509-ac4e-c3035dcdf111", "type": "CARD", "vault_on_success": true, "token": "54867b9c-989a-426e-86f2-2fc703fe8c7c", "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "08bb27be-1256-4067-976f-7f589707e90e", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41961111", "lfd": "0010", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "META BANK", "issuer_code": null, "category": "PREPAID RELOADABLE", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": "a577ad8f-08f1-4590-9cf1-e7679b15ee84", "merchant_customer_id": "1717677815", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "john.doe@example.com", "nationality": "US", "ip_address": "192.168.1.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5555551234", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main Street", "address_line_2": "Suite 500", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001", "neighborhood": null }, "shipping_address": { "address_line_1": "123 Main Street", "address_line_2": "Suite 500", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": { "airline": null, "order": { "fee_amount": 500, "shipping_amount": 100, "tip_amount": 50, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 5000, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456", "image_url": "https://cdn.example.com/img/skirt-01.jpg" } ] }, "seller_details": null }, "taxes": null, "transactions": { "id": "dd1beb86-9cce-44d3-80f9-dd77eb927a6e", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 100, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "ec9f354e-52e5-4509-ac4e-c3035dcdf111", "type": "CARD", "vault_on_success": true, "token": "54867b9c-989a-426e-86f2-2fc703fe8c7c", "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "08bb27be-1256-4067-976f-7f589707e90e", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41961111", "lfd": "0010", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "META BANK", "issuer_code": null, "category": "PREPAID RELOADABLE", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Cards", "merchant_reference": "Pago de test 001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "b00cc57c-cd98-435a-a1c9-7a5f5c6e7481", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "response_code": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": "" }, "created_at": "2024-06-07T12:48:21.698209Z", "updated_at": "2024-06-07T12:48:21.859552Z" }, "transactions_history": { "id": "dd1beb86-9cce-44d3-80f9-dd77eb927a6e", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 100, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "ec9f354e-52e5-4509-ac4e-c3035dcdf111", "type": "CARD", "vault_on_success": true, "token": "54867b9c-989a-426e-86f2-2fc703fe8c7c", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "08bb27be-1256-4067-976f-7f589707e90e", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41961111", "lfd": "0010", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "META BANK", "issuer_code": null, "category": "PREPAID RELOADABLE", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Cards", "merchant_reference": "Pago de test 001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "b00cc57c-cd98-435a-a1c9-7a5f5c6e7481", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "response_code": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": "" }, "created_at": "2024-06-07T12:48:21.698209Z", "updated_at": "2024-06-07T12:48:21.859552Z" }, "split": [], "callback_url": "https://google.com/?checkoutSession=10edfb5f-e658-446e-99b6-999598efc145", "workflow": "SDK_CHECKOUT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "condition": { "id": 76152, "name": null, "description": null } } } }, "Card - With NT": { "value": { "id": "bc0489ba-80bf-4bb9-98c5-ff8dfbceebf9", "account_id": "64761a45-6e49-4ea5-a6ff-6b52030b92ac", "description": "SUCCESSFUL", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "Order_id", "created_at": "2023-07-12T18:51:49.437886Z", "updated_at": "2023-07-12T18:51:54.679410Z", "amount": { "currency": "USD", "value": 20000, "refunded": 0, "captured": 0 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "517862", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "network_token": { "network": "MASTERCARD", "status": "ACTIVE", "par": "V0010014622074319305424002620", "token_data": { "iin": "45079900", "lfd": "0010", "expiration_month": "10", "expiration_year": "2028", "network_payment_reference": "MCC000000355", "response": { "code": "succeeded", "message": "Transaction Succeeded" } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } } }, "customer_payer": { "id": "a76d79b7-902f-4152-922f-7e7eebc5f3dc", "merchant_customer_id": "1309", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "john.doe@example.com", "nationality": "US", "ip_address": null, "device_fingerprint": null, "browser_info": { "user_agent": "string", "accept_header": "string", "accept_content": null, "accept_browser": null, "color_depth": "32", "screen_height": "32", "screen_width": "32", "javascript_enabled": true, "java_enabled": null, "browser_time_difference": null, "language": "string" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5555551234", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "", "country": "US", "city": "New York" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "", "country": "US", "city": "New York" } }, "additional_data": null, "taxes": null, "transactions": { "id": "c718b8e9-2943-4fdf-9b3c-426cf44940fb", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "DLOCAL", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "517862", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "network_token": { "network": "MASTERCARD", "status": "ACTIVE", "par": "V0010014622074319305424002620", "token_data": { "iin": "45079900", "lfd": "0010", "expiration_month": "10", "expiration_year": "2028", "network_payment_reference": "MCC000000355", "response": { "code": "succeeded", "message": "Transaction Succeeded" } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "SUCCESSFUL", "merchant_reference": null, "provider_data": { "id": "DLOCAL", "transaction_id": "T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42", "account_id": "", "status": "PAID", "status_detail": "200", "response_message": "The payment was paid.", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "value": "{\"id\":\"T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42\",\"amount\":20000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":11,\"expiration_year\":2028,\"brand\":\"VI\",\"last4\":\"1111\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-12T18:51:52.000+0000\",\"approved_date\":\"2023-07-12T18:51:54.000+0000\",\"status\":\"PAID\",\"status_detail\":\"The payment was paid.\",\"status_code\":\"200\",\"order_id\":\"c718b8e9-2943-4fdf-9b3c-426cf44940fb\",\"description\":\"SUCCESSFUL\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"517862\"}}" }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-12T18:51:51.908784Z", "updated_at": "2023-07-12T18:51:54.426087Z" }, "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "" } }, "Wallet - Direct": { "value": "" }, "Split Marketplace": { "value": { "id": "1fb43d3e-879b-4051-a82c-754e7b894029", "account_id": "5beead35-0cd5-4e1c-9a13-b8f48f7f8f3a", "description": "Split marketplace payment", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "000022", "created_at": "2025-06-18T19:46:00.835357Z", "updated_at": "2025-06-18T19:46:01.130039Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "161102", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40000000", "lfd": "0010", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "INTL HDQTRSCENTER OWNED", "issuer_code": null, "country_code": "FR", "category": "TRADITIONAL", "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "de3d7f7a-9a71-475c-bafe-a4cb18552b79", "expiration_month": 3, "expiration_year": 30 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "33a9e979-6558-4694-b00c-3d0844524681", "merchant_customer_id": "example00234", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.168.123.167", "device_fingerprint": null, "device_fingerprints": [], "browser_info": { "user_agent": "string", "accept_header": "string", "accept_content": null, "accept_browser": null, "color_depth": "string", "screen_height": "string", "screen_width": "string", "javascript_enabled": true, "java_enabled": null, "browser_time_difference": null, "language": "string", "platform": null }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 502", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001", "neighborhood": null }, "shipping_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 502", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": { "airline": null, "order": { "fee_amount": null, "shipping_amount": null, "tip_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 5000, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456", "image_url": "https://cdn.example.com/img/skirt-01.jpg" } ], "account_funding": null, "tickets": null, "fulfillment": null, "discounts": null, "sales_channel": null }, "seller_details": null }, "transactions": { "id": "06ee5a0e-ea16-4b3f-9fdc-5e3d190f43d8", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "161102", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40000000", "lfd": "0010", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "INTL HDQTRSCENTER OWNED", "issuer_code": null, "country_code": "FR", "category": "TRADITIONAL", "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "de3d7f7a-9a71-475c-bafe-a4cb18552b79", "expiration_month": 3, "expiration_year": 30 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Split marketplace payment", "merchant_reference": "000022", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "ab05e8e6-1957-49c8-8c9d-ed20699171e3", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:46:01.031380Z", "updated_at": "2025-06-18T19:46:01.089465Z" }, "transactions_history": [ { "id": "06ee5a0e-ea16-4b3f-9fdc-5e3d190f43d8", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "161102", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40000000", "lfd": "0010", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "INTL HDQTRSCENTER OWNED", "issuer_code": null, "country_code": "FR", "category": "TRADITIONAL", "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "de3d7f7a-9a71-475c-bafe-a4cb18552b79", "expiration_month": 3, "expiration_year": 30 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Split marketplace payment", "merchant_reference": "000022", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "ab05e8e6-1957-49c8-8c9d-ed20699171e3", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": { "amount": { "currency": "BRL", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "", "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": { "id": "a2ee2f97-8ba0-4198-a821-3b750bc97872", "name": null }, "created_at": "2025-06-18T19:46:01.031380Z", "updated_at": "2025-06-18T19:46:01.089465Z" } ], "split_marketplace": [ { "recipient_id": null, "provider_recipient_id": "re_us16nrp0u0tl60k9t1lopi9ld", "type": "PURCHASE", "merchant_reference": "REF-01", "amount": { "value": 4000, "currency": "USD" }, "liability": null }, { "recipient_id": null, "provider_recipient_id": "re_us16nu2f10tjv0k9t49fjeora", "type": "COMMISSION", "merchant_reference": null, "amount": { "value": 1000, "currency": "USD" }, "liability": null } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 192539, "name": "Card", "description": "" } }, "simplified_mode": false } }, "Create payment with split": { "value": { "id": "dfb9f23b-4429-4691-8203-2fb98e781fd9", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "SUCCEDED", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "1753363203", "created_at": "2025-07-30T16:50:06.978438Z", "updated_at": "2025-07-30T16:50:08.908690Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 1000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": true, "installments": 1, "installments_plan_id": null, "installments_total_amount": null, "card_data": { "holder_name": "John", "iin": "42424242", "brand": "VISA", "issuer_name": "STRIPE PAYMENTS UK", "country_code": "GB", "category": "CLASSIC", "type": "CREDIT", "fingerprint": "54e8527e-8872-4962-b439-d2c3af14f62c", "expiration_month": 12, "expiration_year": 30 }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "example00234", "first_name": "john", "last_name": "Doe", "gender": "M", "email": "test_recipient@y.uno", "nationality": "US", "ip_address": "192.168.123.167", "document": { "document_type": "SSN", "document_number": "93095135270" }, "phone": { "number": "3132450765", "country_code": "1" }, "billing_address": null, "shipping_address": null }, "transactions": { "id": "4859edb4-172e-4ea2-a973-417975bc7799", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 1000, "provider_id": "STRIPE", "response_code": "SUCCEEDED", "response_message": "Transaction successful", "description": "SUCCEDED", "merchant_reference": "1753363203", "provider_data": { "id": "STRIPE", "transaction_id": "pi_3RqdCd2KtqBG62iM0VU2XZWz", "status": "succeeded" }, "created_at": "2025-07-30T16:50:07.097239Z", "updated_at": "2025-07-30T16:50:08.864817Z" }, "split_marketplace": [ { "recipient_id": "c8440141-127b-4dfe-b585-b8622c1db4c9", "provider_recipient_id": "acct_1RqJi4RuJnD4mgC6", "recipient_type": "MEAL", "type": "PURCHASE", "merchant_reference": "MERCHANT_usa_example_789", "amount": { "value": 900, "currency": "USD" }, "liability": null }, { "recipient_id": null, "provider_recipient_id": null, "type": "COMMISSION", "merchant_reference": null, "amount": { "value": 100, "currency": "USD" }, "liability": null } ], "workflow": "DIRECT", "metadata": [ { "key": "PROVIDER", "value": "STRIPE" } ], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 205890, "name": "", "description": "" } }, "simplified_mode": false } }, "Wallet - Direct 1": { "value": "", "summary": "Wallet - Direct 1" }, "Wallet Direct": { "value": { "id": "4cc6bc3f-2eb7-4a5f-ac31-ee9be607d863", "account_id": "1e77dc24-9a01-4ffc-a465-7db5c2ced44d", "description": "Apple Pay test", "country": "US", "status": "ERROR", "sub_status": "ERROR", "merchant_order_id": "MER01", "created_at": "2025-08-15T04:35:47.080114Z", "updated_at": "2025-08-15T04:35:47.252759Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 100 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "APPLE_PAY", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "wallet": { "verify": false, "capture": false, "installments": null, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "customer_data": null, "card_data": { "holder_name": "", "iin": "", "lfd": "", "number_length": 0, "security_code_length": 0, "brand": "", "issuer_name": "", "issuer_code": null, "country_code": null, "category": null, "type": "", "fingerprint": null, "expiration_month": null, "expiration_year": null }, "redirect_url": null, "expires_at": null, "ephemeral_public_key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEuW/NN1h3s5rQFiOOfXH7VpiPy4Twbyiy4um/5XJcRlwcRuRfy2574VFMKk4FKalyXZC/J4/hcq/taS8yImRBYg==", "transaction_id": "dcba2ab36bdf5f7131ea1c8c590039a95038cb528cf6d6c8a4326e7b8853dca3" } } }, "additional_data": { "airline": null, "transportations": null, "order": null, "seller_details": null }, "transactions": { "id": "7dc341d7-9974-4123-8570-60e3c296e6f1", "type": "PURCHASE", "status": "ERROR", "category": "WALLET", "amount": 100, "provider_id": "YUNO_ROUTING", "payment_method": { "vaulted_token": "", "type": "APPLE_PAY", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "wallet": { "verify": false, "capture": false, "installments": null, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "customer_data": null, "card_data": { "holder_name": "", "iin": "", "lfd": "", "number_length": 0, "security_code_length": 0, "brand": "", "issuer_name": "", "issuer_code": null, "country_code": null, "category": null, "type": "", "fingerprint": null, "expiration_month": null, "expiration_year": null }, "redirect_url": null, "expires_at": null, "ephemeral_public_key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEuW/NN1h3s5rQFiOOfXH7VpiPy4Twbyiy4um/5XJcRlwcRuRfy2574VFMKk4FKalyXZC/J4/hcq/taS8yImRBYg==", "transaction_id": "dcba2ab36bdf5f7131ea1c8c590039a95038cb528cf6d6c8a4326e7b8853dca3" } } }, "response_code": "YUNO_ROUTING_REJECTED", "response_message": "", "reason": null, "description": null, "merchant_reference": "MER01", "provider_data": { "id": "YUNO_ROUTING", "transaction_id": "", "account_id": "", "status": "", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": null, "created_at": "2025-08-15T04:35:47.180901Z", "updated_at": "2025-08-15T04:35:47.212881Z" }, "transactions_history": [ { "id": "7dc341d7-9974-4123-8570-60e3c296e6f1", "type": "PURCHASE", "status": "ERROR", "category": "WALLET", "amount": 100, "provider_id": "YUNO_ROUTING", "payment_method": { "vaulted_token": "", "type": "APPLE_PAY", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "wallet": { "verify": false, "capture": false, "installments": null, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "customer_data": null, "card_data": { "holder_name": "", "iin": "", "lfd": "", "number_length": 0, "security_code_length": 0, "brand": "", "issuer_name": "", "issuer_code": null, "country_code": null, "category": null, "type": "", "fingerprint": null, "expiration_month": null, "expiration_year": null }, "redirect_url": null, "expires_at": null, "ephemeral_public_key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEuW/NN1h3s5rQFiOOfXH7VpiPy4Twbyiy4um/5XJcRlwcRuRfy2574VFMKk4FKalyXZC/J4/hcq/taS8yImRBYg==", "transaction_id": "dcba2ab36bdf5f7131ea1c8c590039a95038cb528cf6d6c8a4326e7b8853dca3" } } }, "response_code": "YUNO_ROUTING_REJECTED", "response_message": "", "reason": null, "description": "Apple Pay test", "merchant_reference": "MER01", "provider_data": { "id": "YUNO_ROUTING", "transaction_id": "", "account_id": "", "status": "", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": null, "created_at": "2025-08-15T04:35:47.180901Z", "updated_at": "2025-08-15T04:35:47.212881Z" } ], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": null, "simplified_mode": false }, "summary": "Wallet Direct" } }, "schema": { "oneOf": [ { "title": "Payment", "type": "object", "properties": { "id": { "type": "string", "example": "6c44ed29-cc51-4479-a5eb-108afdaadd50" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Payment" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "1744403449" }, "created_at": { "type": "string", "example": "2025-04-11T20:30:49.825637Z" }, "updated_at": { "type": "string", "example": "2025-04-11T20:30:51.953868Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "currency_conversion": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the currency conversion rate query (UUID, 36 chars)." }, "code": { "type": "string", "description": "Yuno's internal identifier for this DCC record. Example: `ccv_01HVK3Z9M2...`." }, "cardholder_currency": { "type": "string", "description": "Currency of the cardholder (ISO 4217, 3 chars)." }, "cardholder_amount": { "type": "number", "description": "Total amount billed to the cardholder in `cardholder_currency`." }, "cardholder_accepted": { "type": "boolean", "description": "Indicates if the cardholder accepted the DCC offer." }, "rate": { "type": "number", "description": "Applied FX rate (markup included)." }, "rate_margin_percentage": { "type": "number", "description": "Markup added over the wholesale rate, expressed as a percentage." }, "rate_source": { "type": "string", "description": "Wholesale benchmark used for the quote." }, "provider": { "type": "string", "description": "DCC provider that issued the quote." }, "description": { "type": "string", "description": "Verbatim disclosure text shown to the cardholder." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp when the DCC provider issued the quote." }, "expires_at": { "type": "string", "format": "date-time", "description": "Timestamp when the quote expires." }, "status": { "type": "string", "description": "Lifecycle state of the conversion.", "enum": [ "QUOTED", "APPLIED", "EXPIRED", "DECLINED", "REVERSED", "SERVICE_UNAVAILABLE", "RATES_UNAVAILABLE", "UNSUPPORTED_CARD", "UNSUPPORTED_LOCAL_CARD", "LESS_THAN_MINIMUM", "NO_INFORMATION" ] }, "error_reason": { "type": "string", "description": "Populated only when DCC could not be applied.", "enum": [ "INVALID_MERCHANT_CONFIGURATION", "CURRENCY_NOT_CONFIGURED", "PROVIDER_NOT_CONFIGURED", "NOT_ELIGIBLE", "BIN_UNKNOWN", "BIN_NOT_ELIGIBLE", "LOCAL_CARD", "UNSUPPORTED_BRAND", "UNSUPPORTED_FUNDING_TYPE", "AMOUNT_BELOW_MINIMUM", "AMOUNT_ABOVE_MAXIMUM", "SERVICE_UNAVAILABLE", "RATES_UNAVAILABLE", "NO_INFORMATION_AVAILABLE", "INVALID_REQUEST", "UNAUTHORISED_REQUEST", "MALFORMED_AMOUNT", "MALFORMED_CURRENCY", "RATE_EXPIRED", "PROVIDER_ERROR", "TIMEOUT", "UNKNOWN" ] }, "provider_data": { "type": "object", "description": "Acquirer round-trip data returned by the underlying provider adapter." } } }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 15000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "7fb7093e-dc67-4c7a-80c5-d25cf5e6ff27" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "dcc06b32-43ad-4627-aa75-c631eb50c2ac" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "8cabcd5c-1b40-4407-b14a-14ab21741865" }, "parent_payment_method_type": {}, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "835631" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "Fannie Weissnat" }, "iin": { "type": "string", "example": "41961111" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 1, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "METABANK" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "PREPAID RELOADABLE" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": { "type": "string", "example": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 24, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "94121f98-98f7-4d57-aa5f-228401d35b12" }, "merchant_customer_id": { "type": "string", "example": "1744402154" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe2@gmail.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.123.167" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge...." }, "device_fingerprints": { "type": "array" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "string" }, "accept_header": { "type": "string", "example": "string" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "string" }, "screen_height": { "type": "string", "example": "string" }, "screen_width": { "type": "string", "example": "string" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "string" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "38799992" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 502" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" }, "neighborhood": { "type": "string", "example": "Test" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 502" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" }, "neighborhood": { "type": "string", "example": "Test" } } }, "merchant_customer_created_at": { "type": "string", "example": "2023-08-05T14:43:58.980718Z" } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "1P-2UUGJW" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "EZE" }, "departure_datetime": { "type": "string", "example": "2014-05-12 13:05:00" }, "departure_airport_timezone": { "type": "string", "example": "-03:00" }, "arrival_airport": { "type": "string", "example": "AMS" }, "arrival_airport_timezone": { "type": "string", "example": "+00:00" }, "arrival_datetime": { "type": "string", "example": "" }, "carrier_code": { "type": "string", "example": "KL" }, "flight_number": { "type": "string", "example": "842" }, "fare_basis_code": { "type": "string", "example": "HL7LNR" }, "fare_class_code": { "type": "string", "example": "FR" }, "base_fare": { "type": "integer", "example": 200, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "s" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "string" }, "last_name": { "type": "string", "example": "string" }, "middle_name": { "type": "string", "example": "string" }, "type": { "type": "string", "example": "s" }, "date_of_birth": { "type": "string", "example": "stringstri" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "351040753" } } }, "country": { "type": "string", "example": "US" }, "loyalty_number": { "type": "string", "example": "string" }, "loyalty_tier": { "type": "string", "example": "strin" }, "email": {}, "phone": {} } } }, "ticket": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "123456" }, "e_ticket": { "type": "boolean", "example": false, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 80, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 22, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 14, "default": 0 }, "issue": {} } }, "tickets": {} } }, "order": { "type": "object", "properties": { "fee_amount": { "type": "number", "example": 40.5, "default": 0 }, "shipping_amount": { "type": "number", "example": 10.35, "default": 0 }, "tip_amount": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 3, "default": 0 }, "unit_amount": { "type": "integer", "example": 20, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" }, "image_url": { "type": "string", "example": "https://cdn.example.com/img/skirt-01.jpg" } } } }, "account_funding": {}, "tickets": {}, "fulfillment": {}, "discounts": {} } }, "seller_details": {} } }, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "9dc9524a-504d-4eaf-84ef-c881b46aab25" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 15000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "dcc06b32-43ad-4627-aa75-c631eb50c2ac" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "8cabcd5c-1b40-4407-b14a-14ab21741865" }, "parent_payment_method_type": {}, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "835631" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "Fannie Weissnat" }, "iin": { "type": "string", "example": "41961111" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 1, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "METABANK" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "PREPAID RELOADABLE" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": { "type": "string", "example": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 24, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Payment" }, "merchant_reference": { "type": "string", "example": "1744403449" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "04d94195-a6ce-455a-b027-5f237f91a576" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": {}, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": {}, "iso8583_response_code": {}, "iso8583_response_message": {} } }, "connection_data": { "type": "object", "properties": { "id": { "type": "string", "example": "90defca1-c913-4894-965c-ed536b65951a" }, "name": {} } }, "created_at": { "type": "string", "example": "2025-04-11T20:30:51.097215Z" }, "updated_at": { "type": "string", "example": "2025-04-11T20:30:51.199007Z" } } }, "transactions_history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "9dc9524a-504d-4eaf-84ef-c881b46aab25" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 15000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "dcc06b32-43ad-4627-aa75-c631eb50c2ac" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "8cabcd5c-1b40-4407-b14a-14ab21741865" }, "parent_payment_method_type": {}, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "835631" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "Fannie Weissnat" }, "iin": { "type": "string", "example": "41961111" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 1, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "METABANK" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "PREPAID RELOADABLE" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": { "type": "string", "example": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 24, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Payment" }, "merchant_reference": { "type": "string", "example": "1744403449" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "04d94195-a6ce-455a-b027-5f237f91a576" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": {}, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": {}, "iso8583_response_code": {}, "iso8583_response_message": {} } }, "connection_data": { "type": "object", "properties": { "id": { "type": "string", "example": "90defca1-c913-4894-965c-ed536b65951a" }, "name": {} } }, "created_at": { "type": "string", "example": "2025-04-11T20:30:51.097215Z" }, "updated_at": { "type": "string", "example": "2025-04-11T20:30:51.199007Z" } } } }, "callback_url": { "type": "string", "example": "http://www.google.com/?checkoutSession=7fb7093e-dc67-4c7a-80c5-d25cf5e6ff27" }, "workflow": { "type": "string", "example": "SDK_CHECKOUT" }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "ID" }, "value": { "type": "string", "example": "1234" } } } }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "smart_routing": { "type": "boolean", "example": false, "default": true }, "monitors": { "type": "boolean", "example": false, "default": true }, "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 146526, "default": 0 }, "name": {}, "description": {} } } } }, "simplified_mode": { "type": "boolean", "example": false, "default": true } } }, { "title": "Card - With card details", "type": "object", "properties": { "id": { "type": "string", "example": "efa9c785-4a56-4652-9e03-fa5d4096c0e7" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "SUCCESSFUL" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "Order_id" }, "created_at": { "type": "string", "example": "2024-06-07T12:13:48.782758Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:13:49.339964Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 20000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "cd174cd4-8f05-48e9-9b5b-cfd338074ab5" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "4b31a9b8-4cd2-4e47-93cf-03729241bd68" }, "merchant_customer_id": { "type": "string", "example": "1717504274" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": {}, "date_of_birth": {}, "email": { "type": "string", "example": "test@test.com" }, "nationality": {}, "ip_address": {}, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": {}, "phone": {}, "billing_address": {}, "shipping_address": {}, "merchant_customer_created_at": {} } }, "additional_data": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "b71f05b7-21e9-4f80-99d9-3818699b9676" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 20000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "cd174cd4-8f05-48e9-9b5b-cfd338074ab5" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCESSFUL" }, "merchant_reference": { "type": "string", "example": "Order_id" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "7a3b40a4-bd94-4293-815b-9e15d1785d6e" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:13:49.007227Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:13:49.144755Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "b71f05b7-21e9-4f80-99d9-3818699b9676" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 20000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "cd174cd4-8f05-48e9-9b5b-cfd338074ab5" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCESSFUL" }, "merchant_reference": { "type": "string", "example": "Order_id" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "7a3b40a4-bd94-4293-815b-9e15d1785d6e" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:13:49.007227Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:13:49.144755Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": { "type": "object", "properties": { "status": { "type": "string" }, "stand_alone": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "status": { "type": "string" }, "response_code": { "type": "string" }, "response_message": { "type": "string" }, "device_fingerprint": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "provider_data": { "type": "object", "properties": { "provider_id": { "type": "string" }, "transaction_id": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "string" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object" }, "account_id": { "type": "string" }, "status_detail": { "type": "string" }, "three_d_secure_provider": { "type": "string" }, "three_d_secure_setup_transaction_id": { "type": "string" }, "strong_customer_authentication_exemptions": { "type": "array", "items": { "type": "string" } } } } } } } } }, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With airline data", "type": "object", "properties": { "id": { "type": "string", "example": "638608bf-7af8-4061-9a49-5854de19bd1f" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "SUCCESSFUL" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "Order_id" }, "created_at": { "type": "string", "example": "2024-06-07T12:15:45.471147Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:15:46.120918Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 2000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "d54fffab-0a82-456e-9703-1bf6a8cda3ec" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": {}, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1998-01-01" }, "email": { "type": "string", "example": "test@test.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.0.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": {}, "billing_address": {}, "shipping_address": {}, "merchant_customer_created_at": {} } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "ABC123" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "JFK" }, "departure_datetime": { "type": "string", "example": "2024-07-03T05:00:00" }, "departure_airport_timezone": { "type": "string", "example": "GMT-05" }, "arrival_airport": { "type": "string", "example": "LAX" }, "arrival_airport_timezone": { "type": "string", "example": "+00:00" }, "arrival_datetime": { "type": "string", "example": "" }, "carrier_code": { "type": "string", "example": "AA" }, "flight_number": { "type": "string", "example": "AA123" }, "fare_basis_code": { "type": "string", "example": "Y" }, "fare_class_code": { "type": "string", "example": "S" }, "base_fare": { "type": "integer", "example": 1800, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "O" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "middle_name": { "type": "string", "example": "Stephen" }, "type": { "type": "string", "example": "A" }, "date_of_birth": { "type": "string", "example": "1998-01-01" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "987-65-4321" } } }, "country": {}, "loyalty_number": { "type": "string", "example": "79250001" }, "loyalty_tier": { "type": "string", "example": "DIAMOND" }, "email": { "type": "string", "example": "john.doe@company.com" }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "1234567890" }, "country_code": { "type": "string", "example": "1" } } } } } }, "ticket": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "BRB0001" }, "e_ticket": { "type": "boolean", "example": true, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 2000, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 180, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 20, "default": 0 }, "issue": { "type": "object", "properties": { "carrier_prefix_code": { "type": "string", "example": "AA" }, "travel_agent_code": { "type": "string", "example": "A12345" }, "travel_agent_name": { "type": "string", "example": "TRAVEL AGENCY" }, "date": { "type": "string", "example": "2023-10-31T01:30:00.000-05:00" }, "address": { "type": "string", "example": "123 Main St" }, "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" } } } } } } } }, "order": {}, "seller_details": {} } }, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "35c85e3c-56b0-4a55-b60e-5da2afc6559a" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 2000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "d54fffab-0a82-456e-9703-1bf6a8cda3ec" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCESSFUL" }, "merchant_reference": { "type": "string", "example": "Order_id" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "42ef6b28-3e37-4d4e-8fbd-13e29088b7ce" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:15:45.762412Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:15:45.957053Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "35c85e3c-56b0-4a55-b60e-5da2afc6559a" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 2000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "d54fffab-0a82-456e-9703-1bf6a8cda3ec" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCESSFUL" }, "merchant_reference": { "type": "string", "example": "Order_id" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "42ef6b28-3e37-4d4e-8fbd-13e29088b7ce" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:15:45.762412Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:15:45.957053Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": { "type": "object", "properties": { "status": { "type": "string" }, "stand_alone": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "status": { "type": "string" }, "response_code": { "type": "string" }, "response_message": { "type": "string" }, "device_fingerprint": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "provider_data": { "type": "object", "properties": { "provider_id": { "type": "string" }, "transaction_id": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "string" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object" }, "account_id": { "type": "string" }, "status_detail": { "type": "string" }, "three_d_secure_provider": { "type": "string" }, "three_d_secure_setup_transaction_id": { "type": "string" }, "strong_customer_authentication_exemptions": { "type": "array", "items": { "type": "string" } } } } } } } } }, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With customer, billing, and shipping details", "type": "object", "properties": { "id": { "type": "string", "example": "f1169cba-5bda-4f38-8669-6dc0dedb1cb5" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-07T12:18:31.082609Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:18:31.603608Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "28d3d22e-21d4-4a3a-a7e1-bac6051650ce" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690160581" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "Building 43" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "Building 43" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "4928abcc-bab9-45b2-82e7-d73a5cf1e6d4" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "28d3d22e-21d4-4a3a-a7e1-bac6051650ce" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-4bb325a6-bbec-4390-b4a0-876244e2fed4" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "ea1aa51e-e717-4546-9c6f-64716d989c82" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:18:31.326706Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:18:31.511058Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "4928abcc-bab9-45b2-82e7-d73a5cf1e6d4" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "28d3d22e-21d4-4a3a-a7e1-bac6051650ce" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-4bb325a6-bbec-4390-b4a0-876244e2fed4" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "ea1aa51e-e717-4546-9c6f-64716d989c82" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:18:31.326706Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:18:31.511058Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": { "type": "object", "properties": { "status": { "type": "string" }, "stand_alone": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "status": { "type": "string" }, "response_code": { "type": "string" }, "response_message": { "type": "string" }, "device_fingerprint": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "provider_data": { "type": "object", "properties": { "provider_id": { "type": "string" }, "transaction_id": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "string" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object" }, "account_id": { "type": "string" }, "status_detail": { "type": "string" }, "three_d_secure_provider": { "type": "string" }, "three_d_secure_setup_transaction_id": { "type": "string" }, "strong_customer_authentication_exemptions": { "type": "array", "items": { "type": "string" } } } } } } } } }, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With customer, billing, shipping and order items", "type": "object", "properties": { "id": { "type": "string", "example": "dca02690-a71c-4d2e-b804-18894dc882bc" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-07T12:19:38.030912Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:19:38.678558Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "6a01dff2-2f2b-469f-b5e1-748b4bff74e0" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690160896" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "Building 43" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "Building 43" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 0, "default": 0 }, "shipping_amount": { "type": "integer", "example": 0, "default": 0 }, "tip_amount": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 5000, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" }, "image_url": { "type": "string", "example": "https://cdn.example.com/img/skirt-01.jpg" } } } } } }, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "bf22cc6e-5fc6-48eb-8b23-a436e966e396" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "6a01dff2-2f2b-469f-b5e1-748b4bff74e0" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-91bd1b3e-4cf7-43ed-ab5b-12448a0ccffc" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "dc591ae7-638e-42cb-b040-f516910544b4" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:19:38.504882Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:19:38.597089Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "bf22cc6e-5fc6-48eb-8b23-a436e966e396" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "6a01dff2-2f2b-469f-b5e1-748b4bff74e0" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-91bd1b3e-4cf7-43ed-ab5b-12448a0ccffc" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "dc591ae7-638e-42cb-b040-f516910544b4" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:19:38.504882Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:19:38.597089Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With installments", "type": "object", "properties": { "id": { "type": "string", "example": "31d7ae21-2786-4c5f-bbdd-b232217a093b" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-07T12:20:48.854498Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:20:49.177216Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 3, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "50fb98cb-57c8-4008-bc50-c7bede574dbf" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "95083b42-55b3-468b-9cf4-05dfe6efeb61" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 3, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "50fb98cb-57c8-4008-bc50-c7bede574dbf" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-660caf6a-9e37-4f4c-934f-961406790435" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "540111bb-597a-45c7-b4eb-7611ae1d364a" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:20:49.004461Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:20:49.113139Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "95083b42-55b3-468b-9cf4-05dfe6efeb61" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 3, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "50fb98cb-57c8-4008-bc50-c7bede574dbf" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-660caf6a-9e37-4f4c-934f-961406790435" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "540111bb-597a-45c7-b4eb-7611ae1d364a" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:20:49.004461Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:20:49.113139Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With authorization", "type": "object", "properties": { "id": { "type": "string", "example": "62fe7b57-9fab-495b-8d0c-00493b23382c" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "PENDING" }, "sub_status": { "type": "string", "example": "AUTHORIZED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-07T12:21:52.234096Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:21:52.751636Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "44b0c463-d567-4e1c-b9c0-9ab8b7876b67" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "560b1feb-972f-49d7-9517-7e950cec942a" }, "type": { "type": "string", "example": "AUTHORIZE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "44b0c463-d567-4e1c-b9c0-9ab8b7876b67" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-4acdf5cc-620b-4e99-bcd7-3406b78ec941" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "717de0b5-f1b6-4a3b-8e12-88c619da4e8e" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:21:52.427906Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:21:52.555318Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "560b1feb-972f-49d7-9517-7e950cec942a" }, "type": { "type": "string", "example": "AUTHORIZE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "44b0c463-d567-4e1c-b9c0-9ab8b7876b67" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-4acdf5cc-620b-4e99-bcd7-3406b78ec941" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "717de0b5-f1b6-4a3b-8e12-88c619da4e8e" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:21:52.427906Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:21:52.555318Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With merchant advice code (MAC)", "type": "object", "properties": { "id": { "type": "string", "example": "62fe7b57-9fab-495b-8d0c-00493b23382c" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "PENDING" }, "sub_status": { "type": "string", "example": "AUTHORIZED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-07T12:21:52.234096Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:21:52.751636Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "44b0c463-d567-4e1c-b9c0-9ab8b7876b67" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "560b1feb-972f-49d7-9517-7e950cec942a" }, "type": { "type": "string", "example": "AUTHORIZE" }, "status": { "type": "string", "example": "DECLINED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "44b0c463-d567-4e1c-b9c0-9ab8b7876b67" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "DECLINED" }, "response_message": { "type": "string", "example": "Transaction declined" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-4acdf5cc-620b-4e99-bcd7-3406b78ec941" }, "merchant_advice_code": { "type": "string", "example": "TRY_AGAIN_LATER" }, "merchant_advice_code_message": { "type": "string", "example": "Retry within 30 days" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "717de0b5-f1b6-4a3b-8e12-88c619da4e8e" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "DECLINED" }, "status_detail": { "type": "string", "example": "" }, "merchant_advice_code": { "type": "string", "example": "51" }, "merchant_advice_code_message": { "type": "string", "example": "Insufficient funds – try again later" }, "response_message": { "type": "string", "example": "Insufficient funds" }, "response_code": { "type": "string", "example": "51" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:21:52.427906Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:21:52.555318Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "560b1feb-972f-49d7-9517-7e950cec942a" }, "type": { "type": "string", "example": "AUTHORIZE" }, "status": { "type": "string", "example": "DECLINED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "44b0c463-d567-4e1c-b9c0-9ab8b7876b67" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "DECLINED" }, "response_message": { "type": "string", "example": "Transaction declined" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-4acdf5cc-620b-4e99-bcd7-3406b78ec941" }, "merchant_advice_code": { "type": "string", "example": "TRY_AGAIN_LATER" }, "merchant_advice_code_message": { "type": "string", "example": "Retry within 30 days" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "717de0b5-f1b6-4a3b-8e12-88c619da4e8e" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "DECLINED" }, "status_detail": { "type": "string", "example": "" }, "merchant_advice_code": { "type": "string", "example": "51" }, "merchant_advice_code_message": { "type": "string", "example": "Insufficient funds – try again later" }, "response_message": { "type": "string", "example": "Insufficient funds" }, "response_code": { "type": "string", "example": "51" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:21:52.427906Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:21:52.555318Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With device fingerprint", "type": "object", "properties": { "id": { "type": "string", "example": "48afc1fa-3de7-408c-8066-8278d7f9beab" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-07T12:24:52.264241Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:24:52.693718Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "acf8d864-8e87-42b4-8041-59216e3f1a88" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" } } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "c29bc9f6-fb80-44b9-b421-5f50e2ef5724" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "acf8d864-8e87-42b4-8041-59216e3f1a88" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-f3646ea1-b573-4548-9c2e-0a8fdbaf5525" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "7651d9d2-ae39-4a87-854e-5f27332ec3d6" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:24:52.427414Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:24:52.614018Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "c29bc9f6-fb80-44b9-b421-5f50e2ef5724" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "acf8d864-8e87-42b4-8041-59216e3f1a88" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-f3646ea1-b573-4548-9c2e-0a8fdbaf5525" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "7651d9d2-ae39-4a87-854e-5f27332ec3d6" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:24:52.427414Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:24:52.614018Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With vault on success", "type": "object", "properties": { "id": { "type": "string", "example": "6b8a3776-9171-45a7-b493-9b2f9b6162f2" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-07T12:25:40.798647Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:25:41.624438Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "b527529f-0662-42e3-a597-0881b4cf8b0a" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "67fe53c7-0c94-4880-9599-411bc2373096" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "967ecd18-d898-4b88-9400-dd5b01b18edc" }, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge287gbd8d7d78" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" } } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "99f645ed-fd20-48ca-8715-c3a817a5bb1e" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "b527529f-0662-42e3-a597-0881b4cf8b0a" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "67fe53c7-0c94-4880-9599-411bc2373096" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-212be171-5061-4207-abdd-4b48bd743e16" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "102901fd-7d44-4889-9200-0b9217ea081d" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:25:40.942576Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:25:41.050420Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "99f645ed-fd20-48ca-8715-c3a817a5bb1e" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "b527529f-0662-42e3-a597-0881b4cf8b0a" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "67fe53c7-0c94-4880-9599-411bc2373096" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-212be171-5061-4207-abdd-4b48bd743e16" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "102901fd-7d44-4889-9200-0b9217ea081d" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:25:40.942576Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:25:41.050420Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With vaulted token", "type": "object", "properties": { "id": { "type": "string", "example": "6a414d8d-bea3-452d-bf1a-b2bfed245e45" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-07T12:26:25.365858Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:26:25.767076Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "e0d334a5-b4d0-4623-bcc3-b9c64b5cc7cb" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "967ecd18-d898-4b88-9400-dd5b01b18edc" }, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge287gbd8d7d78" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1600 Amphitheatre Parkway" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "CA" }, "city": { "type": "string", "example": "Mountain View" }, "zip_code": { "type": "string", "example": "94043" } } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "545ad2a0-d7aa-4cce-be7f-d1fa6e093986" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "e0d334a5-b4d0-4623-bcc3-b9c64b5cc7cb" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-b912e874-5086-4757-8224-11644af710d0" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "664fa5e8-67c2-4d87-aa19-bfa90532cf2b" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:26:25.533632Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:26:25.646797Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "545ad2a0-d7aa-4cce-be7f-d1fa6e093986" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "e0d334a5-b4d0-4623-bcc3-b9c64b5cc7cb" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-b912e874-5086-4757-8224-11644af710d0" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "664fa5e8-67c2-4d87-aa19-bfa90532cf2b" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:26:25.533632Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:26:25.646797Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Alternative payment method", "type": "object", "properties": { "id": { "type": "string", "example": "a3f96c96-f1cb-4f97-b63b-9e4881f14778" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test ADDI" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2024-06-07T12:29:19.614206Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:29:21.531934Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 52000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "7d4a1e92-7f66-45ae-82e7-cea52a8f8e8f" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "ADDI" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": {}, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=534d57d1-78a7-4670-b0a5-79c9c6a8259e" }, "customer_data": {} } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "example00234" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": {}, "shipping_address": {}, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "97a498dc-c50a-4bf1-97c5-f0dd1993f707" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "BUY_NOW_PAY_LATER" }, "amount": { "type": "integer", "example": 52000, "default": 0 }, "provider_id": { "type": "string", "example": "ADDI" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "ADDI" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": {}, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=534d57d1-78a7-4670-b0a5-79c9c6a8259e" }, "customer_data": {} } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test ADDI" }, "merchant_reference": { "type": "string", "example": "0000022" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ADDI" }, "transaction_id": { "type": "string", "example": "0000022" }, "account_id": { "type": "string", "example": "Bs3IB9WgGHvsiOgVt0VpHoXkx8RIeu1r" }, "status": { "type": "string", "example": "CREATED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": {} } }, "created_at": { "type": "string", "example": "2024-06-07T12:29:19.797875Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:29:21.462594Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "97a498dc-c50a-4bf1-97c5-f0dd1993f707" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "BUY_NOW_PAY_LATER" }, "amount": { "type": "integer", "example": 52000, "default": 0 }, "provider_id": { "type": "string", "example": "ADDI" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "ADDI" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": {}, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=534d57d1-78a7-4670-b0a5-79c9c6a8259e" }, "customer_data": {} } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test ADDI" }, "merchant_reference": { "type": "string", "example": "0000022" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ADDI" }, "transaction_id": { "type": "string", "example": "0000022" }, "account_id": { "type": "string", "example": "Bs3IB9WgGHvsiOgVt0VpHoXkx8RIeu1r" }, "status": { "type": "string", "example": "CREATED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": {} } }, "created_at": { "type": "string", "example": "2024-06-07T12:29:19.797875Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:29:21.462594Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 8012, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With shipping, fee and tip amount", "type": "object", "properties": { "id": { "type": "string", "example": "591b4df0-6b18-494b-8a30-b88d7f999e03" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Cards" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2024-06-07T12:48:21.476913Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:48:22.097913Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "10edfb5f-e658-446e-99b6-999598efc145" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "ec9f354e-52e5-4509-ac4e-c3035dcdf111" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "54867b9c-989a-426e-86f2-2fc703fe8c7c" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "08bb27be-1256-4067-976f-7f589707e90e" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41961111" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "META BANK" }, "issuer_code": {}, "category": { "type": "string", "example": "PREPAID RELOADABLE" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "a577ad8f-08f1-4590-9cf1-e7679b15ee84" }, "merchant_customer_id": { "type": "string", "example": "1717677815" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": { "type": "string", "example": "Suite 500" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": { "type": "string", "example": "Suite 500" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 500, "default": 0 }, "shipping_amount": { "type": "integer", "example": 100, "default": 0 }, "tip_amount": { "type": "integer", "example": 50, "default": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 5000, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" }, "image_url": { "type": "string", "example": "https://cdn.example.com/img/skirt-01.jpg" } } } } } }, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "dd1beb86-9cce-44d3-80f9-dd77eb927a6e" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 100, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "ec9f354e-52e5-4509-ac4e-c3035dcdf111" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "54867b9c-989a-426e-86f2-2fc703fe8c7c" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "08bb27be-1256-4067-976f-7f589707e90e" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41961111" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "META BANK" }, "issuer_code": {}, "category": { "type": "string", "example": "PREPAID RELOADABLE" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Cards" }, "merchant_reference": { "type": "string", "example": "Pago de test 001" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "b00cc57c-cd98-435a-a1c9-7a5f5c6e7481" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:48:21.698209Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:48:21.859552Z" } } }, "transactions_history": { "type": "object", "properties": { "id": { "type": "string", "example": "dd1beb86-9cce-44d3-80f9-dd77eb927a6e" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 100, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "ec9f354e-52e5-4509-ac4e-c3035dcdf111" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "54867b9c-989a-426e-86f2-2fc703fe8c7c" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "08bb27be-1256-4067-976f-7f589707e90e" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41961111" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "META BANK" }, "issuer_code": {}, "category": { "type": "string", "example": "PREPAID RELOADABLE" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Cards" }, "merchant_reference": { "type": "string", "example": "Pago de test 001" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "b00cc57c-cd98-435a-a1c9-7a5f5c6e7481" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-07T12:48:21.698209Z" }, "updated_at": { "type": "string", "example": "2024-06-07T12:48:21.859552Z" } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "https://google.com/?checkoutSession=10edfb5f-e658-446e-99b6-999598efc145" }, "workflow": { "type": "string", "example": "SDK_CHECKOUT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 76152, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Card - With NT", "type": "object", "properties": { "id": { "type": "string", "example": "bc0489ba-80bf-4bb9-98c5-ff8dfbceebf9" }, "account_id": { "type": "string", "example": "64761a45-6e49-4ea5-a6ff-6b52030b92ac" }, "description": { "type": "string", "example": "SUCCESSFUL" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "Order_id" }, "created_at": { "type": "string", "example": "2023-07-12T18:51:49.437886Z" }, "updated_at": { "type": "string", "example": "2023-07-12T18:51:54.679410Z" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 20000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "517862" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "network_token": { "type": "object", "properties": { "network": { "type": "string", "example": "MASTERCARD" }, "status": { "type": "string", "example": "ACTIVE" }, "par": { "type": "string", "example": "V0010014622074319305424002620" }, "token_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "45079900" }, "lfd": { "type": "string", "example": "0010" }, "expiration_month": { "type": "string", "example": "10" }, "expiration_year": { "type": "string", "example": "2028" }, "network_payment_reference": { "type": "string", "example": "MCC000000355" }, "response": { "type": "object", "properties": { "code": { "type": "string", "example": "succeeded" }, "message": { "type": "string", "example": "Transaction Succeeded" } } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "a76d79b7-902f-4152-922f-7e7eebc5f3dc" }, "merchant_customer_id": { "type": "string", "example": "1309" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": {}, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "string" }, "accept_header": { "type": "string", "example": "string" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "32" }, "screen_height": { "type": "string", "example": "32" }, "screen_width": { "type": "string", "example": "32" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "string" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5555551234" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "New York" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "New York" } } } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "c718b8e9-2943-4fdf-9b3c-426cf44940fb" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 20000, "default": 0 }, "provider_id": { "type": "string", "example": "DLOCAL" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "517862" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "network_token": { "type": "object", "properties": { "network": { "type": "string", "example": "MASTERCARD" }, "status": { "type": "string", "example": "ACTIVE" }, "par": { "type": "string", "example": "V0010014622074319305424002620" }, "token_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "45079900" }, "lfd": { "type": "string", "example": "0010" }, "expiration_month": { "type": "string", "example": "10" }, "expiration_year": { "type": "string", "example": "2028" }, "network_payment_reference": { "type": "string", "example": "MCC000000355" }, "response": { "type": "object", "properties": { "code": { "type": "string", "example": "succeeded" }, "message": { "type": "string", "example": "Transaction Succeeded" } } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCESSFUL" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "DLOCAL" }, "transaction_id": { "type": "string", "example": "T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PAID" }, "status_detail": { "type": "string", "example": "200" }, "response_message": { "type": "string", "example": "The payment was paid." }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "{\"id\":\"T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42\",\"amount\":20000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":11,\"expiration_year\":2028,\"brand\":\"VI\",\"last4\":\"1111\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-12T18:51:52.000+0000\",\"approved_date\":\"2023-07-12T18:51:54.000+0000\",\"status\":\"PAID\",\"status_detail\":\"The payment was paid.\",\"status_code\":\"200\",\"order_id\":\"c718b8e9-2943-4fdf-9b3c-426cf44940fb\",\"description\":\"SUCCESSFUL\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"517862\"}}" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-12T18:51:51.908784Z" }, "updated_at": { "type": "string", "example": "2023-07-12T18:51:54.426087Z" } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" } } }, { "title": "Wallet - Direct", "type": "object", "properties": { "id": { "type": "string", "example": "83ef67f1-db87-4c78-918a-e1199c8f9889" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "description": { "type": "string", "example": "Test Apple Pay" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "1719585343" }, "created_at": { "type": "string", "example": "2024-06-28T14:35:47.193965Z" }, "updated_at": { "type": "string", "example": "2024-06-28T14:35:52.918803Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 500, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "0a3666b1-ea6e-4ebb-937d-5a9f69ef2b77" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "48302690" }, "lfd": { "type": "string", "example": "9081" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 0, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "UNITED OVERSEAS BANK" }, "issuer_code": {}, "category": { "type": "string", "example": "PLATINUM" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } }, "fingerprint": {} } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "36e470e3-eeb7-4b3a-9b51-57eb78eb0476" }, "merchant_customer_id": { "type": "string", "example": "1719502776" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": {}, "date_of_birth": {}, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": {}, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": {}, "billing_address": {}, "shipping_address": {}, "merchant_customer_created_at": {} } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "f1caa080-9174-481a-8c04-62e790b257bc" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 500, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "0a3666b1-ea6e-4ebb-937d-5a9f69ef2b77" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "48302690" }, "lfd": { "type": "string", "example": "9081" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 0, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "UNITED OVERSEAS BANK" }, "issuer_code": {}, "category": { "type": "string", "example": "PLATINUM" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } }, "fingerprint": {} } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Apple Pay" }, "merchant_reference": { "type": "string", "example": "1719585343" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "14d38e69-25fe-414b-96d0-fa829c4ea2e8" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-28T14:35:48.757654Z" }, "updated_at": { "type": "string", "example": "2024-06-28T14:35:52.414067Z" } } }, "transactions_history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "f1caa080-9174-481a-8c04-62e790b257bc" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 500, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "0a3666b1-ea6e-4ebb-937d-5a9f69ef2b77" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "48302690" }, "lfd": { "type": "string", "example": "9081" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 0, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "UNITED OVERSEAS BANK" }, "issuer_code": {}, "category": { "type": "string", "example": "PLATINUM" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } }, "fingerprint": {} } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Apple Pay" }, "merchant_reference": { "type": "string", "example": "1719585343" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "14d38e69-25fe-414b-96d0-fa829c4ea2e8" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2024-06-28T14:35:48.757654Z" }, "updated_at": { "type": "string", "example": "2024-06-28T14:35:52.414067Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 34646, "default": 0 }, "name": {}, "description": {} } } } } } }, { "title": "Split Marketplace", "type": "object", "properties": { "id": { "type": "string", "example": "2886d661-43a3-4298-9c60-d0d519146eae" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "description": { "type": "string", "example": "SUCCEEDED" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "1726689692" }, "created_at": { "type": "string", "example": "2024-09-18T20:01:34.641603Z" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:37.787304Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "currency_conversion": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the currency conversion rate query (UUID, 36 chars)." }, "code": { "type": "string", "description": "Yuno's internal identifier for this DCC record. Example: `ccv_01HVK3Z9M2...`." }, "cardholder_currency": { "type": "string", "description": "Currency of the cardholder (ISO 4217, 3 chars)." }, "cardholder_amount": { "type": "number", "description": "Total amount billed to the cardholder in `cardholder_currency`." }, "cardholder_accepted": { "type": "boolean", "description": "Indicates if the cardholder accepted the DCC offer." }, "rate": { "type": "number", "description": "Applied FX rate (markup included)." }, "rate_margin_percentage": { "type": "number", "description": "Markup added over the wholesale rate, expressed as a percentage." }, "rate_source": { "type": "string", "description": "Wholesale benchmark used for the quote." }, "provider": { "type": "string", "description": "DCC provider that issued the quote." }, "description": { "type": "string", "description": "Verbatim disclosure text shown to the cardholder." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp when the DCC provider issued the quote." }, "expires_at": { "type": "string", "format": "date-time", "description": "Timestamp when the quote expires." }, "status": { "type": "string", "description": "Lifecycle state of the conversion.", "enum": [ "QUOTED", "APPLIED", "EXPIRED", "DECLINED", "REVERSED", "SERVICE_UNAVAILABLE", "RATES_UNAVAILABLE", "UNSUPPORTED_CARD", "UNSUPPORTED_LOCAL_CARD", "LESS_THAN_MINIMUM", "NO_INFORMATION" ] }, "error_reason": { "type": "string", "description": "Populated only when DCC could not be applied.", "enum": [ "INVALID_MERCHANT_CONFIGURATION", "CURRENCY_NOT_CONFIGURED", "PROVIDER_NOT_CONFIGURED", "NOT_ELIGIBLE", "BIN_UNKNOWN", "BIN_NOT_ELIGIBLE", "LOCAL_CARD", "UNSUPPORTED_BRAND", "UNSUPPORTED_FUNDING_TYPE", "AMOUNT_BELOW_MINIMUM", "AMOUNT_ABOVE_MAXIMUM", "SERVICE_UNAVAILABLE", "RATES_UNAVAILABLE", "NO_INFORMATION_AVAILABLE", "INVALID_REQUEST", "UNAUTHORISED_REQUEST", "MALFORMED_AMOUNT", "MALFORMED_CURRENCY", "RATE_EXPIRED", "PROVIDER_ERROR", "TIMEOUT", "UNKNOWN" ] }, "provider_data": { "type": "object", "description": "Acquirer round-trip data returned by the underlying provider adapter." } } }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "847277" }, "retrieval_reference_number": { "type": "string", "example": "2206177255" }, "acquirer_reference_number": { "type": "string", "example": "2206177255" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40000000" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "CHASE BANK" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "STANDARD" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": {} } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "6c75c6aa-9602-4a31-b772-41de43586cfb" }, "merchant_customer_id": { "type": "string", "example": "example00234" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.123.167" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge...." }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "string" }, "accept_header": { "type": "string", "example": "string" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "string" }, "screen_height": { "type": "string", "example": "string" }, "screen_width": { "type": "string", "example": "string" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "string" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": { "type": "object", "properties": { "fee_amount": {}, "shipping_amount": {}, "tip_amount": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 5000, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" }, "image_url": { "type": "string", "example": "https://cdn.example.com/img/skirt-01.jpg" } } } } } }, "seller_details": {} } }, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "8c5cc283-9c01-4ab0-938e-226c19536ce4" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": [ "PAGARME", "ALELO", "EDENRED", "PLUXEE", "VR", "STRIPE", "ADYEN" ] }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "847277" }, "retrieval_reference_number": { "type": "string", "example": "2206177255" }, "acquirer_reference_number": { "type": "string", "example": "2206177255" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John" }, "iin": { "type": "string", "example": "40000000" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "STANDARD" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": {} } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCEDED" }, "merchant_reference": { "type": "string", "example": "1726689692" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": [ "PAGARME", "ALELO", "EDENRED", "PLUXEE", "VR", "STRIPE", "ADYEN" ] }, "transaction_id": { "type": "string", "example": "ch_Roz1ld4HkcRb1A4W" }, "account_id": { "type": "string", "example": "sk_test_5eaa117d8c524eae8836438a49fdaefd" }, "status": { "type": "string", "example": "captured" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "Transaction approved successfully" }, "response_code": { "type": "string", "example": "200" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "integer", "example": 500000, "default": 0 }, "charges": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer", "example": 500000, "default": 0 }, "code": { "type": "string", "example": "PDXHD8BNER" }, "created_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "currency": { "type": "string", "example": "USD" }, "customer": { "type": "object", "properties": { "address": { "type": "object", "properties": { "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "created_at": { "type": "string", "example": "2024-09-13T19:37:46Z" }, "id": { "type": "string", "example": "addr_EoRV4ZjhrhV4N7W3" }, "line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "state": { "type": "string", "example": "NY" }, "status": { "type": "string", "example": "active" }, "updated_at": { "type": "string", "example": "2024-09-18T19:37:01Z" }, "zip_code": { "type": "string", "example": "111111" } } }, "created_at": { "type": "string", "example": "2024-09-13T19:37:46Z" }, "delinquent": { "type": "boolean", "example": false, "default": true }, "document": { "type": "string", "example": "83885322005" }, "document_type": { "type": "string", "example": "cpf" }, "email": { "type": "string", "example": "Johndoe@y.uno" }, "id": { "type": "string", "example": "cus_78Y42XPSkSZ2ky3P" }, "metadata": { "type": "object", "properties": { "platform_integration": { "type": "string", "example": "yuno" } } }, "name": { "type": "string", "example": "John Doe" }, "phones": { "type": "object", "properties": { "home_phone": { "type": "object", "properties": { "area_code": { "type": "string", "example": "31" }, "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "32450765" } } }, "mobile_phone": { "type": "object", "properties": { "area_code": { "type": "string", "example": "31" }, "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "32450765" } } } } }, "type": { "type": "string", "example": "individual" }, "updated_at": { "type": "string", "example": "2024-09-18T19:37:01Z" } } }, "gateway_id": { "type": "string", "example": "2206177255" }, "id": { "type": "string", "example": "ch_Roz1ld4HkcRb1A4W" }, "last_transaction": { "type": "object", "properties": { "acquirer_auth_code": { "type": "string", "example": "847277" }, "acquirer_message": { "type": "string", "example": "Transaction approved successfully" }, "acquirer_name": { "type": "string", "example": "pagarme" }, "acquirer_nsu": { "type": "string", "example": "2206177255" }, "acquirer_return_code": { "type": "string", "example": "0000" }, "acquirer_tid": { "type": "string", "example": "2206177255" }, "amount": { "type": "integer", "example": 500000, "default": 0 }, "antifraud_response": { "type": "object", "properties": { "provider_name": { "type": "string", "example": "pagarme" }, "score": { "type": "string", "example": "very_low" }, "status": { "type": "string", "example": "approved" } } }, "card": { "type": "object", "properties": { "billing_address": { "type": "object", "properties": { "city": { "type": "string", "example": "New York" }, "complement": { "type": "string", "example": "Apartamento 502, Torre I" }, "country": { "type": "string", "example": "US" }, "line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "line_2": { "type": "string", "example": "Apartamento 502, Torre I" }, "state": { "type": "string", "example": "NY" }, "street": { "type": "string", "example": "Calle 34 # 56 - 78" }, "zip_code": { "type": "string", "example": "111111" } } }, "brand": { "type": "string", "example": "Visa" }, "created_at": { "type": "string", "example": "2024-09-17T18:12:52Z" }, "exp_month": { "type": "integer", "example": 3, "default": 0 }, "exp_year": { "type": "integer", "example": 2030, "default": 0 }, "first_six_digits": { "type": "string", "example": "400000" }, "holder_name": { "type": "string", "example": "John" }, "id": { "type": "string", "example": "card_4QyP124IVIWDbpqO" }, "last_four_digits": { "type": "string", "example": "0010" }, "status": { "type": "string", "example": "active" }, "type": { "type": "string", "example": "credit" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:35Z" } } }, "created_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "funding_source": { "type": "string", "example": "credit" }, "gateway_id": { "type": "string", "example": "2206177255" }, "gateway_response": { "type": "object", "properties": { "code": { "type": "string", "example": "200" }, "errors": { "type": "array" } } }, "id": { "type": "string", "example": "tran_xgr0Om8HXQi5X4pJ" }, "installments": { "type": "integer", "example": 1, "default": 0 }, "metadata": { "type": "object", "properties": {} }, "operation_type": { "type": "string", "example": "auth_and_capture" }, "split": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer", "example": 400000, "default": 0 }, "gateway_id": { "type": "string", "example": "sr_cm18agoda1hdd0k9t5kh2hb76" }, "id": { "type": "string", "example": "sr_cm18agoda1hdd0k9t5kh2hb76" }, "options": { "type": "object", "properties": { "charge_processing_fee": { "type": "boolean", "example": true, "default": true }, "charge_remainder_fee": { "type": "boolean", "example": true, "default": true }, "liable": { "type": "boolean", "example": true, "default": true } } }, "recipient": { "type": "object", "properties": { "created_at": { "type": "string", "example": "2024-09-17T16:38:32Z" }, "description": { "type": "string", "example": "" }, "document": { "type": "string", "example": "26224451990" }, "email": { "type": "string", "example": "steverogers@yuno.com" }, "id": { "type": "string", "example": "re_cm16nrp0u0tl60k9t1lopi9ld" }, "name": { "type": "string", "example": "Steve Rogers" }, "payment_mode": { "type": "string", "example": "bank_transfer" }, "status": { "type": "string", "example": "active" }, "type": { "type": "string", "example": "company" }, "updated_at": { "type": "string", "example": "2024-09-17T16:38:32Z" } } }, "type": { "type": "string", "example": "flat" } } } }, "status": { "type": "string", "example": "captured" }, "success": { "type": "boolean", "example": true, "default": true }, "transaction_type": { "type": "string", "example": "credit_card" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:35Z" } } }, "paid_amount": { "type": "integer", "example": 500000, "default": 0 }, "paid_at": { "type": "string", "example": "2024-09-18T20:01:37Z" }, "payment_method": { "type": "string", "example": "credit_card" }, "status": { "type": "string", "example": "paid" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:37Z" } } } }, "checkouts": { "type": "array" }, "closed": { "type": "boolean", "example": true, "default": true }, "closed_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "code": { "type": "string", "example": "PDXHD8BNER" }, "created_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "currency": { "type": "string", "example": "USD" }, "customer": { "type": "object", "properties": { "address": { "type": "object", "properties": { "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "created_at": { "type": "string", "example": "2024-09-13T19:37:46Z" }, "id": { "type": "string", "example": "addr_EoRV4ZjhrhV4N7W3" }, "line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "state": { "type": "string", "example": "NY" }, "status": { "type": "string", "example": "active" }, "updated_at": { "type": "string", "example": "2024-09-18T19:37:01Z" }, "zip_code": { "type": "string", "example": "111111" } } }, "created_at": { "type": "string", "example": "2024-09-13T19:37:46Z" }, "delinquent": { "type": "boolean", "example": false, "default": true }, "document": { "type": "string", "example": "83885322005" }, "document_type": { "type": "string", "example": "cpf" }, "email": { "type": "string", "example": "Johndoe@y.uno" }, "id": { "type": "string", "example": "cus_78Y42XPSkSZ2ky3P" }, "metadata": { "type": "object", "properties": { "platform_integration": { "type": "string", "example": "yuno" } } }, "name": { "type": "string", "example": "John Doe" }, "phones": { "type": "object", "properties": { "home_phone": { "type": "object", "properties": { "area_code": { "type": "string", "example": "31" }, "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "32450765" } } }, "mobile_phone": { "type": "object", "properties": { "area_code": { "type": "string", "example": "31" }, "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "32450765" } } } } }, "type": { "type": "string", "example": "individual" }, "updated_at": { "type": "string", "example": "2024-09-18T19:37:01Z" } } }, "id": { "type": "string", "example": "or_xZ3ewgPfQ4UKevmP" }, "items": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer", "example": 500000, "default": 0 }, "code": { "type": "string", "example": "8765432109" }, "created_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "description": { "type": "string", "example": "Skirt" }, "id": { "type": "string", "example": "oi_2e8lbEqI4rT41LWX" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "status": { "type": "string", "example": "active" }, "type": { "type": "string", "example": "product" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:35Z" } } } }, "shipping": { "type": "object", "properties": { "address": { "type": "object", "properties": { "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "CO" }, "line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "state": { "type": "string", "example": "NY" }, "zip_code": { "type": "string", "example": "111111" } } }, "description": { "type": "string", "example": "Shipping" }, "recipient_name": { "type": "string", "example": "John Doe" }, "recipient_phone": { "type": "string", "example": "57 3132450765" } } }, "status": { "type": "string", "example": "paid" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:37Z" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": {}, "iso8583_response_code": {}, "iso8583_response_message": {} } }, "created_at": { "type": "string", "example": "2024-09-18T20:01:34.847998Z" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:37.751372Z" } } }, "transactions_history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "8c5cc283-9c01-4ab0-938e-226c19536ce4" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "PAGARME" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "847277" }, "retrieval_reference_number": { "type": "string", "example": "2206177255" }, "acquirer_reference_number": { "type": "string", "example": "2206177255" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John" }, "iin": { "type": "string", "example": "40000000" }, "lfd": { "type": "string", "example": "0010" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "STANDARD" }, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": {} } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCEDED" }, "merchant_reference": { "type": "string", "example": "1726689692" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "PAGARME" }, "transaction_id": { "type": "string", "example": "ch_Roz1ld4HkcRb1A4W" }, "account_id": { "type": "string", "example": "sk_test_5eaa117d8c524eae8836438a49fdaefd" }, "status": { "type": "string", "example": "captured" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "Transaction approved successfully" }, "response_code": { "type": "string", "example": "200" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "integer", "example": 500000, "default": 0 }, "charges": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer", "example": 500000, "default": 0 }, "code": { "type": "string", "example": "PDXHD8BNER" }, "created_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "currency": { "type": "string", "example": "USD" }, "customer": { "type": "object", "properties": { "address": { "type": "object", "properties": { "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "created_at": { "type": "string", "example": "2024-09-13T19:37:46Z" }, "id": { "type": "string", "example": "addr_EoRV4ZjhrhV4N7W3" }, "line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "state": { "type": "string", "example": "NY" }, "status": { "type": "string", "example": "active" }, "updated_at": { "type": "string", "example": "2024-09-18T19:37:01Z" }, "zip_code": { "type": "string", "example": "111111" } } }, "created_at": { "type": "string", "example": "2024-09-13T19:37:46Z" }, "delinquent": { "type": "boolean", "example": false, "default": true }, "document": { "type": "string", "example": "83885322005" }, "document_type": { "type": "string", "example": "cpf" }, "email": { "type": "string", "example": "Johndoe@y.uno" }, "id": { "type": "string", "example": "cus_78Y42XPSkSZ2ky3P" }, "metadata": { "type": "object", "properties": { "platform_integration": { "type": "string", "example": "yuno" } } }, "name": { "type": "string", "example": "John Doe" }, "phones": { "type": "object", "properties": { "home_phone": { "type": "object", "properties": { "area_code": { "type": "string", "example": "31" }, "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "32450765" } } }, "mobile_phone": { "type": "object", "properties": { "area_code": { "type": "string", "example": "31" }, "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "32450765" } } } } }, "type": { "type": "string", "example": "individual" }, "updated_at": { "type": "string", "example": "2024-09-18T19:37:01Z" } } }, "gateway_id": { "type": "string", "example": "2206177255" }, "id": { "type": "string", "example": "ch_Roz1ld4HkcRb1A4W" }, "last_transaction": { "type": "object", "properties": { "acquirer_auth_code": { "type": "string", "example": "847277" }, "acquirer_message": { "type": "string", "example": "Transaction approved successfully" }, "acquirer_name": { "type": "string", "example": "pagarme" }, "acquirer_nsu": { "type": "string", "example": "2206177255" }, "acquirer_return_code": { "type": "string", "example": "0000" }, "acquirer_tid": { "type": "string", "example": "2206177255" }, "amount": { "type": "integer", "example": 500000, "default": 0 }, "antifraud_response": { "type": "object", "properties": { "provider_name": { "type": "string", "example": "pagarme" }, "score": { "type": "string", "example": "very_low" }, "status": { "type": "string", "example": "approved" } } }, "card": { "type": "object", "properties": { "billing_address": { "type": "object", "properties": { "city": { "type": "string", "example": "New York" }, "complement": { "type": "string", "example": "Apartamento 502, Torre I" }, "country": { "type": "string", "example": "US" }, "line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "line_2": { "type": "string", "example": "Apartamento 502, Torre I" }, "state": { "type": "string", "example": "NY" }, "street": { "type": "string", "example": "Calle 34 # 56 - 78" }, "zip_code": { "type": "string", "example": "111111" } } }, "brand": { "type": "string", "example": "Visa" }, "created_at": { "type": "string", "example": "2024-09-17T18:12:52Z" }, "exp_month": { "type": "integer", "example": 3, "default": 0 }, "exp_year": { "type": "integer", "example": 2030, "default": 0 }, "first_six_digits": { "type": "string", "example": "400000" }, "holder_name": { "type": "string", "example": "John" }, "id": { "type": "string", "example": "card_4QyP124IVIWDbpqO" }, "last_four_digits": { "type": "string", "example": "0010" }, "status": { "type": "string", "example": "active" }, "type": { "type": "string", "example": "credit" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:35Z" } } }, "created_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "funding_source": { "type": "string", "example": "credit" }, "gateway_id": { "type": "string", "example": "2206177255" }, "gateway_response": { "type": "object", "properties": { "code": { "type": "string", "example": "200" }, "errors": { "type": "array" } } }, "id": { "type": "string", "example": "tran_xgr0Om8HXQi5X4pJ" }, "installments": { "type": "integer", "example": 1, "default": 0 }, "metadata": { "type": "object", "properties": {} }, "operation_type": { "type": "string", "example": "auth_and_capture" }, "split": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer", "example": 400000, "default": 0 }, "gateway_id": { "type": "string", "example": "sr_cm18agoda1hdd0k9t5kh2hb76" }, "id": { "type": "string", "example": "sr_cm18agoda1hdd0k9t5kh2hb76" }, "options": { "type": "object", "properties": { "charge_processing_fee": { "type": "boolean", "example": true, "default": true }, "charge_remainder_fee": { "type": "boolean", "example": true, "default": true }, "liable": { "type": "boolean", "example": true, "default": true } } }, "recipient": { "type": "object", "properties": { "created_at": { "type": "string", "example": "2024-09-17T16:38:32Z" }, "description": { "type": "string", "example": "" }, "document": { "type": "string", "example": "26224451990" }, "email": { "type": "string", "example": "steverogers@yuno.com" }, "id": { "type": "string", "example": "re_cm16nrp0u0tl60k9t1lopi9ld" }, "name": { "type": "string", "example": "Steve Rogers" }, "payment_mode": { "type": "string", "example": "bank_transfer" }, "status": { "type": "string", "example": "active" }, "type": { "type": "string", "example": "company" }, "updated_at": { "type": "string", "example": "2024-09-17T16:38:32Z" } } }, "type": { "type": "string", "example": "flat" } } } }, "status": { "type": "string", "example": "captured" }, "success": { "type": "boolean", "example": true, "default": true }, "transaction_type": { "type": "string", "example": "credit_card" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:35Z" } } }, "paid_amount": { "type": "integer", "example": 500000, "default": 0 }, "paid_at": { "type": "string", "example": "2024-09-18T20:01:37Z" }, "payment_method": { "type": "string", "example": "credit_card" }, "status": { "type": "string", "example": "paid" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:37Z" } } } }, "checkouts": { "type": "array" }, "closed": { "type": "boolean", "example": true, "default": true }, "closed_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "code": { "type": "string", "example": "PDXHD8BNER" }, "created_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "currency": { "type": "string", "example": "USD" }, "customer": { "type": "object", "properties": { "address": { "type": "object", "properties": { "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "created_at": { "type": "string", "example": "2024-09-13T19:37:46Z" }, "id": { "type": "string", "example": "addr_EoRV4ZjhrhV4N7W3" }, "line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "state": { "type": "string", "example": "NY" }, "status": { "type": "string", "example": "active" }, "updated_at": { "type": "string", "example": "2024-09-18T19:37:01Z" }, "zip_code": { "type": "string", "example": "111111" } } }, "created_at": { "type": "string", "example": "2024-09-13T19:37:46Z" }, "delinquent": { "type": "boolean", "example": false, "default": true }, "document": { "type": "string", "example": "83885322005" }, "document_type": { "type": "string", "example": "cpf" }, "email": { "type": "string", "example": "Johndoe@y.uno" }, "id": { "type": "string", "example": "cus_78Y42XPSkSZ2ky3P" }, "metadata": { "type": "object", "properties": { "platform_integration": { "type": "string", "example": "yuno" } } }, "name": { "type": "string", "example": "John Doe" }, "phones": { "type": "object", "properties": { "home_phone": { "type": "object", "properties": { "area_code": { "type": "string", "example": "31" }, "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "32450765" } } }, "mobile_phone": { "type": "object", "properties": { "area_code": { "type": "string", "example": "31" }, "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "32450765" } } } } }, "type": { "type": "string", "example": "individual" }, "updated_at": { "type": "string", "example": "2024-09-18T19:37:01Z" } } }, "id": { "type": "string", "example": "or_xZ3ewgPfQ4UKevmP" }, "items": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer", "example": 500000, "default": 0 }, "code": { "type": "string", "example": "8765432109" }, "created_at": { "type": "string", "example": "2024-09-18T20:01:35Z" }, "description": { "type": "string", "example": "Skirt" }, "id": { "type": "string", "example": "oi_2e8lbEqI4rT41LWX" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "status": { "type": "string", "example": "active" }, "type": { "type": "string", "example": "product" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:35Z" } } } }, "shipping": { "type": "object", "properties": { "address": { "type": "object", "properties": { "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "CO" }, "line_1": { "type": "string", "example": "Calle 34 # 56 - 78" }, "state": { "type": "string", "example": "NY" }, "zip_code": { "type": "string", "example": "111111" } } }, "description": { "type": "string", "example": "Shipping" }, "recipient_name": { "type": "string", "example": "John Doe" }, "recipient_phone": { "type": "string", "example": "57 3132450765" } } }, "status": { "type": "string", "example": "paid" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:37Z" } } }, "third_party_transaction_id": { "type": "string", "example": "" }, "third_party_account_id": {}, "iso8583_response_code": {}, "iso8583_response_message": {} } }, "created_at": { "type": "string", "example": "2024-09-18T20:01:34.847998Z" }, "updated_at": { "type": "string", "example": "2024-09-18T20:01:37.751372Z" } } } }, "split_marketplace": { "type": "array", "items": { "type": "object", "properties": { "recipient_id": {}, "provider_recipient_id": { "type": "string", "example": "re_cm16nrp0u0tl60k9t1lopi9ld" }, "type": { "type": "string", "example": "PURCHASE" }, "merchant_reference": { "type": "string", "example": "aaa2" }, "amount": { "type": "object", "properties": { "value": { "type": "number", "example": 4000, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "calculation_type": { "type": "string", "description": "The method used to calculate the split amount.", "enum": [ "PERCENTAGE", "FIXED", "MIXED" ], "example": "PERCENTAGE" }, "percentage": { "type": "number", "description": "Percentage used in the calculation.", "example": 10.5 }, "rounding_mode": { "type": "string", "description": "Rounding strategy used for the calculation.", "enum": [ "STANDARD", "ROUND_UP", "ROUND_DOWN" ], "example": "STANDARD" }, "fixed_amount": { "type": "number", "description": "The fixed amount component used in the calculation.", "example": 5 } } }, "liability": {} } } }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the subscription created or charged by this payment. Null when the payment carries no subscription." }, "routing_rules": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 41295, "default": 0 }, "name": {}, "description": {} } } } }, "simplified_mode": { "type": "boolean", "example": false, "default": true } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } }, "Request in process": { "value": { "code": "REQUEST_IN_PROCESS", "messages": [ "Request with the same idempotency is already in process. Try again in a few seconds." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid Credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid Credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API" } } } } } } } }, "deprecated": false, "tags": [ "Payments" ] } }, "/payments/{payment_id}": { "get": { "summary": "Retrieve Payment by ID", "description": "", "operationId": "retrieve-payment-by-id-v2", "parameters": [ { "name": "raw_response", "in": "query", "description": "When true, includes the provider raw response in the output (default false).", "schema": { "type": "boolean" } }, { "name": "transactions_history", "in": "query", "description": "When true, includes the transactions history in the response (default false).", "schema": { "type": "boolean" } }, { "in": "path", "name": "payment_id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "SDK_Checkout - Required Fields": { "value": { "payment": { "id": "e3f397ed-b7d0-4816-ab75-8457b0a30ec1", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-20T17:24:58.900553Z", "updated_at": "2023-07-20T17:25:13.447662Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 52000 }, "checkout": { "session": "954dc216-60ff-4ae4-a299-c603b93bd267", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "2cd31999-e44e-4de3-bbe4-179981ff4295", "payment_method_detail": { "bank_transfer": { "provider_image": "", "account_type": null, "bank_name": "Bank of America", "beneficiary_name": "John Doe", "bank_account": "123456789", "bank_account_2": null, "beneficiary_document_type": "SSN", "beneficiary_document": "123-45-6789", "payment_instruction": null, "redirect_url": "https://api-sandbox.bankofamerica.com/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved" } } }, "customer_payer": { "id": "cfae0941-7234-427a-a739-ef4fce966c79", "merchant_customer_id": "1689873883", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1980-01-01", "email": "johndoe@gmail.com", "nationality": "US", "ip_address": "192.168.1.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main Street", "address_line_2": null, "city": "New York", "state": "NY", "country": "US", "zip_code": "10001" }, "shipping_address": { "address_line_1": "123 Main Street", "address_line_2": null, "city": "New York", "state": "NY", "country": "US", "zip_code": "10001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "09135cb9-159c-4662-8fe3-da5523bb2266", "type": "PURCHASE", "status": "SUCCEEDED", "category": "BANK_TRANSFER", "amount": 52000, "provider_id": "BANK_OF_AMERICA", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "2cd31999-e44e-4de3-bbe4-179981ff4295", "detail": { "bank_transfer": { "provider_image": "", "account_type": null, "bank_name": "Bank of America", "beneficiary_name": "John Doe", "bank_account": "123456789", "bank_account_2": null, "beneficiary_document_type": "SSN", "beneficiary_document": "123-45-6789", "payment_instruction": null, "redirect_url": "https://api-sandbox.bankofamerica.com/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved" } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "BANK_OF_AMERICA", "transaction_id": "117490-1689873907-17347", "account_id": "", "status": "APPROVED", "status_detail": "", "response_code": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "data": { "amount_in_cents": 5200000, "bill_id": null, "billing_data": null, "created_at": "2023-07-20T17:25:07.167Z", "currency": "USD", "customer_data": null, "customer_email": "johndoe@gmail.com", "finalized_at": null, "id": "117490-1689873907-17347", "payment_link_id": null, "payment_method": { "extra": { "is_three_ds": false }, "payment_description": "Test Bank of America", "sandbox_status": "APPROVED", "type": "BANK_TRANSFER", "user_type": "PERSON" }, "payment_method_type": "BANK_TRANSFER", "payment_source_id": null, "redirect_url": "https://google.com/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267", "reference": "09135cb9-159c-4662-8fe3-da5523bb2266", "shipping_address": { "address_line_1": "123 Main Street", "address_line_2": null, "city": "New York", "state": "NY", "country": "US", "zip_code": "10001" }, "status": "PENDING", "status_message": null, "taxes": [] }, "meta": {} }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-20T17:25:05.410687Z", "updated_at": "2023-07-20T17:25:11.472652Z" } ], "split": [], "callback_url": "https://y.uno/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267", "workflow": "SDK_CHECKOUT", "metadata": [], "account_code": "493e9374-510a-4201-9e09-de669d75f256", "fraud_screening": null, "idempotency_key": null, "payment_link_code": "", "routing_rules": null, "split_marketplace": [] } } }, "Card - With card details": { "value": { "payment": { "id": "bc0489ba-80bf-4bb9-98c5-ff8dfbceebf9", "account_id": "64761a45-6e49-4ea5-a6ff-6b52030b92ac", "description": "SUCCESSFUL", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "Order_id", "created_at": "2023-07-12T18:51:49.437886Z", "updated_at": "2023-07-12T18:51:54.679410Z", "amount": { "currency": "USD", "value": 20000, "refunded": 0, "captured": 0 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "517862", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "token": null, "collect_url": null, "setup_reference_id": null, "developer_id": null, "solution_id": null, "code": null, "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "acs_id": null, "ds_id": null, "pares_status": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": "a76d79b7-902f-4152-922f-7e7eebc5f3dc", "merchant_customer_id": "1309", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": null, "device_fingerprint": null, "browser_info": { "user_agent": "string", "accept_header": "string", "accept_content": null, "accept_browser": null, "color_depth": "32", "screen_height": "32", "screen_width": "32", "javascript_enabled": true, "java_enabled": null, "browser_time_difference": null, "language": "string" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Peak Avenue", "address_line_2": "", "country": "US", "city": "San Diego" }, "shipping_address": { "address_line_1": "123 Peak Avenue", "address_line_2": "", "country": "US", "city": "San Diego" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "c718b8e9-2943-4fdf-9b3c-426cf44940fb", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 20000, "provider_id": "DLOCAL", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "517862", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "token": null, "collect_url": null, "setup_reference_id": null, "developer_id": null, "solution_id": null, "code": null, "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "acs_id": null, "ds_id": null, "pares_status": null } } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "SUCCESSFUL", "merchant_reference": null, "provider_data": { "id": "DLOCAL", "transaction_id": "T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42", "account_id": "", "status": "PAID", "status_detail": "200", "response_message": "The payment was paid.", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "value": "{\"id\":\"T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42\",\"amount\":20000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":11,\"expiration_year\":2028,\"brand\":\"VI\",\"last4\":\"1111\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-12T18:51:52.000+0000\",\"approved_date\":\"2023-07-12T18:51:54.000+0000\",\"status\":\"PAID\",\"status_detail\":\"The payment was paid.\",\"status_code\":\"200\",\"order_id\":\"c718b8e9-2943-4fdf-9b3c-426cf44940fb\",\"description\":\"SUCCESSFUL\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"517862\"}}" }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-12T18:51:51.908784Z", "updated_at": "2023-07-12T18:51:54.426087Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "64761a45-6e49-4ea5-a6ff-6b52030b92ac", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Card - With airline data": { "value": { "payment": { "id": "6e7cc5da-2b39-4b6e-b382-df8bb1feddf1", "account_id": "64761a45-6e49-4ea5-a6ff-6b52030b92ac", "description": "SUCCESSFUL", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "Order_id", "created_at": "2023-07-12T20:06:41.418163Z", "updated_at": "2023-07-12T20:06:41.806898Z", "amount": { "currency": "USD", "value": 2000, "refunded": 0, "captured": 0 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": false, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "token": null, "collect_url": null, "setup_reference_id": null, "developer_id": null, "solution_id": null, "code": null, "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "acs_id": null, "ds_id": null, "pares_status": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": null, "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1998-01-01", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.0.1", "device_fingerprint": null, "browser_info": { "user_agent": "string", "accept_header": "string", "accept_content": "string", "accept_browser": "string", "color_depth": "32", "screen_height": "32", "screen_width": "32", "javascript_enabled": true, "java_enabled": null, "browser_time_difference": null, "language": "string" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": null, "billing_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 42", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 42", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": { "airline": { "pnr": "ABC123", "legs": [ { "departure_airport": "LAX", "departure_datetime": "2023-10-31T01:30:00.000-07:00", "departure_airport_timezone": "GMT-07", "arrival_airport": "JFK", "arrival_datetime": "2023-10-31T07:30:00.000-04:00", "carrier_code": "AA", "flight_number": "AA100", "fare_basis_code": "Y", "fare_class_code": "M", "base_fare": 250, "base_fare_currency": "USD", "stopover_code": "N" } ], "passengers": [ { "first_name": "John", "last_name": "Doe", "middle_name": "Michael", "type": "A", "date_of_birth": "1998-01-01", "nationality": "US", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "country": "US", "loyalty_number": "79250001", "loyalty_tier": "Platinum", "email": "john.doe@company.com", "phone": { "number": "5551234567", "country_code": "1" } } ], "tickets": [ { "ticket_number": "BRB0001", "e_ticket": true, "restricted": false, "total_fare_amount": 500, "total_tax_amount": 50, "total_fee_amount": 25, "issue": { "carrier_prefix_code": "AA", "travel_agent_code": "A104121", "travel_agent_name": "SkyTravel", "date": "2023-10-30T10:00:00.000-07:00", "address": "123 Main Street, Apt 42", "city": "Los Angeles", "country": "US", "zip_code": "90001" } } ] }, "order": null, "seller_details": null }, "taxes": null, "transactions": [ { "id": "f4740123-2662-437c-a52b-7a80aa8fe807", "type": "AUTHORIZE", "status": "REJECTED", "category": "CARD", "amount": 2000, "provider_id": "MERCADO_PAGO", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": false, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "token": null, "collect_url": null, "setup_reference_id": null, "developer_id": null, "solution_id": null, "code": null, "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "acs_id": null, "ds_id": null, "pares_status": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "REJECTED", "response_message": "Transaction unsuccessful", "reason": "Insufficient funds", "description": "Transaction failed", "merchant_reference": null, "provider_data": { "id": "MERCADO_PAGO", "transaction_id": "T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42", "account_id": "", "status": "DECLINED", "status_detail": "Insufficient funds", "response_message": "Payment could not be completed.", "iso8583_response_code": "05", "iso8583_response_message": "Do not honor", "raw_response": { "value": "{\"id\":\"T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42\",\"amount\":2000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":11,\"expiration_year\":2028,\"brand\":\"VI\",\"last4\":\"1111\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-12T20:06:41.000+0000\",\"status\":\"DECLINED\",\"status_detail\":\"Insufficient funds\",\"status_code\":\"05\",\"order_id\":\"f4740123-2662-437c-a52b-7a80aa8fe807\",\"description\":\"Transaction failed\",\"notification_url\":\"https://sandbox.y.uno/mercado-pago-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"\"}}" }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-12T20:06:41.418163Z", "updated_at": "2023-07-12T20:06:41.806898Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "64761a45-6e49-4ea5-a6ff-6b52030b92ac", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Card - With 3DS direct": { "value": { "payment": { "id": "cb3ca163-cb79-41d7-b9a3-0115e30a7c01", "idempotency_key": "fc0d89a1-8d18-4759-8d0a-ee1c6d0386e2", "account_code": "26a6626c-d3ec-4caa-bf7c-a994b145dc00", "account_id": "26a6626c-d3ec-4caa-bf7c-a994b145dc00", "description": "TEST_3DS", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-17T17:00:39.678379Z", "updated_at": "2023-07-17T17:41:48.453381Z", "amount": { "currency": "USD", "value": 5000, "refunded": 0, "captured": 0 }, "checkout": { "session": "b0751c96-0b00-4b8c-8372-c16f72f60598", "sdk_action_required": false }, "customer_payer": { "id": "fc7ef8ae-000d-4903-ab76-494ebc8d5fa3", "merchant_customer_id": "1689374657", "first_name": "John", "last_name": "Doe", "gender": null, "date_of_birth": null, "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": null, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": null, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "New York", "city": "New York", "zip_code": "10001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "New York", "city": "New York", "zip_code": "10001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": { "airline": null, "order": null, "seller_details": null }, "taxes": null, "transactions": [ { "id": "caada737-27ab-46ca-91a9-744da64c4787", "type": "THREE_D_SECURE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "CYBERSOURCE_3DS", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "redirect_url": "https://checkout.staging.y.uno/payment?session=14c263bd-e01d-400f-885a-70205df8b417", "card_data": { "holder_name": "John Doe", "iin": "44565300", "lfd": "0007", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "three_d_secure_setup_id": "24127d61-b852-42fb-acd4-1ee661645376", "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": "Y" } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "TEST_3DS", "merchant_reference": "reference-5f6dd991-ab14-4da3-b7d8-9f24a04ebd92", "provider_data": { "id": "CYBERSOURCE_3DS", "transaction_id": "6896132402506977804951", "account_id": "", "status": "AUTHENTICATION_SUCCESSFUL", "status_detail": "", "response_message": "CONSUMER_AUTHENTICATION_REQUIRED", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "clientReferenceInformation": { "code": "24127d61-b852-42fb-acd4-1ee661645376" }, "consumerAuthenticationInformation": { "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxZmM5ZDVhMS04M2ZhLTQwYWEtYjI5Ny1iZDM1ZGIxODQ4ZjAiLCJpYXQiOjE2ODk2MTMyNDAsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTY4OTYxNjg0MCwiT3JnVW5pdElkIjoiNjQwYTM1NjlkODdhMjUwYTQyNTEwOWRjIiwiUGF5bG9hZCI6eyJBQ1NVcmwiOiJodHRwczovL21lcmNoYW50YWNzc3RhZy5jYXJkaW5hbGNvbW1lcmNlLmNvbS9NZXJjaGFudEFDU1dlYi9wYXJlcS5qc3A_dmFhPWImZ29sZD1BQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUEiLCJQYXlsb2FkIjoiZU5wVlVWMXZna0FRZkw5ZlFVd2ZHKzZBS3RHc2w5QnE2a2MwdHRCb254cUViU1dWRDQvRHFMKytkd2kxdmFlZHljN3R6aXdFTzRFNDhqR3FCSEpZWUZtR1gyZ2s4YkRqWC9KcHZqaVV6M0kyUzc4LzAvUE1ZeDBPSys4VkR4eU9LTW9rejdobE10TUcya0tpdmhEUkxzd2toekE2UEU2WC9LSFh0NjBlMEFZU1NGRk1SendZKzhHSE0vS0JYakdCTEV5UnYxZFpiaWphQ0xDVVFHdU9RSlJYbVJSbmJya01hQXNJVkdMUGQxSVc1WURTczZtVVFEVkZnTjYyV0ZXNktwVzVVeEx6TjZjNCt1ditNdG9zSi9HNG1HL1hNdDF1OXZPWHdCc0MxUjBFNGxBaXQ1bnRNTmR5RGNzZE1EWncra0JybmtDWTZ2bjhybXN5eHU2WldxaGhDQlI2bG5kRlhhWWYwTCtjTWxJSmdWblVPbWtSQVR3VmVZYXFSNFg1V3lzanQvV2ZKanJTU0txc1hPWTR6TEoxcGpXdTVZbUt4TzR4cTlZbmRUNVVhMmh6TWRvY1YxWC9qdjREQVEybVdnPT0iLCJUcmFuc2FjdGlvbklkIjoiU3pvSW9NcXNHdEpKbWtmbXlKQTAifSwiT2JqZWN0aWZ5UGF5bG9hZCI6dHJ1ZSwiUmV0dXJuVXJsIjoiaHR0cHM6Ly9zdGFnaW5nLnkudW5vL2N5YmVyc291cmNlLTNkcy13ZWJob29rL3YxL2NvbmZpcm1hdGlvbnMvYXV0aC8yNDEyN2Q2MS1iODUyLTQyZmItYWNkNC0xZWU2NjE2NDUzNzYifQ.5ehSTA5uUKc2DfvTRGJZ8dPKbxAJ5WproKSTLqu4egM", "acsUrl": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "authenticationPath": "ENROLLED", "authenticationTransactionId": "SzoIoMqsGtJJmkfmyJA0", "pareq": "eNpVUV1vgkAQfL9fQUwfG+6AKtGsl9Bq6kc0ttBonxqEbSWVD4/DqL++dwi1vaedyc7tziwEO4E48jGqBHJYYFmGX2gk8bDjX/JpvjiUz3I2S78/0/PMYx0OK+8VDxyOKMokz7hlMtMG2kKivhDRLswkhzA6PE6X/KHXt60e0AYSSFFMRzwY+8GHM/KBXjGBLEyRv1dZbijaCLCUQGuOQJRXmRRnbrkMaAsIVGLPd1IW5YDSs6mUQDVFgN62WFW6KpW5UxLzN6c4+uv+MtosJ/G4mG/XMt1u9vOXwBsC1R0E4lAit5ntMNdyDcsdMDZw+kBrnkCY6vn8rmsyxu6ZWqhhCBR6lndFXaYf0L+cMlIJgVnUOmkRATwVeYaqR4X5Wysjt/WfJjrSSKqsXOY4zLJ1pjWu5YmKxO4xq9YndT5Ua2hzMdocV1X/jv4DAQ2mWg==", "proofXml": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/vereq.jsp?acqid=CYBS1.0.2XXXXXXXXXXXX0007469216TEST_3DS0*/*Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.361.0.2Y7033012https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAThreeDSecure", "proxyPan": "7033012", "specificationVersion": "1.0.2", "stepUpUrl": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp", "strongAuthentication": { "OutageExemptionIndicator": "0" }, "token": "AxjzbwSTddcP6s4BiIKXABEBURzGv4QYVRP0JAY/LtaSZejFq0T8BEAAwwdp", "veresEnrolled": "Y", "xid": "U3pvSW9NcXNHdEpKbWtmbXlKQTA=" }, "errorInformation": { "message": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction.", "reason": "CONSUMER_AUTHENTICATION_REQUIRED" }, "id": "6896132402506977804951", "paymentInformation": { "card": { "bin": "445653", "type": "VISA" } }, "status": "PENDING_AUTHENTICATION", "submitTimeUtc": "2023-07-17T17:00:40Z" }, "third_party_transaction_id": null }, "three_d_secure_action_required": null, "created_at": "2023-07-17T17:00:39.765728Z", "updated_at": "2023-07-17T17:41:43.593769Z" }, { "id": "4081b900-3efa-44a2-83d8-bca350476b06", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "DLOCAL", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "445975", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "44565300", "lfd": "0007", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank NA", "issuer_code": "US_JPMORGAN_CHASE_BANK_NA", "category": null, "type": "CREDIT", "three_d_secure": { "three_d_secure_setup_id": "24127d61-b852-42fb-acd4-1ee661645376", "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": "Y" } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "TEST_3DS", "merchant_reference": null, "provider_data": { "id": "DLOCAL", "transaction_id": "T-385928-57934367-25ca-4445-a973-da5c1a4635b2", "account_id": "", "status": "PAID", "sub_status": "", "status_detail": "200", "response_message": "The payment was paid.", "raw_response": { "value": "{\"id\":\"T-385928-57934367-25ca-4445-a973-da5c1a4635b2\",\"amount\":5000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":1,\"expiration_year\":2026,\"brand\":\"VI\",\"last4\":\"0007\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-17T17:41:44.000+0000\",\"approved_date\":\"2023-07-17T17:41:48.000+0000\",\"status\":\"PAID\",\"status_detail\":\"The payment was paid.\",\"status_code\":\"200\",\"order_id\":\"4081b900-3efa-44a2-83d8-bca350476b06\",\"description\":\"TEST_3DS\",\"notification_url\":\"https://staging.y.uno/dlocal-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"445975\"}}" }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-17T17:41:43.752435Z", "updated_at": "2023-07-17T17:41:48.395863Z" } ], "split": [], "callback_url": "https://google.com", "workflow": "REDIRECT", "fraud_screening": null, "metadata": [], "payment_link_code": "", "routing_rules": null, "split_marketplace": [] } } }, "Card - With customer, billing, and shipping details": { "value": { "payment": { "id": "12113b61-015a-4a01-a69c-ab7423d0138d", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:03:02.291414Z", "updated_at": "2023-07-24T01:03:04.571022Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690160581", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "73e5cddf-32c7-4b12-9d8e-92335862928f", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-85ffbde3-2256-418f-b761-41ab2d8706dd", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "d570b77a-759e-45ae-abb9-ab4ab3034d0c", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:03:02.407480Z", "updated_at": "2023-07-24T01:03:04.499303Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "493e9374-510a-4201-9e09-de669d75f256", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Card - With customer, billing, shipping and order items": { "value": { "payment": { "id": "cf205a5e-140e-4c08-9a5b-ee44b91256dc", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:08:17.039613Z", "updated_at": "2023-07-24T01:08:19.300337Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690160896", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": { "airline": null, "order": { "fee_amount": 0, "shipping_amount": 0, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 5000, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456" } ] }, "seller_details": null }, "taxes": null, "transactions": [ { "id": "bf442c7f-2393-4607-98b5-a4c2a8a97bbc", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-9260ef97-81b5-4e35-ac17-0d3d124a0d59", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "ade1dcf5-cbf5-408b-84af-f504abe01a26", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:08:17.147871Z", "updated_at": "2023-07-24T01:08:19.222926Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "493e9374-510a-4201-9e09-de669d75f256", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Card - With installments": { "value": { "payment": { "id": "3707bcc5-f88c-4092-ba44-142d1f3ea229", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:10:50.152163Z", "updated_at": "2023-07-24T01:10:52.417211Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 3, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "a58043ab-e5c6-4476-adfb-623fa8cc320d", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 3, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-f3f9319f-f3f7-48a3-90c2-fac0a2f782be", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "9efdc397-2a74-479a-af00-bf5ae7e2a76e", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:10:50.273142Z", "updated_at": "2023-07-24T01:10:52.339967Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "493e9374-510a-4201-9e09-de669d75f256", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Card - With authorization": { "value": { "payment": { "id": "c0409fc0-87d5-453f-bf91-8f0af2f09347", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "PENDING", "sub_status": "AUTHORIZED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:13:37.372312Z", "updated_at": "2023-07-24T01:13:39.654433Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": false, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "e9108a97-5d0d-492a-99bf-da1ee42af425", "type": "AUTHORIZE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": false, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-0b914bf9-0e86-4713-a908-0ec01d60c486", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "1b7011ff-4252-4ac6-99a4-d5de2086896b", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:13:37.492230Z", "updated_at": "2023-07-24T01:13:39.584118Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "493e9374-510a-4201-9e09-de669d75f256", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Card - With device fingerprint": { "value": { "payment": { "id": "8e7fbcad-9c7b-43c6-8fbf-b864e87c5e41", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:20:02.671644Z", "updated_at": "2023-07-24T01:20:04.946852Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": "hi88287gbd8d7d782ge287gbd8d7d78", "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "36524be2-b33e-4d33-b9d7-9f7853035bbd", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-89ab43dc-57de-4ea0-8058-6f7fc0d972a7", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "20500c62-96d2-457b-8e64-b64480190e89", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:20:02.794825Z", "updated_at": "2023-07-24T01:20:04.873386Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "493e9374-510a-4201-9e09-de669d75f256", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Card - With vault on success": { "value": { "payment": { "id": "96b56df3-0013-4401-b58e-646f5e716ab8", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:27:23.360857Z", "updated_at": "2023-07-24T01:27:25.682059Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1", "type": "CARD", "vault_on_success": true, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": "967ecd18-d898-4b88-9400-dd5b01b18edc", "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": "hi88287gbd8d7d782ge287gbd8d7d78", "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "85c19c82-dc31-4a50-aa7d-570d89dbc475", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1", "type": "CARD", "vault_on_success": true, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-7cf75e3a-c8eb-4c62-bd02-74928f68f174", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "604075b9-52e9-48f5-8fcf-3c2d9bacbe66", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:27:23.473451Z", "updated_at": "2023-07-24T01:27:25.550651Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "493e9374-510a-4201-9e09-de669d75f256", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Card - With vaulted token": { "value": { "payment": { "id": "821ddfe4-309a-46a8-bd4b-819564aa9c5a", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "APPROVED", "merchant_order_id": "0000023", "created_at": "2023-07-24T01:28:45.444722Z", "updated_at": "2023-07-24T01:28:47.712002Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1", "type": "CARD", "vault_on_success": false, "token": "", "payment_method_detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "customer_payer": { "id": "967ecd18-d898-4b88-9400-dd5b01b18edc", "merchant_customer_id": "1690161049", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": "hi88287gbd8d7d782ge287gbd8d7d78", "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "a47e879e-3cd1-49f3-ab72-fc33b0185057", "type": "PURCHASE", "status": "SUCCEEDED", "category": "CARD", "amount": 5000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1", "type": "CARD", "vault_on_success": false, "token": "", "detail": { "card": { "verify": null, "capture": true, "installments": 1, "first_installment_deferral": 0, "installments_type": "", "installment_amount": null, "soft_descriptor": "", "authorization_code": "123456", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "40518856", "lfd": "6623", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "JPMorgan Chase Bank", "issuer_code": null, "category": null, "type": "CREDIT", "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null } }, "stored_credentials": { "reason": "SUBSCRIPTION", "usage": "USED", "subscription_agreement_id": "XXXX01", "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test", "merchant_reference": "reference-22103236-c3fc-4871-9fc0-98ce48a9f553", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "f9bcb8a8-d5d8-4c53-b551-5932c9804f16", "account_id": "", "status": "SUCCEEDED", "status_detail": "", "response_message": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": { "amount": { "currency": "USD", "value": 2100 }, "merchantAccount": "YunoPaymentsECOM", "reference": "34343434", "status": "received" }, "third_party_transaction_id": "" }, "created_at": "2023-07-24T01:28:45.562437Z", "updated_at": "2023-07-24T01:28:47.639121Z" } ], "split": [], "workflow": "DIRECT", "metadata": [], "fraud_screening": null, "payment_link_code": "", "account_code": "493e9374-510a-4201-9e09-de669d75f256", "idempotency_key": null, "routing_rules": null, "split_marketplace": [] } } }, "Bank Transfer": { "value": { "payment": { "id": "ac427adb-3ac9-4a7c-9389-0a923146b39b", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-23T23:56:25.405475Z", "updated_at": "2023-07-23T23:56:29.742339Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 52000 }, "checkout": { "session": "c21df85b-6c39-4cf5-aa7d-305aac6441e6", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "payment_method_detail": { "bank_transfer": { "provider_image": "", "account_type": null, "bank_name": "Bank of America", "beneficiary_name": "John Doe", "bank_account": "123456789", "bank_account_2": null, "beneficiary_document_type": "SSN", "beneficiary_document": "123-45-6789", "payment_instruction": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=2cc7ac83-029d-4e13-8360-9b627bba8fc5" } } }, "customer_payer": { "id": null, "merchant_customer_id": "1689888489", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "acbf992c-e448-4efc-a39c-05f74fa624cf", "type": "PURCHASE", "status": "CREATED", "category": "BANK_TRANSFER", "amount": 52000, "provider_id": "WOMPI", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": { "bank_transfer": { "provider_image": "", "account_type": null, "bank_name": "Bank of America", "beneficiary_name": "John Doe", "bank_account": "123456789", "bank_account_2": null, "beneficiary_document_type": "SSN", "beneficiary_document": "123-45-6789", "payment_instruction": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=2cc7ac83-029d-4e13-8360-9b627bba8fc5" } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "WOMPI", "transaction_id": "117490-1690156586-55850", "account_id": "", "status": "APPROVED", "status_detail": "", "response_message": "", "iso8583_code": "", "iso8583_message": "", "raw_response": { "data": { "amount_in_cents": 5200000, "bill_id": null, "billing_data": null, "created_at": "2023-07-23T23:56:26.350Z", "currency": "USD", "customer_data": null, "customer_email": "johndoe@example.com", "finalized_at": null, "id": "117490-1690156586-55850", "payment_link_id": null, "payment_method": { "extra": { "is_three_ds": false }, "payment_description": "Test Bank of America", "sandbox_status": "APPROVED", "type": "BANK_TRANSFER", "user_type": "PERSON" }, "payment_method_type": "BANK_TRANSFER", "payment_source_id": null, "redirect_url": "https://demo.dev.y.uno/checkout/status?checkoutSession=", "reference": "acbf992c-e448-4efc-a39c-05f74fa624cf", "shipping_address": null, "status": "PENDING", "status_message": null, "taxes": [] }, "meta": {} }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:56:25.506471Z", "updated_at": "2023-07-23T23:56:29.673135Z" } ], "split": [], "workflow": "REDIRECT", "metadata": [], "account_code": "493e9374-510a-4201-9e09-de669d75f256", "fraud_screening": null, "idempotency_key": null, "payment_link_code": "", "routing_rules": null, "split_marketplace": [] } } }, "Buy Now Pay Later": { "value": { "payment": { "id": "087be3a5-bed7-4c58-bbe0-c2ebcf376ebb", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-20T21:25:11.903819Z", "updated_at": "2023-07-20T21:25:12.983059Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 52000 }, "checkout": { "session": "25e073ae-016c-4bca-89e7-64e05f766f11", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "ADDI", "vault_on_success": false, "token": "", "payment_method_detail": { "bnpl": { "installments": null, "provider_image": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=82e244a2-9d5b-4998-93b7-8a293fb43b9c", "customer_data": null } } }, "customer_payer": { "id": null, "merchant_customer_id": "example00234", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "1328382d-f6e8-4f09-91b7-c18b1308c031", "type": "PURCHASE", "status": "CREATED", "category": "BUY_NOW_PAY_LATER", "amount": 52000, "provider_id": "ADDI", "payment_method": { "vaulted_token": "", "type": "ADDI", "vault_on_success": false, "token": "", "detail": { "bnpl": { "installments": null, "provider_image": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=82e244a2-9d5b-4998-93b7-8a293fb43b9c", "customer_data": null } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "ADDI", "transaction_id": "0000022", "account_id": "", "status": "CREATED", "status_detail": "", "response_message": "", "iso8583_code": "", "iso8583_message": "", "raw_response": { "value": "" }, "third_party_transaction_id": "" }, "three_d_secure_action_required": null, "created_at": "2023-07-20T21:25:12.008657Z", "updated_at": "2023-07-20T21:25:12.918362Z" } ], "split": [], "workflow": "REDIRECT", "metadata": [], "fraud_screening": null, "account_code": "493e9374-510a-4201-9e09-de669d75f256", "idempotency_key": null, "payment_link_code": "", "routing_rules": null, "split_marketplace": [] } } }, "Payment Link": { "value": { "payment": { "id": "9c1f6ba0-d483-42a9-8d06-d53a07c284e0", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-23T23:11:24.724037Z", "updated_at": "2023-07-23T23:11:26.318691Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 5000 }, "checkout": { "session": "3c9eb446-388a-4c2e-9818-573d54300dd1", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "WEBPAY", "vault_on_success": false, "token": "", "payment_method_detail": { "payment_link": { "verify": null, "capture": null, "installments": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987" } } }, "customer_payer": { "id": null, "merchant_customer_id": null, "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "762abda0-2de5-43ba-a52b-04279acfb869", "type": "PURCHASE", "status": "CREATED", "category": "PAYMENT_LINK", "amount": 5000, "provider_id": "TRANSBANK_2", "payment_method": { "vaulted_token": "", "type": "WEBPAY", "vault_on_success": false, "token": "", "detail": {} }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "TRANSBANK_2", "transaction_id": "", "account_id": "", "status": "", "status_detail": "", "response_message": "", "iso8583_code": "00", "iso8583_message": "Approved or completed successfully", "raw_response": { "token": "01aba0f569c8a78370aa35461ca482b57d1b767365535de9a0540c03791a3d97", "url": "https://webpay3gint.transbank.cl/webpayserver/initTransaction" }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:11:24.842815Z", "updated_at": "2023-07-23T23:11:26.242431Z" } ], "split": [], "callback_url": "www.y.uno", "workflow": "REDIRECT", "metadata": [], "account_code": "493e9374-510a-4201-9e09-de669d75f256", "fraud_screening": null, "idempotency_key": null, "payment_link_code": "", "routing_rules": null, "split_marketplace": [] } } }, "Ticket": { "value": { "payment": { "id": "1c109200-3236-43f3-ab44-9a317991a288", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000022", "created_at": "2023-07-23T23:35:25.021285Z", "updated_at": "2023-07-23T23:35:26.067120Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 52000 }, "checkout": { "session": "3faeb04f-0a52-41fc-9aba-33e535386776", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "payment_method_detail": { "ticket": { "type": null, "date_of_expiration": null, "provider_number": "762c4604-d4ba-4a8f-ba2f-5d39931e9ed8", "provider_barcode": null, "provider_logo": null, "provider_format": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=3feff49c-a422-434a-9fad-eca87e2193d5" } } }, "customer_payer": { "id": null, "merchant_customer_id": "1690155316", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": null, "taxes": null, "transactions": [ { "id": "762c4604-d4ba-4a8f-ba2f-5d39931e9ed8", "type": "PURCHASE", "status": "CREATED", "category": "TICKET", "amount": 52000, "provider_id": "UNLIMINT", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": {} }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": null, "provider_data": { "id": "UNLIMINT", "transaction_id": "", "account_id": "", "status": "", "status_detail": "", "response_message": "", "iso8583_code": "00", "iso8583_message": "Approved or completed successfully", "raw_response": { "redirect_url": "https://sandbox.cardpay.com/MI/payment.html?uuid=a6cfEG0H3c1Hf42f23HhH3Ch" }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:35:25.116858Z", "updated_at": "2023-07-23T23:35:25.988725Z" } ], "split": [], "callback_url": "www.google.com", "workflow": "REDIRECT", "metadata": [], "account_code": "493e9374-510a-4201-9e09-de669d75f256", "fraud_screening": null, "idempotency_key": null, "payment_link_code": "", "routing_rules": null, "split_marketplace": [] } } }, "Wallet": { "value": { "payment": { "id": "d0ff19c2-cf55-4015-a613-e35f22da0233", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "description": "Test Bank of America", "country": "US", "status": "READY_TO_PAY", "sub_status": "CREATED", "merchant_order_id": "0000023", "created_at": "2023-07-23T23:02:39.401790Z", "updated_at": "2023-07-23T23:02:40.312593Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 3000 }, "checkout": { "session": "b7e15362-4ac0-4e23-886e-329695933ecb", "sdk_action_required": true }, "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "payment_method_detail": { "wallet": { "verify": false, "capture": false, "installments": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "customer_data": null, "card_data": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } }, "customer_payer": { "id": null, "merchant_customer_id": null, "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "johndoe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "browser_info": { "user_agent": "", "accept_header": "", "accept_content": null, "accept_browser": null, "color_depth": "", "screen_height": "", "screen_width": "", "javascript_enabled": null, "java_enabled": null, "browser_time_difference": null, "language": "" }, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "shipping_address": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001" }, "device_fingerprints": [], "geolocation": null, "merchant_customer_validations": null, "merchant_customer_created_at": null }, "additional_data": { "airline": null, "order": { "fee_amount": null, "shipping_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 3000, "category": null, "brand": null, "sku_code": null, "manufacture_part_number": null } ] }, "seller_details": null }, "taxes": null, "transactions": [ { "id": "286ad833-7cbc-4e66-92f9-01019eb7d7a3", "type": "PURCHASE", "status": "CREATED", "category": "WALLET", "amount": 3000, "provider_id": "BANK_OF_AMERICA", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": { "wallet": { "verify": false, "capture": false, "installments": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "customer_data": null, "card_data": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": "reference-d2b08e8e-c87a-4806-b1ea-b35a19a36a6d", "provider_data": { "id": "BANK_OF_AMERICA", "transaction_id": "", "account_id": "", "status": "", "status_detail": "", "response_message": "", "iso8583_code": "00", "iso8583_message": "Approved or completed successfully", "raw_response": { "value": "{\"additional_info\":\"\",\"auto_return\":\"approved\",\"back_urls\":{\"failure\":\"http://www.y.uno\",\"pending\":\"http://www.y.uno\",\"success\":\"http://www.y.uno\"},\"binary_mode\":true,\"client_id\":\"3615163740385056\",\"collector_id\":1131498549,\"coupon_code\":null,\"coupon_labels\":null,\"date_created\":\"2023-07-23T19:02:40.082-04:00\",\"date_of_expiration\":null,\"expiration_date_from\":null,\"expiration_date_to\":null,\"expires\":false,\"external_reference\":\"286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"id\":\"1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"init_point\":\"https://www.mercadopago.com.ar/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"internal_metadata\":null,\"items\":[{\"id\":\"123AD\",\"category_id\":\"others\",\"currency_id\":\"ARS\",\"description\":\"\",\"title\":\"Skirt\",\"quantity\":1,\"unit_price\":3000}],\"marketplace\":\"MP-MKT-3615163740385056\",\"marketplace_fee\":0,\"metadata\":{},\"notification_url\":\"https://sandbox.y.uno/mercadopago-webhook/v1/checkout-pro/events?source_news=webhooks&transaction=286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"operation_type\":\"regular_payment\",\"payer\":{\"phone\":{\"area_code\":\"\",\"number\":\"\"},\"address\":{\"zip_code\":\"\",\"street_name\":\"\",\"street_number\":null},\"email\":\"johndoe@example.com\",\"identification\":{\"number\":\"123-45-6789\",\"type\":\"SSN\"},\"name\":\"John\",\"surname\":\"Doe\",\"date_created\":null,\"last_purchase\":null},\"payment_methods\":{\"default_card_id\":null,\"default_payment_method_id\":null,\"excluded_payment_methods\":[{\"id\":\"\"}],\"excluded_payment_types\":[{\"id\":\"ticket\"},{\"id\":\"atm\"}],\"installments\":null,\"default_installments\":null},\"processing_modes\":null,\"product_id\":null,\"redirect_urls\":{\"failure\":\"\",\"pending\":\"\",\"success\":\"\"},\"sandbox_init_point\":\"https://sandbox.mercadopago.com.ar/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"site_id\":\"MLA\",\"shipments\":{\"mode\":\"not_specified\",\"default_shipping_method\":null,\"cost\":0,\"receiver_address\":{\"zip_code\":\"\",\"street_name\":\"\",\"street_number\":null,\"floor\":\"\",\"apartment\":\"\",\"city_name\":null,\"state_name\":null,\"country_name\":null}},\"total_amount\":null,\"last_updated\":null}" }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:02:39.582570Z", "updated_at": "2023-07-23T23:02:40.227158Z" } ], "split": [], "callback_url": "www.y.uno", "workflow": "REDIRECT", "metadata": [], "account_code": "493e9374-510a-4201-9e09-de669d75f256", "fraud_screening": null, "idempotency_key": null, "payment_link_code": "", "routing_rules": null, "split_marketplace": [] } } } }, "schema": { "oneOf": [ { "title": "SDK_Checkout - Required Fields", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "e3f397ed-b7d0-4816-ab75-8457b0a30ec1" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-20T17:24:58.900553Z" }, "updated_at": { "type": "string", "example": "2023-07-20T17:25:13.447662Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 52000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "954dc216-60ff-4ae4-a299-c603b93bd267" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "2cd31999-e44e-4de3-bbe4-179981ff4295" }, "payment_method_detail": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "provider_image": { "type": "string", "example": "" }, "account_type": {}, "bank_name": { "type": "string", "example": "Bank of America" }, "beneficiary_name": { "type": "string", "example": "John Doe" }, "bank_account": { "type": "string", "example": "123456789" }, "bank_account_2": {}, "beneficiary_document_type": { "type": "string", "example": "SSN" }, "beneficiary_document": { "type": "string", "example": "123-45-6789" }, "payment_instruction": {}, "redirect_url": { "type": "string", "example": "https://api-sandbox.bankofamerica.com/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "cfae0941-7234-427a-a739-ef4fce966c79" }, "merchant_customer_id": { "type": "string", "example": "1689873883" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "email": { "type": "string", "example": "johndoe@gmail.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": {}, "city": { "type": "string", "example": "New York" }, "state": { "type": "string", "example": "NY" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": {}, "city": { "type": "string", "example": "New York" }, "state": { "type": "string", "example": "NY" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "09135cb9-159c-4662-8fe3-da5523bb2266" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "BANK_TRANSFER" }, "amount": { "type": "integer", "example": 52000, "default": 0 }, "provider_id": { "type": "string", "example": "BANK_OF_AMERICA" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "2cd31999-e44e-4de3-bbe4-179981ff4295" }, "detail": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "provider_image": { "type": "string", "example": "" }, "account_type": {}, "bank_name": { "type": "string", "example": "Bank of America" }, "beneficiary_name": { "type": "string", "example": "John Doe" }, "bank_account": { "type": "string", "example": "123456789" }, "bank_account_2": {}, "beneficiary_document_type": { "type": "string", "example": "SSN" }, "beneficiary_document": { "type": "string", "example": "123-45-6789" }, "payment_instruction": {}, "redirect_url": { "type": "string", "example": "https://api-sandbox.bankofamerica.com/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BANK_OF_AMERICA" }, "transaction_id": { "type": "string", "example": "117490-1689873907-17347" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "APPROVED" }, "status_detail": { "type": "string", "example": "" }, "response_code": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "amount_in_cents": { "type": "integer", "example": 5200000, "default": 0 }, "bill_id": {}, "billing_data": {}, "created_at": { "type": "string", "example": "2023-07-20T17:25:07.167Z" }, "currency": { "type": "string", "example": "USD" }, "customer_data": {}, "customer_email": { "type": "string", "example": "johndoe@gmail.com" }, "finalized_at": {}, "id": { "type": "string", "example": "117490-1689873907-17347" }, "payment_link_id": {}, "payment_method": { "type": "object", "properties": { "extra": { "type": "object", "properties": { "is_three_ds": { "type": "boolean", "example": false, "default": true } } }, "payment_description": { "type": "string", "example": "Test Bank of America" }, "sandbox_status": { "type": "string", "example": "APPROVED" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "user_type": { "type": "string", "example": "PERSON" } } }, "payment_method_type": { "type": "string", "example": "BANK_TRANSFER" }, "payment_source_id": {}, "redirect_url": { "type": "string", "example": "https://google.com/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267" }, "reference": { "type": "string", "example": "09135cb9-159c-4662-8fe3-da5523bb2266" }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": {}, "city": { "type": "string", "example": "New York" }, "state": { "type": "string", "example": "NY" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" } } }, "status": { "type": "string", "example": "PENDING" }, "status_message": {}, "taxes": { "type": "array" } } }, "meta": { "type": "object", "properties": {} } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-20T17:25:05.410687Z" }, "updated_at": { "type": "string", "example": "2023-07-20T17:25:11.472652Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "https://y.uno/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267" }, "workflow": { "type": "string", "example": "SDK_CHECKOUT" }, "metadata": { "type": "array" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "fraud_screening": { "type": [ "object", "null" ], "example": null }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "payment_link_code": { "type": "string", "example": "" }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With card details", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "bc0489ba-80bf-4bb9-98c5-ff8dfbceebf9" }, "account_id": { "type": "string", "example": "64761a45-6e49-4ea5-a6ff-6b52030b92ac" }, "description": { "type": "string", "example": "SUCCESSFUL" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "Order_id" }, "created_at": { "type": "string", "example": "2023-07-12T18:51:49.437886Z" }, "updated_at": { "type": "string", "example": "2023-07-12T18:51:54.679410Z" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 20000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "517862" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "token": {}, "collect_url": {}, "setup_reference_id": {}, "developer_id": {}, "solution_id": {}, "code": {}, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "acs_id": {}, "ds_id": {}, "pares_status": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "a76d79b7-902f-4152-922f-7e7eebc5f3dc" }, "merchant_customer_id": { "type": "string", "example": "1309" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": {}, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "string" }, "accept_header": { "type": "string", "example": "string" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "32" }, "screen_height": { "type": "string", "example": "32" }, "screen_width": { "type": "string", "example": "32" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "string" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Peak Avenue" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "San Diego" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Peak Avenue" }, "address_line_2": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "San Diego" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "c718b8e9-2943-4fdf-9b3c-426cf44940fb" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 20000, "default": 0 }, "provider_id": { "type": "string", "example": "DLOCAL" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "517862" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "token": {}, "collect_url": {}, "setup_reference_id": {}, "developer_id": {}, "solution_id": {}, "code": {}, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "acs_id": {}, "ds_id": {}, "pares_status": {} } } } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "SUCCESSFUL" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "DLOCAL" }, "transaction_id": { "type": "string", "example": "T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PAID" }, "status_detail": { "type": "string", "example": "200" }, "response_message": { "type": "string", "example": "The payment was paid." }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "{\"id\":\"T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42\",\"amount\":20000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":11,\"expiration_year\":2028,\"brand\":\"VI\",\"last4\":\"1111\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-12T18:51:52.000+0000\",\"approved_date\":\"2023-07-12T18:51:54.000+0000\",\"status\":\"PAID\",\"status_detail\":\"The payment was paid.\",\"status_code\":\"200\",\"order_id\":\"c718b8e9-2943-4fdf-9b3c-426cf44940fb\",\"description\":\"SUCCESSFUL\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"517862\"}}" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-12T18:51:51.908784Z" }, "updated_at": { "type": "string", "example": "2023-07-12T18:51:54.426087Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "64761a45-6e49-4ea5-a6ff-6b52030b92ac" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With airline data", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "6e7cc5da-2b39-4b6e-b382-df8bb1feddf1" }, "account_id": { "type": "string", "example": "64761a45-6e49-4ea5-a6ff-6b52030b92ac" }, "description": { "type": "string", "example": "SUCCESSFUL" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "Order_id" }, "created_at": { "type": "string", "example": "2023-07-12T20:06:41.418163Z" }, "updated_at": { "type": "string", "example": "2023-07-12T20:06:41.806898Z" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "token": {}, "collect_url": {}, "setup_reference_id": {}, "developer_id": {}, "solution_id": {}, "code": {}, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "acs_id": {}, "ds_id": {}, "pares_status": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": {}, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1998-01-01" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.0.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "string" }, "accept_header": { "type": "string", "example": "string" }, "accept_content": { "type": "string", "example": "string" }, "accept_browser": { "type": "string", "example": "string" }, "color_depth": { "type": "string", "example": "32" }, "screen_height": { "type": "string", "example": "32" }, "screen_width": { "type": "string", "example": "32" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "string" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": {}, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": { "type": "string", "example": "Apt 42" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main Street" }, "address_line_2": { "type": "string", "example": "Apt 42" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "ABC123" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "LAX" }, "departure_datetime": { "type": "string", "example": "2023-10-31T01:30:00.000-07:00" }, "departure_airport_timezone": { "type": "string", "example": "GMT-07" }, "arrival_airport": { "type": "string", "example": "JFK" }, "arrival_datetime": { "type": "string", "example": "2023-10-31T07:30:00.000-04:00" }, "carrier_code": { "type": "string", "example": "AA" }, "flight_number": { "type": "string", "example": "AA100" }, "fare_basis_code": { "type": "string", "example": "Y" }, "fare_class_code": { "type": "string", "example": "M" }, "base_fare": { "type": "integer", "example": 250, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "N" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "middle_name": { "type": "string", "example": "Michael" }, "type": { "type": "string", "example": "A" }, "date_of_birth": { "type": "string", "example": "1998-01-01" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "country": { "type": "string", "example": "US" }, "loyalty_number": { "type": "string", "example": "79250001" }, "loyalty_tier": { "type": "string", "example": "Platinum" }, "email": { "type": "string", "example": "john.doe@company.com" }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } } } } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "BRB0001" }, "e_ticket": { "type": "boolean", "example": true, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 500, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 50, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 25, "default": 0 }, "issue": { "type": "object", "properties": { "carrier_prefix_code": { "type": "string", "example": "AA" }, "travel_agent_code": { "type": "string", "example": "A104121" }, "travel_agent_name": { "type": "string", "example": "SkyTravel" }, "date": { "type": "string", "example": "2023-10-30T10:00:00.000-07:00" }, "address": { "type": "string", "example": "123 Main Street, Apt 42" }, "city": { "type": "string", "example": "Los Angeles" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "90001" } } } } } } } }, "order": {}, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "f4740123-2662-437c-a52b-7a80aa8fe807" }, "type": { "type": "string", "example": "AUTHORIZE" }, "status": { "type": "string", "example": "REJECTED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 2000, "default": 0 }, "provider_id": { "type": "string", "example": "MERCADO_PAGO" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "token": {}, "collect_url": {}, "setup_reference_id": {}, "developer_id": {}, "solution_id": {}, "code": {}, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "acs_id": {}, "ds_id": {}, "pares_status": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "REJECTED" }, "response_message": { "type": "string", "example": "Transaction unsuccessful" }, "reason": { "type": "string", "example": "Insufficient funds" }, "description": { "type": "string", "example": "Transaction failed" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "MERCADO_PAGO" }, "transaction_id": { "type": "string", "example": "T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "DECLINED" }, "status_detail": { "type": "string", "example": "Insufficient funds" }, "response_message": { "type": "string", "example": "Payment could not be completed." }, "iso8583_response_code": { "type": "string", "example": "05" }, "iso8583_response_message": { "type": "string", "example": "Do not honor" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "{\"id\":\"T-385928-c64b755f-1318-4a4c-a963-cd39bcefdc42\",\"amount\":2000,\"currency\":\"USD\",\"payment_method_id\":\"CARD\",\"payment_method_type\":\"CARD\",\"payment_method_flow\":\"DIRECT\",\"country\":\"US\",\"card\":{\"holder_name\":\"John Doe\",\"expiration_month\":11,\"expiration_year\":2028,\"brand\":\"VI\",\"last4\":\"1111\",\"installments\":1,\"installments_responsible\":\"customer\"},\"three_dsecure\":{},\"created_date\":\"2023-07-12T20:06:41.000+0000\",\"status\":\"DECLINED\",\"status_detail\":\"Insufficient funds\",\"status_code\":\"05\",\"order_id\":\"f4740123-2662-437c-a52b-7a80aa8fe807\",\"description\":\"Transaction failed\",\"notification_url\":\"https://sandbox.y.uno/mercado-pago-webhook/v1/confirmations\",\"acquirer\":{\"authorization_code\":\"\"}}" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-12T20:06:41.418163Z" }, "updated_at": { "type": "string", "example": "2023-07-12T20:06:41.806898Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "64761a45-6e49-4ea5-a6ff-6b52030b92ac" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With 3DS direct", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "cb3ca163-cb79-41d7-b9a3-0115e30a7c01" }, "idempotency_key": { "type": "string", "example": "fc0d89a1-8d18-4759-8d0a-ee1c6d0386e2" }, "account_code": { "type": "string", "example": "26a6626c-d3ec-4caa-bf7c-a994b145dc00" }, "account_id": { "type": "string", "example": "26a6626c-d3ec-4caa-bf7c-a994b145dc00" }, "description": { "type": "string", "example": "TEST_3DS" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-17T17:00:39.678379Z" }, "updated_at": { "type": "string", "example": "2023-07-17T17:41:48.453381Z" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 5000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "b0751c96-0b00-4b8c-8372-c16f72f60598" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "fc7ef8ae-000d-4903-ab76-494ebc8d5fa3" }, "merchant_customer_id": { "type": "string", "example": "1689374657" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": {}, "date_of_birth": {}, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": {}, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": {}, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "New York" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "New York" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": {}, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "caada737-27ab-46ca-91a9-744da64c4787" }, "type": { "type": "string", "example": "THREE_D_SECURE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "CYBERSOURCE_3DS" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "redirect_url": { "type": "string", "example": "https://checkout.staging.y.uno/payment?session=14c263bd-e01d-400f-885a-70205df8b417" }, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "44565300" }, "lfd": { "type": "string", "example": "0007" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank NA" }, "issuer_code": { "type": "string", "example": "US_JPMORGAN_CHASE_BANK_NA" }, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "three_d_secure_setup_id": { "type": "string", "example": "24127d61-b852-42fb-acd4-1ee661645376" }, "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": { "type": "string", "example": "Y" } } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "TEST_3DS" }, "merchant_reference": { "type": "string", "example": "reference-5f6dd991-ab14-4da3-b7d8-9f24a04ebd92" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "CYBERSOURCE_3DS" }, "transaction_id": { "type": "string", "example": "6896132402506977804951" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "AUTHENTICATION_SUCCESSFUL" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "CONSUMER_AUTHENTICATION_REQUIRED" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "clientReferenceInformation": { "type": "object", "properties": { "code": { "type": "string", "example": "24127d61-b852-42fb-acd4-1ee661645376" } } }, "consumerAuthenticationInformation": { "type": "object", "properties": { "accessToken": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxZmM5ZDVhMS04M2ZhLTQwYWEtYjI5Ny1iZDM1ZGIxODQ4ZjAiLCJpYXQiOjE2ODk2MTMyNDAsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTY4OTYxNjg0MCwiT3JnVW5pdElkIjoiNjQwYTM1NjlkODdhMjUwYTQyNTEwOWRjIiwiUGF5bG9hZCI6eyJBQ1NVcmwiOiJodHRwczovL21lcmNoYW50YWNzc3RhZy5jYXJkaW5hbGNvbW1lcmNlLmNvbS9NZXJjaGFudEFDU1dlYi9wYXJlcS5qc3A_dmFhPWImZ29sZD1BQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUEiLCJQYXlsb2FkIjoiZU5wVlVWMXZna0FRZkw5ZlFVd2ZHKzZBS3RHc2w5QnE2a2MwdHRCb254cUViU1dWRDQvRHFMKytkd2kxdmFlZHljN3R6aXdFTzRFNDhqR3FCSEpZWUZtR1gyZ2s4YkRqWC9KcHZqaVV6M0kyUzc4LzAvUE1ZeDBPSys4VkR4eU9LTW9rejdobE10TUcya0tpdmhEUkxzd2toekE2UEU2WC9LSFh0NjBlMEFZU1NGRk1SendZKzhHSE0vS0JYakdCTEV5UnYxZFpiaWphQ0xDVVFHdU9RSlJYbVJSbmJya01hQXNJVkdMUGQxSVc1WURTczZtVVFEVkZnTjYyV0ZXNktwVzVVeEx6TjZjNCt1ditNdG9zSi9HNG1HL1hNdDF1OXZPWHdCc0MxUjBFNGxBaXQ1bnRNTmR5RGNzZE1EWncra0JybmtDWTZ2bjhybXN5eHU2WldxaGhDQlI2bG5kRlhhWWYwTCtjTWxJSmdWblVPbWtSQVR3VmVZYXFSNFg1V3lzanQvV2ZKanJTU0txc1hPWTR6TEoxcGpXdTVZbUt4TzR4cTlZbmRUNVVhMmh6TWRvY1YxWC9qdjREQVEybVdnPT0iLCJUcmFuc2FjdGlvbklkIjoiU3pvSW9NcXNHdEpKbWtmbXlKQTAifSwiT2JqZWN0aWZ5UGF5bG9hZCI6dHJ1ZSwiUmV0dXJuVXJsIjoiaHR0cHM6Ly9zdGFnaW5nLnkudW5vL2N5YmVyc291cmNlLTNkcy13ZWJob29rL3YxL2NvbmZpcm1hdGlvbnMvYXV0aC8yNDEyN2Q2MS1iODUyLTQyZmItYWNkNC0xZWU2NjE2NDUzNzYifQ.5ehSTA5uUKc2DfvTRGJZ8dPKbxAJ5WproKSTLqu4egM" }, "acsUrl": { "type": "string", "example": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" }, "authenticationPath": { "type": "string", "example": "ENROLLED" }, "authenticationTransactionId": { "type": "string", "example": "SzoIoMqsGtJJmkfmyJA0" }, "pareq": { "type": "string", "example": "eNpVUV1vgkAQfL9fQUwfG+6AKtGsl9Bq6kc0ttBonxqEbSWVD4/DqL++dwi1vaedyc7tziwEO4E48jGqBHJYYFmGX2gk8bDjX/JpvjiUz3I2S78/0/PMYx0OK+8VDxyOKMokz7hlMtMG2kKivhDRLswkhzA6PE6X/KHXt60e0AYSSFFMRzwY+8GHM/KBXjGBLEyRv1dZbijaCLCUQGuOQJRXmRRnbrkMaAsIVGLPd1IW5YDSs6mUQDVFgN62WFW6KpW5UxLzN6c4+uv+MtosJ/G4mG/XMt1u9vOXwBsC1R0E4lAit5ntMNdyDcsdMDZw+kBrnkCY6vn8rmsyxu6ZWqhhCBR6lndFXaYf0L+cMlIJgVnUOmkRATwVeYaqR4X5Wysjt/WfJjrSSKqsXOY4zLJ1pjWu5YmKxO4xq9YndT5Ua2hzMdocV1X/jv4DAQ2mWg==" }, "proofXml": { "type": "string", "example": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/vereq.jsp?acqid=CYBS1.0.2XXXXXXXXXXXX0007469216TEST_3DS0*/*Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.361.0.2Y7033012https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAThreeDSecure" }, "proxyPan": { "type": "string", "example": "7033012" }, "specificationVersion": { "type": "string", "example": "1.0.2" }, "stepUpUrl": { "type": "string", "example": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp" }, "strongAuthentication": { "type": "object", "properties": { "OutageExemptionIndicator": { "type": "string", "example": "0" } } }, "token": { "type": "string", "example": "AxjzbwSTddcP6s4BiIKXABEBURzGv4QYVRP0JAY/LtaSZejFq0T8BEAAwwdp" }, "veresEnrolled": { "type": "string", "example": "Y" }, "xid": { "type": "string", "example": "U3pvSW9NcXNHdEpKbWtmbXlKQTA=" } } }, "errorInformation": { "type": "object", "properties": { "message": { "type": "string", "example": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction." }, "reason": { "type": "string", "example": "CONSUMER_AUTHENTICATION_REQUIRED" } } }, "id": { "type": "string", "example": "6896132402506977804951" }, "paymentInformation": { "type": "object", "properties": { "card": { "type": "object", "properties": { "bin": { "type": "string", "example": "445653" }, "type": { "type": "string", "example": "VISA" } } } } }, "status": { "type": "string", "example": "PENDING_AUTHENTICATION" }, "submitTimeUtc": { "type": "string", "example": "2023-07-17T17:00:40Z" } } }, "third_party_transaction_id": {} } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-17T17:00:39.765728Z" }, "updated_at": { "type": "string", "example": "2023-07-17T17:41:43.593769Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "https://google.com" }, "workflow": { "type": "string", "example": "REDIRECT" }, "fraud_screening": {}, "metadata": { "type": "array" }, "payment_link_code": { "type": "string", "example": "" }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With customer, billing, and shipping details", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "12113b61-015a-4a01-a69c-ab7423d0138d" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:03:02.291414Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:03:04.571022Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690160581" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "73e5cddf-32c7-4b12-9d8e-92335862928f" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-85ffbde3-2256-418f-b761-41ab2d8706dd" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "d570b77a-759e-45ae-abb9-ab4ab3034d0c" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:03:02.407480Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:03:04.499303Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With customer, billing, shipping and order items", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "cf205a5e-140e-4c08-9a5b-ee44b91256dc" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:08:17.039613Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:08:19.300337Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690160896" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 0, "default": 0 }, "shipping_amount": { "type": "integer", "example": 0, "default": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 5000, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" } } } } } }, "seller_details": {} } }, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "bf442c7f-2393-4607-98b5-a4c2a8a97bbc" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-9260ef97-81b5-4e35-ac17-0d3d124a0d59" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "ade1dcf5-cbf5-408b-84af-f504abe01a26" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:08:17.147871Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:08:19.222926Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With installments", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "3707bcc5-f88c-4092-ba44-142d1f3ea229" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:10:50.152163Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:10:52.417211Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 3, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "a58043ab-e5c6-4476-adfb-623fa8cc320d" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 3, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-f3f9319f-f3f7-48a3-90c2-fac0a2f782be" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "9efdc397-2a74-479a-af00-bf5ae7e2a76e" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:10:50.273142Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:10:52.339967Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With authorization", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "c0409fc0-87d5-453f-bf91-8f0af2f09347" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "PENDING" }, "sub_status": { "type": "string", "example": "AUTHORIZED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:13:37.372312Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:13:39.654433Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "e9108a97-5d0d-492a-99bf-da1ee42af425" }, "type": { "type": "string", "example": "AUTHORIZE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-0b914bf9-0e86-4713-a908-0ec01d60c486" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "1b7011ff-4252-4ac6-99a4-d5de2086896b" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:13:37.492230Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:13:39.584118Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With device fingerprint", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "8e7fbcad-9c7b-43c6-8fbf-b864e87c5e41" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:20:02.671644Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:20:04.946852Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge287gbd8d7d78" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "36524be2-b33e-4d33-b9d7-9f7853035bbd" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-89ab43dc-57de-4ea0-8058-6f7fc0d972a7" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "20500c62-96d2-457b-8e64-b64480190e89" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:20:02.794825Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:20:04.873386Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With vault on success", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "96b56df3-0013-4401-b58e-646f5e716ab8" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:27:23.360857Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:27:25.682059Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "967ecd18-d898-4b88-9400-dd5b01b18edc" }, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge287gbd8d7d78" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "85c19c82-dc31-4a50-aa7d-570d89dbc475" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-7cf75e3a-c8eb-4c62-bd02-74928f68f174" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "604075b9-52e9-48f5-8fcf-3c2d9bacbe66" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:27:23.473451Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:27:25.550651Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Card - With vaulted token", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "821ddfe4-309a-46a8-bd4b-819564aa9c5a" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "APPROVED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-24T01:28:45.444722Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:28:47.712002Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "967ecd18-d898-4b88-9400-dd5b01b18edc" }, "merchant_customer_id": { "type": "string", "example": "1690161049" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": { "type": "string", "example": "hi88287gbd8d7d782ge287gbd8d7d78" }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "a47e879e-3cd1-49f3-ab72-fc33b0185057" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "eb8caa17-6407-457b-960e-125d8d7a90c1" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": {}, "capture": { "type": "boolean", "example": true, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_plan_id": { "type": [ "string", "null" ], "example": null }, "installments_type": { "type": "string", "enum": [ "MERCHANT", "ISSUER", "NONE" ], "example": "" }, "installment_amount": {}, "installments_total_amount": { "type": [ "integer", "null" ], "example": null }, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "123456" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "40518856" }, "lfd": { "type": "string", "example": "6623" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "JPMorgan Chase Bank" }, "issuer_code": {}, "category": {}, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } } } }, "stored_credentials": { "type": "object", "properties": { "reason": { "type": "string", "example": "SUBSCRIPTION" }, "usage": { "type": "string", "example": "USED" }, "subscription_agreement_id": { "type": "string", "example": "XXXX01" }, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test" }, "merchant_reference": { "type": "string", "example": "reference-22103236-c3fc-4871-9fc0-98ce48a9f553" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "f9bcb8a8-d5d8-4c53-b551-5932c9804f16" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 2100, "default": 0 } } }, "merchantAccount": { "type": "string", "example": "YunoPaymentsECOM" }, "reference": { "type": "string", "example": "34343434" }, "status": { "type": "string", "example": "received" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-24T01:28:45.562437Z" }, "updated_at": { "type": "string", "example": "2023-07-24T01:28:47.639121Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_code": { "type": "string", "example": "" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Bank Transfer", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "ac427adb-3ac9-4a7c-9389-0a923146b39b" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-23T23:56:25.405475Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:56:29.742339Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 52000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "c21df85b-6c39-4cf5-aa7d-305aac6441e6" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "provider_image": { "type": "string", "example": "" }, "account_type": {}, "bank_name": { "type": "string", "example": "Bank of America" }, "beneficiary_name": { "type": "string", "example": "John Doe" }, "bank_account": { "type": "string", "example": "123456789" }, "bank_account_2": {}, "beneficiary_document_type": { "type": "string", "example": "SSN" }, "beneficiary_document": { "type": "string", "example": "123-45-6789" }, "payment_instruction": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=2cc7ac83-029d-4e13-8360-9b627bba8fc5" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1689888489" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "acbf992c-e448-4efc-a39c-05f74fa624cf" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "BANK_TRANSFER" }, "amount": { "type": "integer", "example": 52000, "default": 0 }, "provider_id": { "type": "string", "example": "WOMPI" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "provider_image": { "type": "string", "example": "" }, "account_type": {}, "bank_name": { "type": "string", "example": "Bank of America" }, "beneficiary_name": { "type": "string", "example": "John Doe" }, "bank_account": { "type": "string", "example": "123456789" }, "bank_account_2": {}, "beneficiary_document_type": { "type": "string", "example": "SSN" }, "beneficiary_document": { "type": "string", "example": "123-45-6789" }, "payment_instruction": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=2cc7ac83-029d-4e13-8360-9b627bba8fc5" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "WOMPI" }, "transaction_id": { "type": "string", "example": "117490-1690156586-55850" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "APPROVED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "" }, "iso8583_message": { "type": "string", "example": "" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "amount_in_cents": { "type": "integer", "example": 5200000, "default": 0 }, "bill_id": {}, "billing_data": {}, "created_at": { "type": "string", "example": "2023-07-23T23:56:26.350Z" }, "currency": { "type": "string", "example": "USD" }, "customer_data": {}, "customer_email": { "type": "string", "example": "johndoe@example.com" }, "finalized_at": {}, "id": { "type": "string", "example": "117490-1690156586-55850" }, "payment_link_id": {}, "payment_method": { "type": "object", "properties": { "extra": { "type": "object", "properties": { "is_three_ds": { "type": "boolean", "example": false, "default": true } } }, "payment_description": { "type": "string", "example": "Test Bank of America" }, "sandbox_status": { "type": "string", "example": "APPROVED" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "user_type": { "type": "string", "example": "PERSON" } } }, "payment_method_type": { "type": "string", "example": "BANK_TRANSFER" }, "payment_source_id": {}, "redirect_url": { "type": "string", "example": "https://demo.dev.y.uno/checkout/status?checkoutSession=" }, "reference": { "type": "string", "example": "acbf992c-e448-4efc-a39c-05f74fa624cf" }, "shipping_address": {}, "status": { "type": "string", "example": "PENDING" }, "status_message": {}, "taxes": { "type": "array" } } }, "meta": { "type": "object", "properties": {} } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-23T23:56:25.506471Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:56:29.673135Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "fraud_screening": { "type": [ "object", "null" ], "example": null }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "payment_link_code": { "type": "string", "example": "" }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Buy Now Pay Later", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "087be3a5-bed7-4c58-bbe0-c2ebcf376ebb" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-20T21:25:11.903819Z" }, "updated_at": { "type": "string", "example": "2023-07-20T21:25:12.983059Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 52000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "25e073ae-016c-4bca-89e7-64e05f766f11" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "ADDI" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": {}, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=82e244a2-9d5b-4998-93b7-8a293fb43b9c" }, "customer_data": {} } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "example00234" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "1328382d-f6e8-4f09-91b7-c18b1308c031" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "BUY_NOW_PAY_LATER" }, "amount": { "type": "integer", "example": 52000, "default": 0 }, "provider_id": { "type": "string", "example": "ADDI" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "ADDI" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "bnpl": { "type": "object", "properties": { "installments": {}, "provider_image": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=82e244a2-9d5b-4998-93b7-8a293fb43b9c" }, "customer_data": {} } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ADDI" }, "transaction_id": { "type": "string", "example": "0000022" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "CREATED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "" }, "iso8583_message": { "type": "string", "example": "" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "three_d_secure_action_required": {}, "created_at": { "type": "string", "example": "2023-07-20T21:25:12.008657Z" }, "updated_at": { "type": "string", "example": "2023-07-20T21:25:12.918362Z" } } } }, "split": { "type": "array" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" }, "fraud_screening": {}, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "payment_link_code": { "type": "string", "example": "" }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Payment Link", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "9c1f6ba0-d483-42a9-8d06-d53a07c284e0" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-23T23:11:24.724037Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:11:26.318691Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 5000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "3c9eb446-388a-4c2e-9818-573d54300dd1" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "WEBPAY" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "payment_link": { "type": "object", "properties": { "verify": {}, "capture": {}, "installments": {}, "payment_method_id": {}, "payment_method_detail": {}, "date_of_expiration": {}, "money_release_date": {}, "sponsor_id": {}, "authorization_code": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987" } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": {}, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "762abda0-2de5-43ba-a52b-04279acfb869" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "PAYMENT_LINK" }, "amount": { "type": "integer", "example": 5000, "default": 0 }, "provider_id": { "type": "string", "example": "TRANSBANK_2" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "WEBPAY" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": {} } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "TRANSBANK_2" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "00" }, "iso8583_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "token": { "type": "string", "example": "01aba0f569c8a78370aa35461ca482b57d1b767365535de9a0540c03791a3d97" }, "url": { "type": "string", "example": "https://webpay3gint.transbank.cl/webpayserver/initTransaction" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-23T23:11:24.842815Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:11:26.242431Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "www.y.uno" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "fraud_screening": { "type": [ "object", "null" ], "example": null }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "payment_link_code": { "type": "string", "example": "" }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Ticket", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "1c109200-3236-43f3-ab44-9a317991a288" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000022" }, "created_at": { "type": "string", "example": "2023-07-23T23:35:25.021285Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:35:26.067120Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 52000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "3faeb04f-0a52-41fc-9aba-33e535386776" }, "sdk_action_required": { "type": "boolean", "example": true, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "ticket": { "type": "object", "properties": { "type": {}, "date_of_expiration": {}, "provider_number": { "type": "string", "example": "762c4604-d4ba-4a8f-ba2f-5d39931e9ed8" }, "provider_barcode": {}, "provider_logo": {}, "provider_format": {}, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=3feff49c-a422-434a-9fad-eca87e2193d5" } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1690155316" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": {}, "accept_browser": {}, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": {}, "java_enabled": {}, "browser_time_difference": {}, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [] }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": {}, "taxes": {}, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "762c4604-d4ba-4a8f-ba2f-5d39931e9ed8" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "TICKET" }, "amount": { "type": "integer", "example": 52000, "default": 0 }, "provider_id": { "type": "string", "example": "UNLIMINT" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": {} } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": {}, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": {}, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "UNLIMINT" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "00" }, "iso8583_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "redirect_url": { "type": "string", "example": "https://sandbox.cardpay.com/MI/payment.html?uuid=a6cfEG0H3c1Hf42f23HhH3Ch" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-23T23:35:25.116858Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:35:25.988725Z" } } } }, "split": { "type": "array" }, "callback_url": { "type": "string", "example": "www.google.com" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array" }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "fraud_screening": { "type": [ "object", "null" ], "example": null }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "payment_link_code": { "type": "string", "example": "" }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [] } } } } }, { "title": "Wallet", "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "d0ff19c2-cf55-4015-a613-e35f22da0233" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "READY_TO_PAY" }, "sub_status": { "type": "string", "example": "CREATED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2023-07-23T23:02:39.401790Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:02:40.312593Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "number", "example": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "number", "example": 0 }, "value": { "type": "number", "example": 3000 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "b7e15362-4ac0-4e23-886e-329695933ecb" }, "sdk_action_required": { "type": "boolean", "example": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false }, "token": { "type": "string", "example": "" }, "payment_method_detail": { "type": "object", "properties": { "wallet": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false }, "capture": { "type": "boolean", "example": false }, "installments": { "type": [ "object", "null" ], "example": null }, "payment_method_id": { "type": [ "object", "null" ], "example": null }, "payment_method_detail": { "type": [ "object", "null" ], "example": null }, "date_of_expiration": { "type": [ "object", "null" ], "example": null }, "money_release_date": { "type": [ "object", "null" ], "example": null }, "sponsor_id": { "type": [ "object", "null" ], "example": null }, "authorization_code": { "type": [ "object", "null" ], "example": null }, "customer_data": { "type": [ "object", "null" ], "example": null }, "card_data": { "type": [ "object", "null" ], "example": null }, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": [ "object", "null" ], "example": null }, "merchant_customer_id": { "type": [ "object", "null" ], "example": null }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "johndoe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": { "type": [ "object", "null" ], "example": null }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "" }, "accept_header": { "type": "string", "example": "" }, "accept_content": { "type": [ "object", "null" ], "example": null }, "accept_browser": { "type": [ "object", "null" ], "example": null }, "color_depth": { "type": "string", "example": "" }, "screen_height": { "type": "string", "example": "" }, "screen_width": { "type": "string", "example": "" }, "javascript_enabled": { "type": [ "object", "null" ], "example": null }, "java_enabled": { "type": [ "object", "null" ], "example": null }, "browser_time_difference": { "type": [ "object", "null" ], "example": null }, "language": { "type": "string", "example": "" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 4B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" } } }, "device_fingerprints": { "type": "array", "example": [], "items": { "type": "object" } }, "geolocation": { "type": [ "object", "null" ], "example": null }, "merchant_customer_validations": { "type": [ "object", "null" ], "example": null }, "merchant_customer_created_at": { "type": [ "object", "null" ], "example": null } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": [ "object", "null" ], "example": null }, "order": { "type": "object", "properties": { "fee_amount": { "type": [ "object", "null" ], "example": null }, "shipping_amount": { "type": [ "object", "null" ], "example": null }, "items": { "type": "array", "example": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 3000, "category": null, "brand": null, "sku_code": null, "manufacture_part_number": null } ], "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1 }, "unit_amount": { "type": "integer", "example": 3000 }, "category": { "type": [ "object", "null" ], "example": null }, "brand": { "type": [ "object", "null" ], "example": null }, "sku_code": { "type": [ "object", "null" ], "example": null }, "manufacture_part_number": { "type": [ "object", "null" ], "example": null } } } } } }, "seller_details": { "type": [ "object", "null" ], "example": null } } }, "taxes": { "type": [ "object", "null" ], "example": null }, "transactions": { "type": "array", "example": [ { "id": "286ad833-7cbc-4e66-92f9-01019eb7d7a3", "type": "PURCHASE", "status": "CREATED", "category": "WALLET", "amount": 3000, "provider_id": "BANK_OF_AMERICA", "payment_method": { "vaulted_token": "", "type": "BANK_TRANSFER", "vault_on_success": false, "token": "", "detail": { "wallet": { "verify": false, "capture": false, "installments": null, "payment_method_id": null, "payment_method_detail": null, "date_of_expiration": null, "money_release_date": null, "sponsor_id": null, "authorization_code": null, "customer_data": null, "card_data": null, "redirect_url": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": null, "description": "Test Bank of America", "merchant_reference": "reference-d2b08e8e-c87a-4806-b1ea-b35a19a36a6d", "provider_data": { "id": "BANK_OF_AMERICA", "transaction_id": "", "account_id": "", "status": "", "status_detail": "", "response_message": "", "iso8583_code": "00", "iso8583_message": "Approved or completed successfully", "raw_response": { "value": "{\"additional_info\":\"\",\"auto_return\":\"approved\",\"back_urls\":{\"failure\":\"http://www.y.uno\",\"pending\":\"http://www.y.uno\",\"success\":\"http://www.y.uno\"},\"binary_mode\":true,\"client_id\":\"3615163740385056\",\"collector_id\":1131498549,\"coupon_code\":null,\"coupon_labels\":null,\"date_created\":\"2023-07-23T19:02:40.082-04:00\",\"date_of_expiration\":null,\"expiration_date_from\":null,\"expiration_date_to\":null,\"expires\":false,\"external_reference\":\"286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"id\":\"1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"init_point\":\"https://www.mercadopago.com.ar/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"internal_metadata\":null,\"items\":[{\"id\":\"123AD\",\"category_id\":\"others\",\"currency_id\":\"ARS\",\"description\":\"\",\"title\":\"Skirt\",\"quantity\":1,\"unit_price\":3000}],\"marketplace\":\"MP-MKT-3615163740385056\",\"marketplace_fee\":0,\"metadata\":{},\"notification_url\":\"https://sandbox.y.uno/mercadopago-webhook/v1/checkout-pro/events?source_news=webhooks&transaction=286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"operation_type\":\"regular_payment\",\"payer\":{\"phone\":{\"area_code\":\"\",\"number\":\"\"},\"address\":{\"zip_code\":\"\",\"street_name\":\"\",\"street_number\":null},\"email\":\"johndoe@example.com\",\"identification\":{\"number\":\"123-45-6789\",\"type\":\"SSN\"},\"name\":\"John\",\"surname\":\"Doe\",\"date_created\":null,\"last_purchase\":null},\"payment_methods\":{\"default_card_id\":null,\"default_payment_method_id\":null,\"excluded_payment_methods\":[{\"id\":\"\"}],\"excluded_payment_types\":[{\"id\":\"ticket\"},{\"id\":\"atm\"}],\"installments\":null,\"default_installments\":null},\"processing_modes\":null,\"product_id\":null,\"redirect_urls\":{\"failure\":\"\",\"pending\":\"\",\"success\":\"\"},\"sandbox_init_point\":\"https://sandbox.mercadopago.com.ar/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"site_id\":\"MLA\",\"shipments\":{\"mode\":\"not_specified\",\"default_shipping_method\":null,\"cost\":0,\"receiver_address\":{\"zip_code\":\"\",\"street_name\":\"\",\"street_number\":null,\"floor\":\"\",\"apartment\":\"\",\"city_name\":null,\"state_name\":null,\"country_name\":null}},\"total_amount\":null,\"last_updated\":null}" }, "third_party_transaction_id": "" }, "created_at": "2023-07-23T23:02:39.582570Z", "updated_at": "2023-07-23T23:02:40.227158Z" } ], "items": { "type": "object", "properties": { "id": { "type": "string", "example": "286ad833-7cbc-4e66-92f9-01019eb7d7a3" }, "type": { "type": "string", "example": "PURCHASE" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "WALLET" }, "amount": { "type": "number", "example": 3000 }, "provider_id": { "type": "string", "example": "BANK_OF_AMERICA" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "BANK_TRANSFER" }, "vault_on_success": { "type": "boolean", "example": false }, "token": { "type": "string", "example": "" }, "detail": { "type": "object", "properties": { "wallet": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false }, "capture": { "type": "boolean", "example": false }, "installments": { "type": [ "object", "null" ], "example": null }, "payment_method_id": { "type": [ "object", "null" ], "example": null }, "payment_method_detail": { "type": [ "object", "null" ], "example": null }, "date_of_expiration": { "type": [ "object", "null" ], "example": null }, "money_release_date": { "type": [ "object", "null" ], "example": null }, "sponsor_id": { "type": [ "object", "null" ], "example": null }, "authorization_code": { "type": [ "object", "null" ], "example": null }, "customer_data": { "type": [ "object", "null" ], "example": null }, "card_data": { "type": [ "object", "null" ], "example": null }, "redirect_url": { "type": "string", "example": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27" } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": { "type": [ "object", "null" ], "example": null }, "description": { "type": "string", "example": "Test Bank of America" }, "merchant_reference": { "type": "string", "example": "reference-d2b08e8e-c87a-4806-b1ea-b35a19a36a6d" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BANK_OF_AMERICA" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "" }, "iso8583_code": { "type": "string", "example": "00" }, "iso8583_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "value": { "type": "string", "example": "{\"additional_info\":\"\",\"auto_return\":\"approved\",\"back_urls\":{\"failure\":\"http://www.y.uno\",\"pending\":\"http://www.y.uno\",\"success\":\"http://www.y.uno\"},\"binary_mode\":true,\"client_id\":\"3615163740385056\",\"collector_id\":1131498549,\"coupon_code\":null,\"coupon_labels\":null,\"date_created\":\"2023-07-23T19:02:40.082-04:00\",\"date_of_expiration\":null,\"expiration_date_from\":null,\"expiration_date_to\":null,\"expires\":false,\"external_reference\":\"286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"id\":\"1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"init_point\":\"https://www.mercadopago.com.ar/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"internal_metadata\":null,\"items\":[{\"id\":\"123AD\",\"category_id\":\"others\",\"currency_id\":\"ARS\",\"description\":\"\",\"title\":\"Skirt\",\"quantity\":1,\"unit_price\":3000}],\"marketplace\":\"MP-MKT-3615163740385056\",\"marketplace_fee\":0,\"metadata\":{},\"notification_url\":\"https://sandbox.y.uno/mercadopago-webhook/v1/checkout-pro/events?source_news=webhooks&transaction=286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"operation_type\":\"regular_payment\",\"payer\":{\"phone\":{\"area_code\":\"\",\"number\":\"\"},\"address\":{\"zip_code\":\"\",\"street_name\":\"\",\"street_number\":null},\"email\":\"johndoe@example.com\",\"identification\":{\"number\":\"123-45-6789\",\"type\":\"SSN\"},\"name\":\"John\",\"surname\":\"Doe\",\"date_created\":null,\"last_purchase\":null},\"payment_methods\":{\"default_card_id\":null,\"default_payment_method_id\":null,\"excluded_payment_methods\":[{\"id\":\"\"}],\"excluded_payment_types\":[{\"id\":\"ticket\"},{\"id\":\"atm\"}],\"installments\":null,\"default_installments\":null},\"processing_modes\":null,\"product_id\":null,\"redirect_urls\":{\"failure\":\"\",\"pending\":\"\",\"success\":\"\"},\"sandbox_init_point\":\"https://sandbox.mercadopago.com.ar/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"site_id\":\"MLA\",\"shipments\":{\"mode\":\"not_specified\",\"default_shipping_method\":null,\"cost\":0,\"receiver_address\":{\"zip_code\":\"\",\"street_name\":\"\",\"street_number\":null,\"floor\":\"\",\"apartment\":\"\",\"city_name\":null,\"state_name\":null,\"country_name\":null}},\"total_amount\":null,\"last_updated\":null}" } } }, "third_party_transaction_id": { "type": "string", "example": "" } } }, "created_at": { "type": "string", "example": "2023-07-23T23:02:39.582570Z" }, "updated_at": { "type": "string", "example": "2023-07-23T23:02:40.227158Z" } } } }, "split": { "type": "array", "example": [], "items": { "type": "object" } }, "callback_url": { "type": "string", "example": "www.y.uno" }, "workflow": { "type": "string", "example": "REDIRECT" }, "metadata": { "type": "array", "example": [], "items": { "type": "object" } }, "account_code": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "fraud_screening": { "type": [ "object", "null" ], "example": null }, "idempotency_key": { "type": [ "object", "null" ], "example": null }, "payment_link_code": { "type": "string", "example": "" }, "routing_rules": { "type": [ "object", "null" ], "example": null }, "split_marketplace": { "type": "array", "example": [], "items": { "type": "object" } } } } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid Credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid Credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API" } } } } } } } }, "deprecated": false, "tags": [ "Payments" ] } }, "/payments/{payment_id}/cancel-or-refund": { "post": { "summary": "Cancel or Refund a Payment", "description": "", "operationId": "cancel-or-refund-a-payment", "parameters": [ { "name": "payment_id", "in": "path", "description": "The unique identifier of the payment (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the cancellation or refund. (MAX 255; MIN 3)." }, "reason": { "type": "string", "description": "Indicating the reason for the cancellation or refund. If set, possible values are `DUPLICATE`, `FRAUDULENT`, `REQUESTED_BY_CUSTOMER`, and `REVERSE`. Use `REVERSE` to request an automatic reverse of the recipient funds when a recipient is involved in the transaction.", "enum": [ "DUPLICATE", "FRAUDULENT", "REQUESTED_BY_CUSTOMER", "REVERSE" ] }, "merchant_reference": { "type": "string", "description": "Identification of the payment transaction defined by the merchant. If no merchant_reference is defined, the merchant_order_id of the payment will be associated to the transaction. (MAX 255; MIN 3)." }, "amount": { "type": "object", "description": "Specifies the amount object for refund.", "properties": { "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "format": "float", "description": "The payment amount (multiple of 0.0001)." } } }, "split_marketplace": { "type": "array", "description": "Split marketplace array of objects", "items": { "properties": { "recipient_id": { "type": "string", "description": "The unique identifier of the recipient in the Yuno system.
You must provide the [`recipient_id`](/reference/create-recipient-1) (Yuno-generated) or the `provider_recipient_id` (external provider's ID) when creating a payment." }, "provider_recipient_id": { "type": "string", "description": "The recipient ID provided by the external payment provider, if applicable.
You must provide the `provider_recipient_id` or the [`recipient_id`](/reference/create-recipients) (Yuno-generated) when creating a payment." }, "description": { "type": "string", "description": "Description for the split. (MAX 255; MIN 3)." }, "type": { "type": "string", "description": "The type of split. `recipient_id` is mandatory for `PURCHASE` and `MARKETPLACE`.", "enum": [ "PURCHASE", "PAYMENTFEE", "VAT", "COMMISSION", "MARKETPLACE", "SHIPPING" ] }, "merchant_reference": { "type": "string", "description": "Optional unique identifier for the split transaction (MAX 255; MIN 3)." }, "recipient_type": { "type": "string", "description": "The type of recipient for the provider.", "enum": [ "MEAL", "FOOD", "MULTI_BENEFITS", "FLEET" ], "example": "MEAL" }, "amount": { "type": "object", "description": "Defines the amount of the split.", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The split amount (multiple of 0.0001).", "format": "float" }, "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." } } }, "liability": { "type": "object", "description": "Optional information regarding the recipient's liability for fees and chargebacks.", "properties": { "processing_fee": { "type": "string", "description": "Indicates who will be charged the transaction fee.", "enum": [ "MERCHANT", "RECIPIENT", "SHARED" ] }, "chargebacks": { "type": "boolean", "description": "The recipient is responsible in case of a chargeback." } } } }, "required": [ "type" ], "type": "object" } }, "simplified_mode": { "type": "boolean", "description": "Indicates if we should try to refund a payment after an error/declined on the first try. It is `false` by default. For more information, access the [guide](transaction-retries).", "default": false }, "response_additional_data": { "type": "object", "description": "Specifies additional data for required the transaction response", "properties": { "receipt": { "type": "boolean", "description": "Indicates if a receipt is necessary for the transaction response" }, "receipt_language": { "type": "string", "description": "Indicates the language of the receipt to be generated", "enum": [ "ES", "EN", "PT" ] } } }, "customer_payer": { "type": "object", "description": "Specifies customer object for payments.", "properties": { "first_name": { "type": "string", "description": "The customer's first name (MAX 255; MIN 3)." }, "last_name": { "type": "string", "description": "The customer's last name (MAX 255; MIN 3)." }, "gender": { "type": "string", "description": "The customer's gender (MAX 2; MIN 1).
- M=Male
- F=Female
- NB=Non Binary
- NA=Not applicable
- NK=Not Known
- U=Undefined.", "enum": [ "M", "F", "NB", "NA", "NK", "U" ] }, "date_of_birth": { "type": "string", "description": "The customer's date of birth in the `YYYY-MM-DD` format (Length: 10)." }, "email": { "type": "string", "description": "The customer's e-mail (MAX 255; MIN 3)." }, "nationality": { "type": "string", "description": "The customer's nationality (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference))." }, "document": { "type": "object", "description": "Specifies the customer's document object, including its number and type.", "properties": { "document_number": { "type": "string", "description": "Document number for customer (MAX 40; MIN 3)" }, "document_type": { "type": "string", "description": "The customer's document type (MAX 6, MIN 2). Access [Document Type List](/reference/country-reference) for more details.", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC" ] } } }, "phone": { "type": "object", "description": "Specifies the customer's phone object.", "properties": { "country_code": { "type": "string", "description": "The country code of the customer's phone (MAX 3; MIN 1)." }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1)." } } }, "billing_address": { "type": "object", "description": "Specifies the customer's billing address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the billing address (MAX 2; MIN 2; [ISO 3166-1](https://docs.y.uno/reference/customer-object#country-code-list-iso-3166-1)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state considered for the billing address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the billing address (MAX 10; MIN 5)." } } }, "shipping_address": { "type": "object", "description": "Specifies the customer's shipping address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary shipping address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary shipping address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the shipping address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the shipping address (MAX 2; MIN 2; [ISO 3166-1](https://docs.y.uno/reference/customer-object#country-code-list-iso-3166-1)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state considered for the shipping address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the shipping address (MAX 10; MIN 5)." } } } } }, "payment_method": { "type": "object", "description": "Specifies payment method object for payments.", "properties": { "detail": { "type": "object", "description": "Specifies the payment method detail object.", "properties": { "bank_transfer": { "type": "object", "description": "Specifies bank transfer payment method details.", "properties": { "account_type": { "type": "string", "description": "Type of bank account (MAX 255; MIN 3)", "enum": [ "CHECKINGS", "SAVINGS" ] }, "bank_name": { "type": "string", "description": "Name of the bank (MAX 255; MIN 3)" }, "bank_id": { "type": "string", "description": "ID of the bank (MAX 255; MIN 3)" }, "beneficiary_name": { "type": "string", "description": "Name of the account holder (MAX 255; MIN 3)" }, "bank_account": { "type": "string", "description": "Bank account number (MAX 255; MIN 3)" }, "beneficiary_document_type": { "type": "string", "description": "Document type of the account holder (MAX 255; MIN 3)" }, "beneficiary_document": { "type": "string", "description": "Document number of the account holder (MAX 255; MIN 3)" }, "reference": { "type": "string", "description": "Reference code for the user (MAX 255; MIN 1)" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } } }, "required": [ "reason" ] }, "examples": { "Full Refund": { "value": { "description": "Duplicate", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "AAB01-432245" } }, "Partial Refund": { "value": { "amount": { "currency": "COP", "value": 500 }, "description": "Duplicate", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "AAB01-432245" } }, "Cancel": { "value": { "description": "Duplicate", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "AAB01-432245" } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Full Refund": { "value": { "id": "7fd485f3-bd72-45eb-a3fb-774daa3d79b6", "type": "REFUND", "status": "REFUNDED", "category": "CARD", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 30000 }, "merchant_reference": "0000023", "created_at": "2024-06-06T14:06:06.284443Z", "updated_at": "2024-06-06T14:06:37.984065Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "status": "", "status_detail": "", "response_message": null, "response_code": "SUCCEEDED", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_request": { "amount": { "currency": "BRL", "value": 2100 }, "reference": "34343434" }, "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "c3583c27-0478-4e02-8827-4d8f2121c670", "account_id": "", "description": "Test Bank of America", "country": "US", "status": "REFUNDED", "sub_status": "REFUNDED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:06:06.284443Z", "updated_at": "2024-06-06T14:06:06.284443Z", "amount": { "captured": 0, "currency": "USD", "refunded": 30000, "value": 30000 }, "additional_data": { "airline": { "pnr": "1P-2UUGJW", "legs": [ { "departure_airport": "EWR", "departure_datetime": "2014-05-12 13:05:00", "departure_airport_timezone": "-05:00", "arrival_airport": "SFO", "arrival_airport_timezone": "-08:00", "arrival_datetime": "", "carrier_code": "UA", "flight_number": "842", "fare_basis_code": "HL7LNR", "fare_class_code": "FR", "base_fare": 200, "base_fare_currency": "USD", "stopover_code": "s" } ], "passengers": [ { "first_name": "John", "last_name": "Doe", "middle_name": "A", "type": "adult", "date_of_birth": "1980-01-01", "nationality": "US", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "country": "US", "loyalty_number": "UA123456", "loyalty_tier": "Gold", "email": "johndoe@example.com", "phone": "+15555555555" } ], "ticket": null, "tickets": [ { "ticket_number": "123456", "e_ticket": false, "restricted": false, "total_fare_amount": 80, "total_tax_amount": 22, "total_fee_amount": 14, "issue": null } ] }, "order": { "fee_amount": 100, "shipping_amount": 100, "tip_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 29800, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456" } ] }, "seller_details": null } } } }, "Partial Refund": { "value": { "id": "e44cdc8e-01e7-4767-a1b6-3a646a609dc5", "type": "REFUND", "status": "SUCCEEDED", "category": "CARD", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 30000 }, "merchant_reference": "0000023", "created_at": "2024-06-06T14:07:53.881239Z", "updated_at": "2024-06-06T14:08:17.438878Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "status": "", "sub_status": "", "status_detail": "", "response_message": null, "response_code": "SUCCEEDED", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "eee7daeb-5ed7-41bd-8fee-7a440ca2ab86", "account_id": "", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "PARTIALLY_REFUNDED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:07:53.881239Z", "updated_at": "2024-06-06T14:07:53.881239Z", "amount": { "captured": 0, "currency": "USD", "refunded": 1000, "value": 30000 }, "additional_data": { "airline": { "pnr": "1P-2UUGJW", "legs": [ { "departure_airport": "EZE", "departure_datetime": "2014-05-12 13:05:00", "departure_airport_timezone": "-03:00", "arrival_airport": "AMS", "arrival_airport_timezone": "+00:00", "arrival_datetime": "", "carrier_code": "KL", "flight_number": "842", "fare_basis_code": "HL7LNR", "fare_class_code": "FR", "base_fare": 200, "base_fare_currency": "USD", "stopover_code": "s" } ], "passengers": [ { "first_name": "John", "last_name": "Doe", "middle_name": "A.", "type": "adult", "date_of_birth": "1980-01-01", "nationality": "US", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "country": "US", "loyalty_number": "JD123456", "loyalty_tier": "Gold", "email": "johndoe@example.com", "phone": "5551234567" } ], "ticket": null, "tickets": [ { "ticket_number": "123456", "e_ticket": false, "restricted": false, "total_fare_amount": 80, "total_tax_amount": 22, "total_fee_amount": 14, "issue": null } ] }, "order": { "fee_amount": 100, "shipping_amount": 100, "tip_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 29800, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456" } ] }, "seller_details": null } } } }, "Cancel": { "value": { "id": "2fbc6db6-718b-4554-b03f-826e552f1b9f", "type": "CANCEL", "status": "SUCCEEDED", "category": "CARD", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 30000 }, "merchant_reference": "", "created_at": "2024-06-06T14:05:31.651012Z", "updated_at": "2024-06-06T14:05:31.742355Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "SUCCEEDED", "response_message": null, "response_code": "SUCCEEDED", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "cddba02c-e47d-4330-9cac-afcd9c0194b1", "account_id": "", "description": "Test", "country": "US", "status": "CANCELED", "sub_status": "CANCELED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:04:44.768364Z", "updated_at": "2024-06-06T14:05:31.79539Z", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 30000 } } } } }, "schema": { "oneOf": [ { "title": "Full Refund", "type": "object", "properties": { "id": { "type": "string", "example": "7fd485f3-bd72-45eb-a3fb-774daa3d79b6" }, "type": { "type": "string", "example": "REFUND" }, "status": { "type": "string", "example": "REFUNDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:06:06.284443Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:06:37.984065Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "c3583c27-0478-4e02-8827-4d8f2121c670" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test Bank of America" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "REFUNDED" }, "sub_status": { "type": "string", "example": "REFUNDED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:06:06.284443Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:06:06.284443Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 30000, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "1P-2UUGJW" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "EWR" }, "departure_datetime": { "type": "string", "example": "2014-05-12 13:05:00" }, "departure_airport_timezone": { "type": "string", "example": "-05:00" }, "arrival_airport": { "type": "string", "example": "SFO" }, "arrival_airport_timezone": { "type": "string", "example": "-08:00" }, "arrival_datetime": { "type": "string", "example": "" }, "carrier_code": { "type": "string", "example": "UA" }, "flight_number": { "type": "string", "example": "842" }, "fare_basis_code": { "type": "string", "example": "HL7LNR" }, "fare_class_code": { "type": "string", "example": "FR" }, "base_fare": { "type": "integer", "example": 200, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "s" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "middle_name": { "type": "string", "example": "A" }, "type": { "type": "string", "example": "adult" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "country": { "type": "string", "example": "US" }, "loyalty_number": { "type": "string", "example": "UA123456" }, "loyalty_tier": { "type": "string", "example": "Gold" }, "email": { "type": "string", "example": "johndoe@example.com" }, "phone": { "type": "string", "example": "+15555555555" } } } }, "ticket": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "123456" }, "e_ticket": { "type": "boolean", "example": false, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 80, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 22, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 14, "default": 0 }, "issue": {} } } } } }, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 100, "default": 0 }, "shipping_amount": { "type": "integer", "example": 100, "default": 0 }, "tip_amount": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 29800, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" } } } } } }, "seller_details": {} } } } } } }, { "title": "Partial Refund", "type": "object", "properties": { "id": { "type": "string", "example": "e44cdc8e-01e7-4767-a1b6-3a646a609dc5" }, "type": { "type": "string", "example": "REFUND" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:07:53.881239Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:08:17.438878Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "status": { "type": "string", "example": "" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "eee7daeb-5ed7-41bd-8fee-7a440ca2ab86" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "PARTIALLY_REFUNDED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:07:53.881239Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:07:53.881239Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 1000, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "1P-2UUGJW" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "EZE" }, "departure_datetime": { "type": "string", "example": "2014-05-12 13:05:00" }, "departure_airport_timezone": { "type": "string", "example": "-03:00" }, "arrival_airport": { "type": "string", "example": "AMS" }, "arrival_airport_timezone": { "type": "string", "example": "+00:00" }, "arrival_datetime": { "type": "string", "example": "" }, "carrier_code": { "type": "string", "example": "KL" }, "flight_number": { "type": "string", "example": "842" }, "fare_basis_code": { "type": "string", "example": "HL7LNR" }, "fare_class_code": { "type": "string", "example": "FR" }, "base_fare": { "type": "integer", "example": 200, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "s" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "middle_name": { "type": "string", "example": "A." }, "type": { "type": "string", "example": "adult" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "country": { "type": "string", "example": "US" }, "loyalty_number": { "type": "string", "example": "JD123456" }, "loyalty_tier": { "type": "string", "example": "Gold" }, "email": { "type": "string", "example": "johndoe@example.com" }, "phone": { "type": "string", "example": "5551234567" } } } }, "ticket": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "123456" }, "e_ticket": { "type": "boolean", "example": false, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 80, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 22, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 14, "default": 0 }, "issue": {} } } } } }, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 100, "default": 0 }, "shipping_amount": { "type": "integer", "example": 100, "default": 0 }, "tip_amount": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 29800, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" } } } } } }, "seller_details": {} } } } } } }, { "title": "Cancel", "type": "object", "properties": { "id": { "type": "string", "example": "2fbc6db6-718b-4554-b03f-826e552f1b9f" }, "type": { "type": "string", "example": "CANCEL" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2024-06-06T14:05:31.651012Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:05:31.742355Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "SUCCEEDED" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "cddba02c-e47d-4330-9cac-afcd9c0194b1" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "CANCELED" }, "sub_status": { "type": "string", "example": "CANCELED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:04:44.768364Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:05:31.79539Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } } } } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payments" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/payments/{payment_id}/fulfillments": { "post": { "summary": "Notify Fulfillment", "description": "Notify fulfillment status and shipping details for a payment order.", "operationId": "fulfillments", "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the payment (MAX 64; MIN 36)." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "fulfillments" ], "properties": { "status": { "type": "string", "description": "The status of the order fulfillment.", "enum": [ "PARTIAL", "COMPLETED", "REPLACEMENT", "CANCELED" ] }, "fulfillments": { "type": "array", "description": "Fulfillments array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the fulfillment (MAX 255; MIN 3)" }, "type": { "type": "string", "description": "The type of the fulfillment", "enum": [ "CUSTOM", "MILITARY", "ELECTRONIC", "EXPRESS", "STANDARD", "SCHEDULED", "ECONOMY", "PRIORITY", "SAME_DAY", "NEXT_DAY", "THIRD_DAY", "STORE_PICK_UP", "LOCKER_PICK_UP", "OTHER" ] }, "status": { "type": "string", "description": "The status of the fulfillment.", "enum": [ "PARTIAL", "COMPLETED", "REPLACEMENT", "CANCELED" ] }, "description": { "type": "string", "description": "The description of the fulfillment. (MAX 255; MIN 3)" }, "carriers": { "type": "array", "description": "Carriers array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the carrier (MAX 255; MIN 3)" }, "tracking_id": { "type": "array", "description": "Tracking identifiers from the carrier (MAX 255; MIN 3 per item)", "items": { "type": "string" } }, "tracking_url": { "type": "array", "description": "Tracking URLs from the carrier (MAX 999; MIN 1 per item)", "items": { "type": "string" } }, "shipped_at": { "type": "string", "description": "Shipping date (YYYY-MM-DD)", "format": "date" }, "delivered_at": { "type": "string", "description": "Delivery date (YYYY-MM-DD)", "format": "date" } }, "required": [ "id", "tracking_id", "tracking_url" ] } } }, "required": [ "id", "type", "status" ] } }, "carriers": { "type": "null", "description": "Deprecated: use `fulfillments[].carriers` instead" } } }, "examples": { "Request Example": { "value": { "status": "PARTIAL", "fulfillments": [ { "id": "fulfillment-1", "type": "STANDARD", "status": "COMPLETED", "description": "Package delivered successfully.", "shipped_at": "2024-11-20T15:00:00Z", "deliver_at": "2024-11-23T18:00:00Z" } ], "carriers": [ { "id": "UPS", "tracking_id": [ "TRK12345", "TRK67890" ], "tracking_url": [ "https://tracking.example.com/TRK12345", "https://tracking.example.com/TRK67890" ] } ] } }, "Empty Carriers": { "summary": "Empty Carriers", "value": { "status": "PARTIAL", "fulfillments": [ { "id": "fulfillment-1", "type": "STANDARD", "status": "COMPLETED", "description": "Package delivered successfully.", "carriers": [] } ] } } } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "Accepted": { "summary": "Accepted", "value": "" } } } }, "description": "Accepted" }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] }, "summary": "Invalid Request" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Payments" ] } }, "/payments/{payment_id}/transactions/{transaction_id}/cancel": { "post": { "summary": "Cancel Payment", "description": "", "operationId": "cancel-payment", "parameters": [ { "name": "payment_id", "in": "path", "description": "The unique identifier of the payment (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "transaction_id", "in": "path", "description": "The unique identifier of the transaction (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchant_reference" ], "properties": { "description": { "type": "string", "description": "Description of the cancellation.(MAX 255; MIN 3)" }, "reason": { "type": "string", "description": "Reason for the cancellation. Values can be `DUPLICATE`, `FRAUDULENT`, and `REQUESTED_BY_CUSTOMER`.", "enum": [ "DUPLICATE", "FRAUDULENT", "REQUESTED_BY_CUSTOMER" ] }, "merchant_reference": { "type": "string", "description": "Identification of the payment transaction defined by the merchant (MAX 255; MIN 3)." }, "response_additional_data": { "type": "object", "description": "Specifies additional data for required the transaction response", "properties": { "receipt": { "type": "boolean", "description": "Indicates if a receipt is necessary for the transaction response" }, "receipt_language": { "type": "string", "description": "Indicates the language of the receipt to be generated", "enum": [ "ES", "EN", "PT" ] }, "transactions_history": { "type": "boolean", "description": "When true, includes the transactions history in the response" }, "raw_request": { "type": "boolean", "description": "When true, includes the provider raw request in the output" }, "raw_response": { "type": "boolean", "description": "When true, includes the provider raw response in the output" } } } } }, "examples": { "Request Example": { "value": { "description": "Duplicate", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "AAB01-432245" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "438bea6c-9061-4416-b824-469c3c05868d", "type": "CANCEL", "status": "SUCCEEDED", "category": "CARD", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 30000 }, "merchant_reference": "", "created_at": "2024-06-06T14:03:08.384014Z", "updated_at": "2024-06-06T14:03:08.453617Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "SUCCEEDED", "response_message": null, "response_code": "SUCCEEDED", "raw_response": { "message": "provider response" }, "third_party_transaction_id": null, "third_party_account_id": null, "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully" }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "2d6f75c1-c4bc-4d2d-80ec-0af4d12c85da", "account_id": "", "description": "Test", "country": "US", "status": "CANCELED", "sub_status": "CANCELED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:01:34.286228Z", "updated_at": "2024-06-06T14:03:08.484781Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 0, "value": 30000 }, "split_marketplace": [] }, "customer_payer": null, "simplified_mode": false, "receipt": false, "receipt_url": null, "receipt_language": null } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "438bea6c-9061-4416-b824-469c3c05868d" }, "type": { "type": "string", "example": "CANCEL" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "currency_conversion": {}, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2024-06-06T14:03:08.384014Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:03:08.453617Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "SUCCEEDED" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "message": { "type": "string", "example": "provider response" } } }, "third_party_transaction_id": {}, "third_party_account_id": {}, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "2d6f75c1-c4bc-4d2d-80ec-0af4d12c85da" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "CANCELED" }, "sub_status": { "type": "string", "example": "CANCELED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:01:34.286228Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:03:08.484781Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "currency_conversion": {}, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "split_marketplace": { "type": "array" } } }, "customer_payer": {}, "simplified_mode": { "type": "boolean", "example": false, "default": true }, "receipt": { "type": "boolean", "example": false, "default": true }, "receipt_url": {}, "receipt_language": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payments" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/payments/{payment_id}/transactions/{transaction_id}/cancel-or-refund": { "post": { "summary": "Cancel or Refund a Payment with transaction", "description": "", "operationId": "cancel-or-refund-payment-with-transaction", "parameters": [ { "name": "payment_id", "in": "path", "description": "The unique identifier of the payment (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "transaction_id", "in": "path", "description": "The unique identifier of the transaction (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "description": { "type": "string", "description": "Description of the cancellation or refund. (MAX 255; MIN 3)." }, "reason": { "type": "string", "description": "Indicating the reason for the cancellation or refund. If set, possible values are `DUPLICATE`, `FRAUDULENT`, `REQUESTED_BY_CUSTOMER`, and `REVERSE`. Use `REVERSE` to request an automatic reverse of the recipient funds when a recipient is involved in the transaction.", "enum": [ "DUPLICATE", "FRAUDULENT", "REQUESTED_BY_CUSTOMER", "REVERSE" ] }, "merchant_reference": { "type": "string", "description": "Identification of the payment transaction defined by the merchant. If no merchant_reference is defined, the merchant_order_id of the payment will be associated to the transaction. (MAX 255; MIN 3)." }, "amount": { "type": "object", "description": "Specifies the amount object for refund.", "properties": { "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/docs/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "format": "float", "description": "The payment amount (multiple of 0.0001)." } } }, "split_marketplace": { "type": "array", "description": "Split marketplace array of objects", "items": { "properties": { "recipient_id": { "type": "string", "description": "The unique identifier of the recipient in the Yuno system.
You must provide the [`recipient_id`](/reference/create-recipient-1) (Yuno-generated) or the `provider_recipient_id` (external provider's ID) when creating a payment." }, "provider_recipient_id": { "type": "string", "description": "The recipient ID provided by the external payment provider, if applicable.
You must provide the `provider_recipient_id` or the [`recipient_id`](/reference/create-recipients) (Yuno-generated) when creating a payment." }, "description": { "type": "string", "description": "Description for the split. (MAX 255; MIN 3)." }, "type": { "type": "string", "description": "The type of split. `recipient_id` is mandatory for `PURCHASE` and `MARKETPLACE`.", "enum": [ "PURCHASE", "PAYMENTFEE", "VAT", "COMMISSION", "MARKETPLACE", "SHIPPING" ] }, "merchant_reference": { "type": "string", "description": "Optional unique identifier for the split transaction (MAX 255; MIN 3)." }, "recipient_type": { "type": "string", "description": "The type of recipient for the provider.", "enum": [ "MEAL", "FOOD", "MULTI_BENEFITS", "FLEET" ], "example": "MEAL" }, "amount": { "type": "object", "description": "Defines the amount of the split.", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The split amount (multiple of 0.0001).", "format": "float" }, "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/docs/country-reference) (MAX 3; MIN 3; ISO 4217)." } } }, "liability": { "type": "object", "description": "Optional information regarding the recipient's liability for fees and chargebacks.", "properties": { "processing_fee": { "type": "string", "description": "Indicates who will be charged the transaction fee.", "enum": [ "MERCHANT", "RECIPIENT", "SHARED" ] }, "chargebacks": { "type": "boolean", "description": "The recipient is responsible in case of a chargeback." } } } }, "required": [ "type" ], "type": "object" } }, "simplified_mode": { "type": "boolean", "description": "Indicates if we should try to refund a payment after an error/declined on the first try. It is `false` by default. For more information, access the [guide](transaction-retries).", "default": false }, "response_additional_data": { "type": "object", "description": "Specifies additional data for required the transaction response", "properties": { "receipt": { "type": "boolean", "description": "Indicates if a receipt is necessary for the transaction response" }, "receipt_language": { "type": "string", "description": "Indicates the language of the receipt to be generated", "enum": [ "ES", "EN", "PT" ] } } }, "customer_payer": { "type": "object", "description": "Specifies customer object for payments.", "properties": { "first_name": { "type": "string", "description": "The customer's first name (MAX 255; MIN 3)." }, "last_name": { "type": "string", "description": "The customer's last name (MAX 255; MIN 3)." }, "gender": { "type": "string", "description": "The customer's gender (MAX 2; MIN 1).
- M=Male
- F=Female
- NB=Non Binary
- NA=Not applicable
- NK=Not Known
- U=Undefined.", "enum": [ "M", "F", "NB", "NA", "NK", "U" ] }, "date_of_birth": { "type": "string", "description": "The customer's date of birth in the `YYYY-MM-DD` format (Length: 10)." }, "email": { "type": "string", "description": "The customer's e-mail (MAX 255; MIN 3)." }, "nationality": { "type": "string", "description": "The customer's nationality (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference))." }, "document": { "type": "object", "description": "Specifies the customer's document object, including its number and type.", "properties": { "document_number": { "type": "string", "description": "Document number for customer (MAX 40; MIN 3)" }, "document_type": { "type": "string", "description": "The customer's document type (MAX 6, MIN 2). Access [Document Type List](/reference/country-reference) for more details.", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC" ] } } }, "phone": { "type": "object", "description": "Specifies the customer's phone object.", "properties": { "country_code": { "type": "string", "description": "The country code of the customer's phone (MAX 3; MIN 1)." }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1)." } } }, "billing_address": { "type": "object", "description": "Specifies the customer's billing address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the billing address (MAX 2; MIN 2; [ISO 3166-1](https://docs.y.uno/reference/customer-object#country-code-list-iso-3166-1)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state considered for the billing address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the billing address (MAX 10; MIN 5)." } } }, "shipping_address": { "type": "object", "description": "Specifies the customer's shipping address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary shipping address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary shipping address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the shipping address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the shipping address (MAX 2; MIN 2; [ISO 3166-1](https://docs.y.uno/reference/customer-object#country-code-list-iso-3166-1)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state considered for the shipping address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the shipping address (MAX 10; MIN 5)." } } } } }, "payment_method": { "type": "object", "description": "Specifies payment method object for payments.", "properties": { "detail": { "type": "object", "description": "Specifies the payment method detail object.", "properties": { "bank_transfer": { "type": "object", "description": "Specifies bank transfer payment method details.", "properties": { "account_type": { "type": "string", "description": "Type of bank account (MAX 255; MIN 3)", "enum": [ "CHECKINGS", "SAVINGS" ] }, "bank_name": { "type": "string", "description": "Name of the bank (MAX 255; MIN 3)" }, "bank_id": { "type": "string", "description": "ID of the bank (MAX 255; MIN 3)" }, "beneficiary_name": { "type": "string", "description": "Name of the account holder (MAX 255; MIN 3)" }, "bank_account": { "type": "string", "description": "Bank account number (MAX 255; MIN 3)" }, "beneficiary_document_type": { "type": "string", "description": "Document type of the account holder (MAX 255; MIN 3)" }, "beneficiary_document": { "type": "string", "description": "Document number of the account holder (MAX 255; MIN 3)" }, "reference": { "type": "string", "description": "Reference code for the user (MAX 255; MIN 1)" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } } } }, "examples": { "Full Refund": { "value": { "description": "Duplicate", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "AAB01-432245" } }, "Partial Refund": { "value": { "amount": { "currency": "COP", "value": 500 }, "description": "Duplicate", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "AAB01-432245" } }, "Cancel": { "value": { "description": "Duplicate", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "AAB01-432245" } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Full Refund": { "value": { "id": "7fd485f3-bd72-45eb-a3fb-774daa3d79b6", "type": "REFUND", "status": "REFUNDED", "category": "CARD", "amount": { "captured": 0, "currency": "COP", "refunded": 0, "value": 30000 }, "merchant_reference": "0000023", "created_at": "2024-06-06T14:06:06.284443Z", "updated_at": "2024-06-06T14:06:37.984065Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "status": "", "status_detail": "", "response_message": null, "response_code": "SUCCEEDED", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_request": { "amount": { "currency": "BRL", "value": 2100 }, "reference": "34343434" }, "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "c3583c27-0478-4e02-8827-4d8f2121c670", "account_id": "", "description": "Test", "country": "CO", "status": "REFUNDED", "sub_status": "REFUNDED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:06:06.284443Z", "updated_at": "2024-06-06T14:06:06.284443Z", "amount": { "captured": 0, "currency": "COP", "refunded": 30000, "value": 30000 }, "additional_data": { "airline": { "pnr": "1P-2UUGJW", "legs": [ { "departure_airport": "EZE", "departure_datetime": "2014-05-12 13:05:00", "departure_airport_timezone": "-03:00", "arrival_airport": "AMS", "arrival_airport_timezone": "+00:00", "arrival_datetime": "", "carrier_code": "KL", "flight_number": "842", "fare_basis_code": "HL7LNR", "fare_class_code": "FR", "base_fare": 200, "base_fare_currency": "BRL", "stopover_code": "s" } ], "passengers": [ { "first_name": "string", "last_name": "string", "middle_name": "string", "type": "s", "date_of_birth": "stringstri", "nationality": "st", "document": { "document_type": "CPF", "document_number": "351.040.753-97" }, "country": "st", "loyalty_number": "string", "loyalty_tier": "strin", "email": null, "phone": null } ], "ticket": null, "tickets": [ { "ticket_number": "123456", "e_ticket": false, "restricted": false, "total_fare_amount": 80, "total_tax_amount": 22, "total_fee_amount": 14, "issue": null } ] }, "order": { "fee_amount": 100, "shipping_amount": 100, "tip_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 29800, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456" } ] }, "seller_details": null } } } }, "Partial Refund": { "value": { "id": "e44cdc8e-01e7-4767-a1b6-3a646a609dc5", "type": "REFUND", "status": "SUCCEEDED", "category": "CARD", "amount": { "captured": 0, "currency": "COP", "refunded": 0, "value": 30000 }, "merchant_reference": "0000023", "created_at": "2024-06-06T14:07:53.881239Z", "updated_at": "2024-06-06T14:08:17.438878Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "status": "", "sub_status": "", "status_detail": "", "response_message": null, "response_code": "SUCCEEDED", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "eee7daeb-5ed7-41bd-8fee-7a440ca2ab86", "account_id": "", "description": "Test", "country": "CO", "status": "SUCCEEDED", "sub_status": "PARTIALLY_REFUNDED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:07:53.881239Z", "updated_at": "2024-06-06T14:07:53.881239Z", "amount": { "captured": 0, "currency": "COP", "refunded": 1000, "value": 30000 }, "additional_data": { "airline": { "pnr": "1P-2UUGJW", "legs": [ { "departure_airport": "EZE", "departure_datetime": "2014-05-12 13:05:00", "departure_airport_timezone": "-03:00", "arrival_airport": "AMS", "arrival_airport_timezone": "+00:00", "arrival_datetime": "", "carrier_code": "KL", "flight_number": "842", "fare_basis_code": "HL7LNR", "fare_class_code": "FR", "base_fare": 200, "base_fare_currency": "BRL", "stopover_code": "s" } ], "passengers": [ { "first_name": "string", "last_name": "string", "middle_name": "string", "type": "s", "date_of_birth": "stringstri", "nationality": "st", "document": { "document_type": "CPF", "document_number": "351.040.753-97" }, "country": "st", "loyalty_number": "string", "loyalty_tier": "strin", "email": null, "phone": null } ], "ticket": null, "tickets": [ { "ticket_number": "123456", "e_ticket": false, "restricted": false, "total_fare_amount": 80, "total_tax_amount": 22, "total_fee_amount": 14, "issue": null } ] }, "order": { "fee_amount": 100, "shipping_amount": 100, "tip_amount": null, "items": [ { "id": "123AD", "name": "Skirt", "quantity": 1, "unit_amount": 29800, "category": "Clothes", "brand": "XYZ", "sku_code": "8765432109", "manufacture_part_number": "XYZ123456" } ] }, "seller_details": null } } } }, "Cancel": { "value": { "id": "2fbc6db6-718b-4554-b03f-826e552f1b9f", "type": "CANCEL", "status": "SUCCEEDED", "category": "CARD", "amount": { "captured": 0, "currency": "COP", "refunded": 0, "value": 30000 }, "merchant_reference": "", "created_at": "2024-06-06T14:05:31.651012Z", "updated_at": "2024-06-06T14:05:31.742355Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "", "account_id": "", "status": "SUCCEEDED", "sub_status": "", "status_detail": "SUCCEEDED", "response_message": null, "response_code": "SUCCEEDED", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "cddba02c-e47d-4330-9cac-afcd9c0194b1", "account_id": "", "description": "Test", "country": "CO", "status": "CANCELED", "sub_status": "CANCELED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:04:44.768364Z", "updated_at": "2024-06-06T14:05:31.79539Z", "amount": { "captured": 0, "currency": "COP", "refunded": 0, "value": 30000 } } } } }, "schema": { "oneOf": [ { "title": "Full Refund", "type": "object", "properties": { "id": { "type": "string", "example": "7fd485f3-bd72-45eb-a3fb-774daa3d79b6" }, "type": { "type": "string", "example": "REFUND" }, "status": { "type": "string", "example": "REFUNDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:06:06.284443Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:06:37.984065Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "c3583c27-0478-4e02-8827-4d8f2121c670" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "CO" }, "status": { "type": "string", "example": "REFUNDED" }, "sub_status": { "type": "string", "example": "REFUNDED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:06:06.284443Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:06:06.284443Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "refunded": { "type": "integer", "example": 30000, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "1P-2UUGJW" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "EZE" }, "departure_datetime": { "type": "string", "example": "2014-05-12 13:05:00" }, "departure_airport_timezone": { "type": "string", "example": "-03:00" }, "arrival_airport": { "type": "string", "example": "AMS" }, "arrival_airport_timezone": { "type": "string", "example": "+00:00" }, "arrival_datetime": { "type": "string", "example": "" }, "carrier_code": { "type": "string", "example": "KL" }, "flight_number": { "type": "string", "example": "842" }, "fare_basis_code": { "type": "string", "example": "HL7LNR" }, "fare_class_code": { "type": "string", "example": "FR" }, "base_fare": { "type": "integer", "example": 200, "default": 0 }, "base_fare_currency": { "type": "string", "example": "BRL" }, "stopover_code": { "type": "string", "example": "s" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "string" }, "last_name": { "type": "string", "example": "string" }, "middle_name": { "type": "string", "example": "string" }, "type": { "type": "string", "example": "s" }, "date_of_birth": { "type": "string", "example": "stringstri" }, "nationality": { "type": "string", "example": "st" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CPF" }, "document_number": { "type": "string", "example": "351.040.753-97" } } }, "country": { "type": "string", "example": "st" }, "loyalty_number": { "type": "string", "example": "string" }, "loyalty_tier": { "type": "string", "example": "strin" }, "email": {}, "phone": {} } } }, "ticket": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "123456" }, "e_ticket": { "type": "boolean", "example": false, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 80, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 22, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 14, "default": 0 }, "issue": {} } } } } }, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 100, "default": 0 }, "shipping_amount": { "type": "integer", "example": 100, "default": 0 }, "tip_amount": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 29800, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" } } } } } }, "seller_details": {} } } } } } }, { "title": "Partial Refund", "type": "object", "properties": { "id": { "type": "string", "example": "e44cdc8e-01e7-4767-a1b6-3a646a609dc5" }, "type": { "type": "string", "example": "REFUND" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:07:53.881239Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:08:17.438878Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "status": { "type": "string", "example": "" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "eee7daeb-5ed7-41bd-8fee-7a440ca2ab86" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "CO" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "PARTIALLY_REFUNDED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:07:53.881239Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:07:53.881239Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "refunded": { "type": "integer", "example": 1000, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "1P-2UUGJW" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "EZE" }, "departure_datetime": { "type": "string", "example": "2014-05-12 13:05:00" }, "departure_airport_timezone": { "type": "string", "example": "-03:00" }, "arrival_airport": { "type": "string", "example": "AMS" }, "arrival_airport_timezone": { "type": "string", "example": "+00:00" }, "arrival_datetime": { "type": "string", "example": "" }, "carrier_code": { "type": "string", "example": "KL" }, "flight_number": { "type": "string", "example": "842" }, "fare_basis_code": { "type": "string", "example": "HL7LNR" }, "fare_class_code": { "type": "string", "example": "FR" }, "base_fare": { "type": "integer", "example": 200, "default": 0 }, "base_fare_currency": { "type": "string", "example": "BRL" }, "stopover_code": { "type": "string", "example": "s" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "string" }, "last_name": { "type": "string", "example": "string" }, "middle_name": { "type": "string", "example": "string" }, "type": { "type": "string", "example": "s" }, "date_of_birth": { "type": "string", "example": "stringstri" }, "nationality": { "type": "string", "example": "st" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CPF" }, "document_number": { "type": "string", "example": "351.040.753-97" } } }, "country": { "type": "string", "example": "st" }, "loyalty_number": { "type": "string", "example": "string" }, "loyalty_tier": { "type": "string", "example": "strin" }, "email": {}, "phone": {} } } }, "ticket": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "123456" }, "e_ticket": { "type": "boolean", "example": false, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 80, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 22, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 14, "default": 0 }, "issue": {} } } } } }, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 100, "default": 0 }, "shipping_amount": { "type": "integer", "example": 100, "default": 0 }, "tip_amount": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123AD" }, "name": { "type": "string", "example": "Skirt" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "unit_amount": { "type": "integer", "example": 29800, "default": 0 }, "category": { "type": "string", "example": "Clothes" }, "brand": { "type": "string", "example": "XYZ" }, "sku_code": { "type": "string", "example": "8765432109" }, "manufacture_part_number": { "type": "string", "example": "XYZ123456" } } } } } }, "seller_details": {} } } } } } }, { "title": "Cancel", "type": "object", "properties": { "id": { "type": "string", "example": "2fbc6db6-718b-4554-b03f-826e552f1b9f" }, "type": { "type": "string", "example": "CANCEL" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2024-06-06T14:05:31.651012Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:05:31.742355Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "SUCCEEDED" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "cddba02c-e47d-4330-9cac-afcd9c0194b1" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "CO" }, "status": { "type": "string", "example": "CANCELED" }, "sub_status": { "type": "string", "example": "CANCELED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:04:44.768364Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:05:31.79539Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } } } } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payments" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/payments/{payment_id}/transactions/{transaction_id}/capture": { "post": { "summary": "Capture Authorization", "description": "", "operationId": "capture-authorization", "parameters": [ { "name": "payment_id", "in": "path", "description": "The unique identifier of the payment (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "transaction_id", "in": "path", "description": "The unique identifier of the transaction (UUID, 36 chars)", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchant_reference", "reason", "amount" ], "properties": { "merchant_reference": { "type": "string", "description": "Identification of the payment transaction defined by the merchant (MAX 255; MIN 3)" }, "amount": { "type": "object", "description": "Specifies the amount object for capturing.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "description": "The payment amount (multiple of 0.0001).", "format": "float" } } }, "reason": { "type": "string", "description": "Indicating the reason for the capture. For example: PRODUCT_CONFIRMED and REQUESTED_BY_CUSTOMER." }, "additional_data": { "type": "object", "description": "Additional data to complement the payment capture", "properties": { "order": { "type": "object", "description": "Specifies the order object.", "properties": { "shipping_amount": { "type": "number", "description": "The shipping amount of the order (multiple of 0.0001)", "format": "float" }, "fee_amount": { "type": "number", "description": "The fee amount of the order (multiple of 0.0001)", "format": "float" }, "items": { "type": "array", "description": "Specifies the items array of object.", "items": { "properties": { "id": { "type": "string", "description": "The unique identifier of the item (MAX 255; MIN 3)." }, "name": { "type": "string", "description": "The name of the item (MAX 255; MIN 3)." }, "quantity": { "type": "integer", "description": "The quantity of the item.", "format": "int32" }, "unit_amount": { "type": "number", "description": "The unit amount of the item (multiple of 0.0001).", "format": "float" }, "category": { "type": "string", "description": "The category of the item. Check the [Item category reference](/reference/items-category-list).", "enum": [ "art", "baby", "coupons", "beauty_&_personal_care", "donations", "computing", "books", "grocery_&_gourmet_food", "cameras", "video_games", "television", "car_electronics", "electronics", "automotive", "toys_&_games", "musical_instruments", "handmade", "garden_&_outdoor", "entertainment", "industrial_&_scientific", "fashion", "games", "pet_supplies", "home", "musical", "phones", "services", "learnings", "tickets", "travels", "virtual_goods", "others" ] }, "brand": { "type": "string", "description": "The brand of the item (MAX 255; MIN 3)." }, "sku_code": { "type": "string", "description": "The stock keeping unit (SKU) of the item (MAX 255; MIN 3)." }, "manufacture_part_number": { "type": "string", "description": "The manufacture part number of the item" } }, "required": [ "id", "name", "quantity", "unit_amount" ], "type": "object" } } } }, "airline": { "type": "object", "description": "Specifies the airline object.", "properties": { "pnr": { "type": "string", "description": "Passenger name record (MAX 10; MIN 1)." }, "legs": { "type": "array", "description": "Specifies the legs array of objects.", "items": { "properties": { "departure_airport": { "type": "string", "description": "IATA code. See http://www.iata.org (MAX 3; MIN 3)." }, "departure_datetime": { "type": "string", "description": "The departure date and time in UTC time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), MAX 27; MIN 27).", "format": "date-time" }, "departure_airport_timezone": { "type": "string", "description": "Airport timezone (MAX 6; MIN 6)." }, "arrival_airport": { "type": "string", "description": "IATA airport code. See http://www.iata.org (MAX 3; MIN 3)." }, "carrier_code": { "type": "string", "description": "IATA carrier code. See http://www.iata.org (MAX 2; MIN 2)." }, "flight_number": { "type": "string", "description": "The flight number assigned by the airline carrier (MAX 5; MIN 1)." }, "fare_basis_code": { "type": "string", "description": "Code base rate provides specific information on the fare in addition to the class service, both required for booking (MAX 15; MIN 1)." }, "fare_class_code": { "type": "string", "description": "The fare class code of the airline (MAX 1; MIN 1). The values can be a letter (A-Z) but may vary depending on the airline's definition. Check the [Airline information reference](/reference/airline-information#fare-class-code).", "enum": [ "F", "FR", "B", "CR", "Y", "YD" ] }, "base_fare": { "type": "number", "description": "The transaction amount, excluding taxes and fees, the smallest unit of currency (multipleOf 0.0001).", "format": "float" }, "base_fare_currency": { "type": "string", "description": "The currency used to transaction amount (MAX 3; MIN 3; [ISO 4217](country-reference))." }, "stopover_code": { "type": "string", "description": "1-letter code that indicates whether the passenger is allowed to make a stopover. Only two types of characters are allowed: O: Stopover allowed (the letter “O”, not zero) / X: Stopover not allowed. (MAX 1; MIN 1)" } }, "required": [ "departure_airport", "departure_datetime", "departure_airport_timezone", "arrival_airport", "carrier_code", "flight_number", "fare_basis_code", "fare_class_code" ], "type": "object" } }, "passengers": { "type": "array", "description": "Specifies the passengers array of objects associated to the tickets.", "items": { "properties": { "first_name": { "type": "string", "description": "The passenger first name (MAX 255; MIN 3)." }, "last_name": { "type": "string", "description": "The passenger last name (MAX 255; MIN 3)" }, "middle_name": { "type": "string", "description": "The passenger middle name (MAX 255; MIN 3)." }, "type": { "type": "string", "description": "The passenger type (MAX 1; MIN 1). Check the [Airline information reference](/reference/airline-information#passenger-type).", "enum": [ "A", "C", "I" ] }, "date_of_birth": { "type": "string", "description": "The passenger date of birth in the YYYY-MM-DD (MAX 10; MIN 10).", "format": "date" }, "nationality": { "type": "string", "description": "The passenger nationality (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "document": { "type": "object", "description": "Specifies the passengers' document object.", "properties": { "document_number": { "type": "string", "description": "Document number for passenger (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "The passenger's document type (MAX 6, MIN 2; ([Country reference](country-reference))).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] }, "country": { "type": "string", "description": "Country where the document was issued (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] } } }, "loyalty_number": { "type": "string", "description": "Number of passenger loyalty program." }, "loyalty_tier": { "type": "string", "description": "Tier of passenger loyalty program. Check the [Airline information reference](/reference/airline-information#loyalty-tier).", "enum": [ "1", "2", "3" ] }, "phone": { "type": "object", "description": "Specifies the phone object for the passenger." } }, "type": "object" } }, "tickets": { "type": "array", "description": "Specifies the array of ticket objects associated to the passengers.", "items": { "properties": { "ticket_number": { "type": "string", "description": "Ticket number (MAX 14; MIN 1)." }, "e_ticket": { "type": "boolean", "description": "Is this an e-ticket? (true) (false)." }, "restricted": { "type": "boolean", "description": "Indicates if the ticket is refunfable or not (true/false)" }, "total_fare_amount": { "type": "number", "description": "Total fare amount in the smallest unit of currency (multiple of 0.0001).", "format": "float" }, "total_tax_amount": { "type": "number", "description": "Total taxes amount in the smallest unit of currency (multiple of 0.0001).", "format": "float" }, "total_fee_amount": { "type": "number", "description": "Total fee amount in the smallest unit of currency (multiple of 0.0001).", "format": "float" }, "issue": { "type": "object", "description": "Specifies the issue object.", "properties": { "carrier_prefix_code": { "type": "string", "description": "Issuing or Validating carrier. This is the AWB Prefix (Air waybill) 3-numeric code (MAX 3; MIN 3)." }, "travel_agent_code": { "type": "string", "description": "Code of the travel agent issuing the ticket (MAX 9; MIN 8)." }, "travel_agent_name": { "type": "string", "description": "The name under which the point of sale appears on the agency list or franchise name (MAX 32; MIN 1)." }, "date": { "type": "string", "description": "Ticket issuing date (MAX 27; MIN 27).", "format": "date-time" }, "address": { "type": "string", "description": "Address of the agent whose sold the ticket (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "City name of the agent whose sold the ticket (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "Country code alpha 2 where the ticket was issued (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] } } } }, "type": "object" } } } }, "seller_details": { "type": "object", "description": "Specifies the seller's details object.", "properties": { "name": { "type": "string", "description": "The seller's legal name (MAX 255; MIN 3)." }, "email": { "type": "string", "description": "The seller's e-mail (MAX 255; MIN 3)." }, "reference": { "type": "number", "description": "The seller's identification code (MAX 255; MIN 3).", "format": "float" }, "website": { "type": "string", "description": "The seller's website URL (MAX 255; MIN 3)." }, "industry": { "type": "string", "description": "The seller's industry (MAX 235; MIN 1) For more information access the [Industry category reference page](/reference/industry-category-list)." }, "merchant_category_code": { "type": "string", "description": "MCC - The merchant category code (MAX 235; MIN 1)." }, "country": { "type": "string", "description": "The seller's country (MAX 255; MIN 3; [ISO 3166-1](/reference/country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "document": { "type": "object", "description": "Specifies the document object of the seller.", "properties": { "document_number": { "type": "string", "description": "The seller's document number (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "The seller's document type (MAX 6, MIN 2; [Document Type List](/reference/country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC", "" ] } } }, "phone": { "type": "object", "description": "Specifies the seller's phone number object.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the seller's phone (MAX 3; MIN 1). Check the [Country reference](country-reference) to see the phone codes." }, "number": { "type": "string", "description": "The seller's phone number, without the country code (MAX 32; MIN 1)." } } }, "address": { "type": "object", "description": "Specifies the seller's address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary address line of the seller (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the seller (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the seller's address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the seller's address (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "state": { "type": "string", "description": "The state considered for the seller's address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the seller's address (MAX 11; MIN 4)." } } } } } } }, "simplified_mode": { "type": "boolean", "description": "Determines whether Yuno should automatically attempt to capture a payment after an initial error or decline. When set to `true`, Yuno will retry the process if the first attempt fails. By default, this is set to `false`. Access [Transaction Retries](https://docs.y.uno/docs/transaction-retries) for more details." } } }, "examples": { "Full Capture": { "value": { "amount": { "currency": "USD", "value": 30000 }, "description": "Confirmed", "reason": "PRODUCT_CONFIRMED", "merchant_reference": "AAB01-432245" } }, "Card Direct (with Airline Data)": { "value": { "merchant_reference": "EJEMPLO_DE_REFERENCIA", "amount": { "currency": "USD", "value": "2000" }, "reason": "PRODUCT_CONFIRMED", "additional_data": { "airline": { "pnr": "ABC123", "legs": [ { "departure_airport": "JFK", "departure_datetime": "2023-10-31T01:30:00.000-05:00", "departure_airport_timezone": "GMT-05", "arrival_airport": "LAX", "carrier_code": "AA", "flight_number": "AA348", "fare_basis_code": "Y", "fare_class_code": "S", "base_fare": 18000, "base_fare_currency": "USD", "stopover_code": "O" } ], "passengers": [ { "first_name": "JOHN", "last_name": "DOE", "middle_name": "STEPHEN", "type": "A", "date_of_birth": "1998-01-01", "nationality": "US", "document": { "document_number": "123456789", "document_type": "PASSPORT", "country": "US" }, "loyalty_number": "79250001", "loyalty_tier": "DIAMOND" } ], "tickets": [ { "ticket_number": "AA0001", "e_ticket": true, "restricted": false, "total_fare_amount": 20000, "total_tax_amount": 18000, "total_fee_amount": 1000, "issue": { "carrier_prefix_code": "AA", "travel_agent_code": "A104121", "travel_agent_name": "TRAVELPRO", "date": "2023-10-31T01:30:00.000-05:00", "address": "123 Main Street", "city": "NEW YORK", "country": "US", "zip_code": "10001" } } ] } } } }, "Partial Capture": { "value": { "amount": { "currency": "USD", "value": 3000 }, "description": "Confirmed Partially", "reason": "PRODUCT_CONFIRMED", "merchant_reference": "AAB01-432245" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Full Capture": { "value": { "id": "89fd7fd0-951d-4335-ad1b-ef899a79630d", "type": "CAPTURE", "status": "SUCCEEDED", "category": "CARD", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 30000 }, "merchant_reference": "AAB01-432245", "created_at": "2024-06-06T14:26:41.535489Z", "updated_at": "2024-06-06T14:26:41.615608Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "1173513e-2422-4ba0-ba40-fd568a4904f9", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "status": "SUCCEEDED", "status_detail": "", "response_message": "Transaction successful", "response_code": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_request": { "amount": { "currency": "BRL", "value": 2100 }, "reference": "34343434" }, "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "af170f9d-e8c1-47e4-a988-25535e0f88a1", "account_id": "", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "CAPTURED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:26:22.933194Z", "updated_at": "2024-06-06T14:26:41.655119Z", "amount": { "captured": 30000, "currency": "USD", "refunded": 0, "value": 30000 }, "additional_data": { "airline": null, "order": null, "seller_details": null } } } }, "CARD DIRECT (with Airline Data)": { "value": { "id": "230292dd-b3e9-41e4-ae09-0a54e2f7a6d4", "type": "CAPTURE", "status": "SUCCEEDED", "category": "CARD", "amount": { "currency": "USD", "value": 20000, "refunded": 0, "captured": 0 }, "merchant_reference": "EJEMPLO_DE_REFERENCIA", "created_at": "2023-04-27T02:51:52.213075Z", "updated_at": "2023-04-27T02:51:52.284381Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "a9a47e01-2dc1-4d5f-af23-11ab7164cd03", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "status": "SUCCEEDED", "status_detail": "", "response_message": "Transaction successful", "response_code": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "637dffe9-5d18-4cdc-a5bf-95b8cd12bbd5", "account_id": "", "description": "SUCCESSFUL", "country": "US", "status": "SUCCEEDED", "sub_status": "CAPTURED", "merchant_order_id": "Order_id", "created_at": "2023-04-27T02:51:24.470834Z", "updated_at": "2023-04-27T02:51:52.312297Z", "amount": { "value": 20000, "captured": 20000, "refunded": 0, "currency": "USD" }, "additional_data": { "airline": { "pnr": "ABC123", "legs": [ { "departure_airport": "BOG", "departure_datetime": "2023-10-31T01:30:00.000-05:00", "departure_airport_timezone": "GMT-05", "arrival_airport": "BOM", "carrier_code": "PR", "flight_number": "AV348", "fare_basis_code": "Y", "fare_class_code": "S", "base_fare": 18000, "base_fare_currency": "USD", "stopover_code": "O" } ], "passengers": [ { "first_name": "JOHN", "last_name": "DOE", "middle_name": "STEPHEN", "type": "A", "date_of_birth": "1998-01-01", "nationality": "US", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "country": null, "loyalty_number": "79250001", "loyalty_tier": "DIAMOND" } ], "tickets": [ { "ticket_number": "BRB0001", "e_ticket": true, "restricted": false, "total_fare_amount": 20000, "total_tax_amount": 18000, "total_fee_amount": 1000, "issue": { "carrier_prefix_code": "134", "travel_agent_code": "A104121", "travel_agent_name": "AEROVIAJES", "date": "2023-10-31T01:30:00.000-05:00", "address": "123 Main Street", "city": "New York", "country": "US", "zip_code": "10001" } } ] }, "order": null, "seller_details": null } } } }, "Partial Capture": { "value": { "id": "c8104f4b-30d6-476f-8e6b-49daa110e31f", "type": "CAPTURE", "status": "SUCCEEDED", "category": "CARD", "amount": { "captured": 0, "currency": "USD", "refunded": 0, "value": 3000 }, "merchant_reference": "AAB01-432245", "created_at": "2024-06-06T14:27:53.594183Z", "updated_at": "2024-06-06T14:27:53.705858Z", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "a9a47e01-2dc1-4d5f-af23-11ab7164cd03", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "status": "SUCCEEDED", "status_detail": "", "response_message": "Transaction successful", "response_code": "", "iso8583_response_code": "00", "iso8583_response_message": "Approved or completed successfully", "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "payment": { "id": "60915b59-e403-4c00-8404-15ececa9b5dd", "account_id": "", "description": "Test", "country": "US", "status": "SUCCEEDED", "sub_status": "PARTIALLY_CAPTURED", "merchant_order_id": "0000023", "created_at": "2024-06-06T14:27:22.8355Z", "updated_at": "2024-06-06T14:27:53.74127Z", "amount": { "captured": 3000, "currency": "USD", "refunded": 0, "value": 30000 }, "additional_data": { "airline": null, "order": null, "seller_details": null } } } } }, "schema": { "oneOf": [ { "title": "Full Capture", "type": "object", "properties": { "id": { "type": "string", "example": "89fd7fd0-951d-4335-ad1b-ef899a79630d" }, "type": { "type": "string", "example": "CAPTURE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "AAB01-432245" }, "created_at": { "type": "string", "example": "2024-06-06T14:26:41.535489Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:26:41.615608Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "1173513e-2422-4ba0-ba40-fd568a4904f9" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "Transaction successful" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "af170f9d-e8c1-47e4-a988-25535e0f88a1" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "CAPTURED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:26:22.933194Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:26:41.655119Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 30000, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": {}, "seller_details": {} } } } } } }, { "title": "CARD DIRECT (with Airline Data)", "type": "object", "properties": { "id": { "type": "string", "example": "230292dd-b3e9-41e4-ae09-0a54e2f7a6d4" }, "type": { "type": "string", "example": "CAPTURE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 20000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "captured": { "type": "integer", "example": 0, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "EJEMPLO_DE_REFERENCIA" }, "created_at": { "type": "string", "example": "2023-04-27T02:51:52.213075Z" }, "updated_at": { "type": "string", "example": "2023-04-27T02:51:52.284381Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "a9a47e01-2dc1-4d5f-af23-11ab7164cd03" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "Transaction successful" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "637dffe9-5d18-4cdc-a5bf-95b8cd12bbd5" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "SUCCESSFUL" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "CAPTURED" }, "merchant_order_id": { "type": "string", "example": "Order_id" }, "created_at": { "type": "string", "example": "2023-04-27T02:51:24.470834Z" }, "updated_at": { "type": "string", "example": "2023-04-27T02:51:52.312297Z" }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 20000, "default": 0 }, "captured": { "type": "integer", "example": 20000, "default": 0 }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "ABC123" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "departure_airport": { "type": "string", "example": "BOG" }, "departure_datetime": { "type": "string", "example": "2023-10-31T01:30:00.000-05:00" }, "departure_airport_timezone": { "type": "string", "example": "GMT-05" }, "arrival_airport": { "type": "string", "example": "BOM" }, "carrier_code": { "type": "string", "example": "PR" }, "flight_number": { "type": "string", "example": "AV348" }, "fare_basis_code": { "type": "string", "example": "Y" }, "fare_class_code": { "type": "string", "example": "S" }, "base_fare": { "type": "integer", "example": 18000, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "O" } } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "example": "JOHN" }, "last_name": { "type": "string", "example": "DOE" }, "middle_name": { "type": "string", "example": "STEPHEN" }, "type": { "type": "string", "example": "A" }, "date_of_birth": { "type": "string", "example": "1998-01-01" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "country": {}, "loyalty_number": { "type": "string", "example": "79250001" }, "loyalty_tier": { "type": "string", "example": "DIAMOND" } } } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "BRB0001" }, "e_ticket": { "type": "boolean", "example": true, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 20000, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 18000, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 1000, "default": 0 }, "issue": { "type": "object", "properties": { "carrier_prefix_code": { "type": "string", "example": "134" }, "travel_agent_code": { "type": "string", "example": "A104121" }, "travel_agent_name": { "type": "string", "example": "AEROVIAJES" }, "date": { "type": "string", "example": "2023-10-31T01:30:00.000-05:00" }, "address": { "type": "string", "example": "123 Main Street" }, "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" } } } } } } } }, "order": {}, "seller_details": {} } } } } } }, { "title": "Partial Capture", "type": "object", "properties": { "id": { "type": "string", "example": "c8104f4b-30d6-476f-8e6b-49daa110e31f" }, "type": { "type": "string", "example": "CAPTURE" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 3000, "default": 0 } } }, "merchant_reference": { "type": "string", "example": "AAB01-432245" }, "created_at": { "type": "string", "example": "2024-06-06T14:27:53.594183Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:27:53.705858Z" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "a9a47e01-2dc1-4d5f-af23-11ab7164cd03" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "status": { "type": "string", "example": "SUCCEEDED" }, "status_detail": { "type": "string", "example": "" }, "response_message": { "type": "string", "example": "Transaction successful" }, "response_code": { "type": "string", "example": "" }, "iso8583_response_code": { "type": "string", "example": "00" }, "iso8583_response_message": { "type": "string", "example": "Approved or completed successfully" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {} } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "60915b59-e403-4c00-8404-15ececa9b5dd" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "PARTIALLY_CAPTURED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2024-06-06T14:27:22.8355Z" }, "updated_at": { "type": "string", "example": "2024-06-06T14:27:53.74127Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 3000, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "additional_data": { "type": "object", "properties": { "airline": {}, "order": {}, "seller_details": {} } } } } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payments" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/payments/{payment_id}/transactions/{transaction_id}/dispute": { "post": { "summary": "Dispute a chargeback", "description": "", "operationId": "disputes", "parameters": [ { "name": "payment_id", "in": "path", "description": "The unique identifier of the payment (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "transaction_id", "in": "path", "description": "The unique identifier of the transaction (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "evidence" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account (UUID, 36 chars)." }, "evidence": { "type": "array", "description": "The evidence files object", "items": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the documentation sent (MAX 255; MIN 3)." }, "content_type": { "type": "string", "description": "The type of the documentation sent by the merchant", "enum": [ "application/pdf" ] }, "content_category": { "type": "string", "description": "The category of the documentation sent by the merchant", "enum": [ "CANCEL_POLICY", "CUSTOMER_INTERACTION", "OTHERS", "PAYMENT_DETAIL", "PROOF_OF_AUTHENTICITY", "PROOF_OF_DELIVERY", "PROOF_OF_SERVICE", "RECEIPT", "REFUND_POLICY", "SERVICE_AGREEMENT", "TERMS_AND_CONDITIONS" ] }, "content": { "type": "string", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 1MB." } }, "required": [ "file_name", "content_type", "content_category", "content" ] } } } }, "examples": { "Request Example": { "value": { "account_id": "", "evidence": [ { "content_type": "application/pdf", "file_name": "Receipt_AA001", "content_category": "RECEIPT", "content": "0MTGCjMgMCBvYmoKPDwgL0ZpbHRlcJVBERi0xLjMKJcTl8uXrp/Og ..." } ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success": { "summary": "Success", "value": { "id": "b001d824-3f3f-48fc-98ef-a3114b918c1e", "account_id": "210a524f-7ad3-437a-be7e-9e99bdf4d742", "description": "Test Purchase", "country": "AR", "status": "IN_DISPUTE", "sub_status": "PENDING_REVIEW", "merchant_order_id": "65742358", "created_at": "2025-11-26T20:34:08.330622Z", "updated_at": "2025-11-26T20:34:12.580560Z", "amount": { "captured": 0, "currency": "ARS", "currency_conversion": null, "refunded": 0, "value": 2000 }, "checkout": null, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": null, "installment_amount": null, "installments_total_amount": null, "soft_descriptor": "", "authorization_code": "393119", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Diaz", "iin": "45130761", "lfd": "5348", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "BANCOLOMBIA", "issuer_code": null, "country_code": "CO", "category": "CLASSIC", "type": "CREDIT", "fingerprint": "2213e58a-33d7-4bdc-8cbe-4785f683c410", "expiration_month": 6, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "1b9ef2f7-b69e-4dd0-b0a1-3605dfc2ad2f", "merchant_customer_id": "6a1b6e7e0e104f28929015fd6182e9f9", "first_name": "Margarita", "last_name": "Parra", "gender": "NB", "date_of_birth": "1952-02-27", "email": "qpacheco@example.com", "nationality": "AR", "ip_address": "205.52.88.44", "device_fingerprint": "90ede54c-d2d4-4e2e-8189-6b81091231b0", "device_fingerprints": [ { "provider_id": "DEFAULT", "id": "90ede54c-d2d4-4e2e-8189-6b81091231b0" }, { "provider_id": "CLEAR_SALE", "id": "c1c4907c-3339-4217-a4bd-1e9be74b3819" }, { "provider_id": "CYBERSOURCE", "id": "d5c56387-4d06-479b-b55b-eab81e5211bc" }, { "provider_id": "OPENPAY", "id": "89451345904503181146447710703990" }, { "provider_id": "MERCADO_PAGO", "id": "armor.cofxzlvhsrpuslf5ychwxvszwaicsanbuub2on7rfuzmyfijppqm8vcziky3h3emxkz3b2aopl04ublu0jufbtwk8sm232fin19btcnd3q1jdpku6cp9ybn8exc2vcuoalosq51bpfefzhsqx4tuythte5jaruh4keo2fcm9r9wwy96s8djk0e5nmsi8z6pfi7e94tsoe7h09s227umko9kyf4p0xanqn" } ], "browser_info": { "user_agent": "Chrome", "accept_header": "true", "accept_content": "true", "accept_browser": "true", "color_depth": "red", "screen_height": "500", "screen_width": "100", "javascript_enabled": true, "java_enabled": true, "browser_time_difference": "-3:00", "language": "es", "platform": null }, "document": { "document_type": "DNI", "document_number": "82183204" }, "phone": { "number": "91112345678", "country_code": "54" }, "billing_address": { "address_line_1": "Avenida Putumayo 1780", "address_line_2": "Diagonal 181G 6572", "country": "AR", "state": "Álava", "city": "Suárez", "zip_code": "25207", "neighborhood": "Barrio Núñez" }, "shipping_address": { "address_line_1": "Diagonal 61 2487", "address_line_2": "Av. carrera 54 7627", "country": "AR", "state": "Guipúzcoa", "city": "San Benito", "zip_code": "31718", "neighborhood": "Villa La Esperanza" }, "merchant_customer_created_at": "2025-11-26T20:34:06.941Z", "geolocation": { "latitude": "80.00", "longitude": "103.00" } }, "additional_data": { "airline": { "pnr": "ABC123", "legs": [ { "order": null, "route_order": null, "passenger_id": null, "departure_airport": "JFK", "departure_datetime": "2024-07-03T05:00:00", "departure_airport_timezone": "GMT-05", "arrival_airport": "LAX", "arrival_airport_timezone": "+00:00", "arrival_datetime": "2030-07-03T22:59:00", "carrier_code": "AA", "flight_number": "123", "fare_basis_code": "Y", "fare_class_code": "S", "base_fare": 1800, "base_fare_currency": "USD", "stopover_code": "O", "departure_airport_country": "NL", "departure_airport_city": "Amsterdam", "arrival_airport_country": "AR", "arrival_airport_city": "Buenos aires", "expedited_boarding": null, "extra_baggage": null, "purchased_meals": null, "selected_seat": null } ], "passengers": [ { "id": null, "first_name": "Antonio", "last_name": "Vargas", "middle_name": "Piedad", "type": "A", "date_of_birth": "1999-12-17", "nationality": "US", "document": { "document_type": "DNI", "document_number": "82183204" }, "country": "CO", "loyalty_number": "79250001", "loyalty_tier": "DIAMOND", "email": "anaarias@example.com", "phone": { "number": "91112345678", "country_code": "54" }, "address": null, "evidence_document_source": null }, { "id": null, "first_name": "Álvaro", "last_name": "Bravo", "middle_name": "Edwin", "type": "C", "date_of_birth": "1973-07-25", "nationality": "CO", "document": { "document_type": "DNI", "document_number": "82183204" }, "country": "CO", "loyalty_number": "79250002", "loyalty_tier": "SILVER", "email": "leidysanchez@example.com", "phone": { "number": "91112345678", "country_code": "54" }, "address": null, "evidence_document_source": null } ], "type": null, "ticket": { "ticket_number": "BRB0001", "passenger_id": null, "e_ticket": true, "restricted": false, "total_fare_amount": 2000, "total_tax_amount": 180, "total_fee_amount": 20, "issue": { "carrier_prefix_code": "AA", "travel_agent_code": "A12345", "travel_agent_name": "TRAVEL AGENCY", "date": "2023-10-31", "address": "123 Main St", "city": "New York", "country": "US", "zip_code": "10001", "booking_system_code": "1G", "booking_system_name": "Galileo" } }, "tickets": [ { "ticket_number": "BRB0001", "passenger_id": null, "e_ticket": true, "restricted": false, "total_fare_amount": 2000, "total_tax_amount": 180, "total_fee_amount": 20, "issue": { "carrier_prefix_code": "AA", "travel_agent_code": "A12345", "travel_agent_name": "TRAVEL AGENCY", "date": "2023-10-31", "address": "123 Main St", "city": "New York", "country": "US", "zip_code": "10001", "booking_system_code": "1G", "booking_system_name": "Galileo" } } ] }, "transportations": null, "order": { "fee_amount": 1, "shipping_amount": 3, "tip_amount": 2, "items": [ { "id": "97029", "name": "SKIRT", "quantity": 3, "unit_amount": 2000, "category": "OTHERS", "brand": "Barrera Group", "sku_code": "SC-01905", "manufacture_part_number": "MPN-70919" }, { "id": "61906", "name": "SKIRT", "quantity": 1, "unit_amount": 2000, "category": "OTHERS", "brand": "Suárez-Castellanos", "sku_code": "SC-14444", "manufacture_part_number": "MPN-43825" } ], "taxes": [ { "type": "VAT", "tax_base": 100, "value": 10, "percentage": 10 } ], "shipping": { "type": "ELECTRONIC", "description": "q4O6W8x8ONwpbgHjlxlz", "carrier": "AR_OCA", "deliver_at": "2025-11-26T20:34:07.500866Z", "recipients": [] }, "account_funding": { "sender": { "national_entity": null, "first_name": "Reinaldo", "last_name": "Rojas", "legal_name": null, "email": null, "country": null, "date_of_birth": null, "document": null, "phone": null, "address": null }, "beneficiary": { "national_entity": null, "first_name": "Leidy", "last_name": "González", "legal_name": null, "email": null, "country": "AR", "date_of_birth": "1983-12-07", "document": null, "phone": { "number": "91112345678", "country_code": "54" }, "address": { "address_line_1": "Calle 4ª 3050", "address_line_2": "Carrera 98 6425", "country": "AR", "city": "", "zip_code": "", "neighborhood": "Barrio Colegiales" } } }, "tickets": [ { "id": "57bfc6e7-c270-4fcc-a578-a76e6eaa4576", "name": "Ticket vitae", "description": "Description 4I%n", "type": "VIRTUAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "3e9d0621-e8ca-4415-9025-95d568cac569", "name": "Event doloremque", "description": "Description ipsam", "type": "CIRCUS", "date": "2025-11-26", "address": { "address_line_1": "Diagonal 33 2395", "address_line_2": "Cl. 112E 6497", "city": "Paz de Ariporo", "country": "AR", "state": "Lleida", "zip_code": "18124", "neighborhood": "Conjunto Los Laureles" } } }, { "id": "f842ae67-2f7d-4415-9d9e-9a51d2712c13", "name": "Ticket aspernatur", "description": "Description jS3*", "type": "VIRTUAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "af726450-abf5-49d1-b43a-9e65f88d606e", "name": "Event officia", "description": "Description quo", "type": "CIRCUS", "date": "2025-11-26", "address": { "address_line_1": "Tr. 194B 459", "address_line_2": "Cl. 102L Sur 2950", "city": "Moniquirá", "country": "AR", "state": "Segovia", "zip_code": "31278", "neighborhood": "Barrio Los Olivos" } } }, { "id": "51100a8e-04ec-45c1-8fea-2fa70a7966d3", "name": "Ticket hic", "description": "Description mR;2", "type": "PHYSICAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "2164fb39-7be3-46aa-adc9-310eb33b4f05", "name": "Event hic", "description": "Description beatae", "type": "SPORTS", "date": "2025-11-26", "address": { "address_line_1": "Av. Pérez 8882", "address_line_2": "Carrera 23 5900", "city": "Vijes", "country": "AR", "state": "Zamora", "zip_code": "24300", "neighborhood": "Barrio El Paraíso" } } }, { "id": "6f465375-0ded-4ac7-848c-39450bff069d", "name": "Ticket totam", "description": "Description t0}E", "type": "VIRTUAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "e564bf42-0385-4ad8-a38a-eb481a434cbf", "name": "Event neque", "description": "Description facilis", "type": "OTHERS", "date": "2025-11-26", "address": { "address_line_1": "Avenida carrera 153 3115", "address_line_2": "Cr. 121G Bis 4048", "city": "La Ceja", "country": "AR", "state": "Castellón", "zip_code": "39464", "neighborhood": "Conjunto Belgrano" } } }, { "id": "b40b5fb7-3a1b-4315-bf01-4ba9b7ef99aa", "name": "Ticket esse", "description": "Description wI2;", "type": "VIRTUAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "a4f1f47f-8853-4ac2-b574-6b05d4a611fd", "name": "Event eos", "description": "Description natus", "type": "CINEMA", "date": "2025-11-26", "address": { "address_line_1": "Cr. 6E Bis 3665", "address_line_2": "Carrera 9 Este 1918", "city": "Teorama", "country": "AR", "state": "Madrid", "zip_code": "32993", "neighborhood": "Villa Las Flores" } } } ], "fulfillment": null, "discounts": [ { "id": "10FF", "name": "10% Discount", "unit_amount": 10 } ], "sales_channel": "marketplace" }, "seller_details": { "name": "Mendoza-Cerón", "website": "http://navarro.info/category/postsregister.html", "email": "iospina@example.net", "address": { "address_line_1": "Av. calle 5ª 3906", "address_line_2": "Dg. 8ª 8965", "country": "AR", "state": "ARGENTINA", "city": "Curití", "zip_code": "15484" }, "reference": "39245884", "country": "AR", "phone": { "number": "6844503463", "country_code": "23" }, "document": { "document_type": "DNI", "document_number": "82183204" }, "industry": "ELECTRONICS", "merchant_category_code": "6628" } }, "transactions": { "id": "4a963490-70c2-4669-975a-a6901b4b5abf", "type": "CHARGEBACK", "status": "CREATED", "category": "CARD", "amount": 2000, "provider_id": "BAMBOO", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": null, "installment_amount": null, "installments_total_amount": null, "soft_descriptor": "", "authorization_code": "393119", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "Pepito Perez", "iin": "45130761", "lfd": "5348", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "BANCOLOMBIA", "issuer_code": null, "country_code": "CO", "category": "CLASSIC", "type": "CREDIT", "fingerprint": "2213e58a-33d7-4bdc-8cbe-4785f683c410", "expiration_month": 6, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "CHARGEBACK_CREATED", "reason": "REQUESTED_BY_CUSTOMER", "description": "webhook transaction", "merchant_reference": "Reference-ac04c8a6-78c7-4588-b915-5498455369ef", "provider_data": { "id": "BAMBOO", "transaction_id": "121030201030210312", "account_id": "", "status": "APPROVED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null, "merchant_advice_code": null, "merchant_advice_code_message": null, "reason_code": null, "reason_description": null }, "connection_data": { "id": null, "name": null }, "created_at": "2025-11-26T20:34:12.529203Z", "updated_at": "2025-11-26T20:34:12.559289Z", "merchant_advice_code": null, "merchant_advice_code_message": null }, "transactions_history": null, "split_marketplace": [], "callback_url": "https://example.com/callback", "workflow": "DIRECT", "metadata": [ { "key": "explicabo", "value": "nihil" }, { "key": "quas", "value": "veritatis" }, { "key": "numquam", "value": "placeat" }, { "key": "eos", "value": "quo" }, { "key": "corrupti", "value": "eveniet" }, { "key": "occaecati", "value": "consectetur" } ], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 64972, "name": null, "description": null } }, "simplified_mode": false } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "b001d824-3f3f-48fc-98ef-a3114b918c1e" }, "account_id": { "type": "string", "example": "210a524f-7ad3-437a-be7e-9e99bdf4d742" }, "description": { "type": "string", "example": "Test Purchase" }, "country": { "type": "string", "example": "AR" }, "status": { "type": "string", "example": "IN_DISPUTE" }, "sub_status": { "type": "string", "example": "PENDING_REVIEW" }, "merchant_order_id": { "type": "string", "example": "65742358" }, "created_at": { "type": "string", "example": "2025-11-26T20:34:08.330622Z" }, "updated_at": { "type": "string", "example": "2025-11-26T20:34:12.580560Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "ARS" }, "currency_conversion": {}, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 2000, "default": 0 } } }, "checkout": {}, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "parent_payment_method_type": {}, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": {}, "installment_amount": {}, "installments_total_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "393119" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Diaz" }, "iin": { "type": "string", "example": "45130761" }, "lfd": { "type": "string", "example": "5348" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "BANCOLOMBIA" }, "issuer_code": {}, "country_code": { "type": "string", "example": "CO" }, "category": { "type": "string", "example": "CLASSIC" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "2213e58a-33d7-4bdc-8cbe-4785f683c410" }, "expiration_month": { "type": "integer", "example": 6, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "1b9ef2f7-b69e-4dd0-b0a1-3605dfc2ad2f" }, "merchant_customer_id": { "type": "string", "example": "6a1b6e7e0e104f28929015fd6182e9f9" }, "first_name": { "type": "string", "example": "Margarita" }, "last_name": { "type": "string", "example": "Parra" }, "gender": { "type": "string", "example": "NB" }, "date_of_birth": { "type": "string", "example": "1952-02-27" }, "email": { "type": "string", "example": "qpacheco@example.com" }, "nationality": { "type": "string", "example": "AR" }, "ip_address": { "type": "string", "example": "205.52.88.44" }, "device_fingerprint": { "type": "string", "example": "90ede54c-d2d4-4e2e-8189-6b81091231b0" }, "device_fingerprints": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "example": "DEFAULT" }, "id": { "type": "string", "example": "90ede54c-d2d4-4e2e-8189-6b81091231b0" } } } }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "Chrome" }, "accept_header": { "type": "string", "example": "true" }, "accept_content": { "type": "string", "example": "true" }, "accept_browser": { "type": "string", "example": "true" }, "color_depth": { "type": "string", "example": "red" }, "screen_height": { "type": "string", "example": "500" }, "screen_width": { "type": "string", "example": "100" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": { "type": "boolean", "example": true, "default": true }, "browser_time_difference": { "type": "string", "example": "-3:00" }, "language": { "type": "string", "example": "es" }, "platform": {} } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "DNI" }, "document_number": { "type": "string", "example": "82183204" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "91112345678" }, "country_code": { "type": "string", "example": "54" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Avenida Putumayo 1780" }, "address_line_2": { "type": "string", "example": "Diagonal 181G 6572" }, "country": { "type": "string", "example": "AR" }, "state": { "type": "string", "example": "Álava" }, "city": { "type": "string", "example": "Suárez" }, "zip_code": { "type": "string", "example": "25207" }, "neighborhood": { "type": "string", "example": "Barrio Núñez" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Diagonal 61 2487" }, "address_line_2": { "type": "string", "example": "Av. carrera 54 7627" }, "country": { "type": "string", "example": "AR" }, "state": { "type": "string", "example": "Guipúzcoa" }, "city": { "type": "string", "example": "San Benito" }, "zip_code": { "type": "string", "example": "31718" }, "neighborhood": { "type": "string", "example": "Villa La Esperanza" } } }, "merchant_customer_created_at": { "type": "string", "example": "2025-11-26T20:34:06.941Z" }, "geolocation": { "type": "object", "properties": { "latitude": { "type": "string", "example": "80.00" }, "longitude": { "type": "string", "example": "103.00" } } } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "ABC123" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "order": {}, "route_order": {}, "passenger_id": {}, "departure_airport": { "type": "string", "example": "JFK" }, "departure_datetime": { "type": "string", "example": "2024-07-03T05:00:00" }, "departure_airport_timezone": { "type": "string", "example": "GMT-05" }, "arrival_airport": { "type": "string", "example": "LAX" }, "arrival_airport_timezone": { "type": "string", "example": "+00:00" }, "arrival_datetime": { "type": "string", "example": "2030-07-03T22:59:00" }, "carrier_code": { "type": "string", "example": "AA" }, "flight_number": { "type": "string", "example": "123" }, "fare_basis_code": { "type": "string", "example": "Y" }, "fare_class_code": { "type": "string", "example": "S" }, "base_fare": { "type": "integer", "example": 1800, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "O" }, "departure_airport_country": { "type": "string", "example": "NL" }, "departure_airport_city": { "type": "string", "example": "Amsterdam" }, "arrival_airport_country": { "type": "string", "example": "AR" }, "arrival_airport_city": { "type": "string", "example": "Buenos aires" }, "expedited_boarding": {}, "extra_baggage": {}, "purchased_meals": {}, "selected_seat": {} } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "first_name": { "type": "string", "example": "Antonio" }, "last_name": { "type": "string", "example": "Vargas" }, "middle_name": { "type": "string", "example": "Piedad" }, "type": { "type": "string", "example": "A" }, "date_of_birth": { "type": "string", "example": "1999-12-17" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "DNI" }, "document_number": { "type": "string", "example": "82183204" } } }, "country": { "type": "string", "example": "CO" }, "loyalty_number": { "type": "string", "example": "79250001" }, "loyalty_tier": { "type": "string", "example": "DIAMOND" }, "email": { "type": "string", "example": "anaarias@example.com" }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "91112345678" }, "country_code": { "type": "string", "example": "54" } } }, "address": {}, "evidence_document_source": {} } } }, "type": {}, "ticket": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "BRB0001" }, "passenger_id": {}, "e_ticket": { "type": "boolean", "example": true, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 2000, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 180, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 20, "default": 0 }, "issue": { "type": "object", "properties": { "carrier_prefix_code": { "type": "string", "example": "AA" }, "travel_agent_code": { "type": "string", "example": "A12345" }, "travel_agent_name": { "type": "string", "example": "TRAVEL AGENCY" }, "date": { "type": "string", "example": "2023-10-31" }, "address": { "type": "string", "example": "123 Main St" }, "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" }, "booking_system_code": { "type": "string", "example": "1G" }, "booking_system_name": { "type": "string", "example": "Galileo" } } } } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "BRB0001" }, "passenger_id": {}, "e_ticket": { "type": "boolean", "example": true, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 2000, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 180, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 20, "default": 0 }, "issue": { "type": "object", "properties": { "carrier_prefix_code": { "type": "string", "example": "AA" }, "travel_agent_code": { "type": "string", "example": "A12345" }, "travel_agent_name": { "type": "string", "example": "TRAVEL AGENCY" }, "date": { "type": "string", "example": "2023-10-31" }, "address": { "type": "string", "example": "123 Main St" }, "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" }, "booking_system_code": { "type": "string", "example": "1G" }, "booking_system_name": { "type": "string", "example": "Galileo" } } } } } } } }, "transportations": {}, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 1, "default": 0 }, "shipping_amount": { "type": "integer", "example": 3, "default": 0 }, "tip_amount": { "type": "integer", "example": 2, "default": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "97029" }, "name": { "type": "string", "example": "SKIRT" }, "quantity": { "type": "integer", "example": 3, "default": 0 }, "unit_amount": { "type": "integer", "example": 2000, "default": 0 }, "category": { "type": "string", "example": "OTHERS" }, "brand": { "type": "string", "example": "Barrera Group" }, "sku_code": { "type": "string", "example": "SC-01905" }, "manufacture_part_number": { "type": "string", "example": "MPN-70919" } } } }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "VAT" }, "tax_base": { "type": "integer", "example": 100, "default": 0 }, "value": { "type": "integer", "example": 10, "default": 0 }, "percentage": { "type": "integer", "example": 10, "default": 0 } } } }, "shipping": { "type": "object", "properties": { "type": { "type": "string", "example": "ELECTRONIC" }, "description": { "type": "string", "example": "q4O6W8x8ONwpbgHjlxlz" }, "carrier": { "type": "string", "example": "AR_OCA" }, "deliver_at": { "type": "string", "example": "2025-11-26T20:34:07.500866Z" }, "recipients": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "account_funding": { "type": "object", "properties": { "sender": { "type": "object", "properties": { "national_entity": {}, "first_name": { "type": "string", "example": "Reinaldo" }, "last_name": { "type": "string", "example": "Rojas" }, "legal_name": {}, "email": {}, "country": {}, "date_of_birth": {}, "document": {}, "phone": {}, "address": {} } }, "beneficiary": { "type": "object", "properties": { "national_entity": {}, "first_name": { "type": "string", "example": "Leidy" }, "last_name": { "type": "string", "example": "González" }, "legal_name": {}, "email": {}, "country": { "type": "string", "example": "AR" }, "date_of_birth": { "type": "string", "example": "1983-12-07" }, "document": {}, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "91112345678" }, "country_code": { "type": "string", "example": "54" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 4ª 3050" }, "address_line_2": { "type": "string", "example": "Carrera 98 6425" }, "country": { "type": "string", "example": "AR" }, "city": { "type": "string", "example": "" }, "zip_code": { "type": "string", "example": "" }, "neighborhood": { "type": "string", "example": "Barrio Colegiales" } } } } } } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "57bfc6e7-c270-4fcc-a578-a76e6eaa4576" }, "name": { "type": "string", "example": "Ticket vitae" }, "description": { "type": "string", "example": "Description 4I%n" }, "type": { "type": "string", "example": "VIRTUAL" }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 2000, "default": 0 }, "currency": { "type": "string", "example": "ARS" } } }, "event": { "type": "object", "properties": { "id": { "type": "string", "example": "3e9d0621-e8ca-4415-9025-95d568cac569" }, "name": { "type": "string", "example": "Event doloremque" }, "description": { "type": "string", "example": "Description ipsam" }, "type": { "type": "string", "example": "CIRCUS" }, "date": { "type": "string", "example": "2025-11-26" }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Diagonal 33 2395" }, "address_line_2": { "type": "string", "example": "Cl. 112E 6497" }, "city": { "type": "string", "example": "Paz de Ariporo" }, "country": { "type": "string", "example": "AR" }, "state": { "type": "string", "example": "Lleida" }, "zip_code": { "type": "string", "example": "18124" }, "neighborhood": { "type": "string", "example": "Conjunto Los Laureles" } } } } } } } }, "fulfillment": {}, "discounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "10FF" }, "name": { "type": "string", "example": "10% Discount" }, "unit_amount": { "type": "integer", "example": 10, "default": 0 } } } }, "sales_channel": { "type": "string", "example": "marketplace" } } }, "seller_details": { "type": "object", "properties": { "name": { "type": "string", "example": "Mendoza-Cerón" }, "website": { "type": "string", "example": "http://navarro.info/category/postsregister.html" }, "email": { "type": "string", "example": "iospina@example.net" }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Av. calle 5ª 3906" }, "address_line_2": { "type": "string", "example": "Dg. 8ª 8965" }, "country": { "type": "string", "example": "AR" }, "state": { "type": "string", "example": "ARGENTINA" }, "city": { "type": "string", "example": "Curití" }, "zip_code": { "type": "string", "example": "15484" } } }, "reference": { "type": "string", "example": "39245884" }, "country": { "type": "string", "example": "AR" }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "6844503463" }, "country_code": { "type": "string", "example": "23" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "DNI" }, "document_number": { "type": "string", "example": "82183204" } } }, "industry": { "type": "string", "example": "ELECTRONICS" }, "merchant_category_code": { "type": "string", "example": "6628" } } } } }, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "4a963490-70c2-4669-975a-a6901b4b5abf" }, "type": { "type": "string", "example": "CHARGEBACK" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 2000, "default": 0 }, "provider_id": { "type": "string", "example": "BAMBOO" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "parent_payment_method_type": {}, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": {}, "installment_amount": {}, "installments_total_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "393119" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "Pepito Perez" }, "iin": { "type": "string", "example": "45130761" }, "lfd": { "type": "string", "example": "5348" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "BANCOLOMBIA" }, "issuer_code": {}, "country_code": { "type": "string", "example": "CO" }, "category": { "type": "string", "example": "CLASSIC" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "2213e58a-33d7-4bdc-8cbe-4785f683c410" }, "expiration_month": { "type": "integer", "example": 6, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "CHARGEBACK_CREATED" }, "reason": { "type": "string", "example": "REQUESTED_BY_CUSTOMER" }, "description": { "type": "string", "example": "webhook transaction" }, "merchant_reference": { "type": "string", "example": "Reference-ac04c8a6-78c7-4588-b915-5498455369ef" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BAMBOO" }, "transaction_id": { "type": "string", "example": "121030201030210312" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "APPROVED" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": {}, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {}, "iso8583_response_code": {}, "iso8583_response_message": {}, "merchant_advice_code": {}, "merchant_advice_code_message": {}, "reason_code": {}, "reason_description": {} } }, "connection_data": { "type": "object", "properties": { "id": {}, "name": {} } }, "created_at": { "type": "string", "example": "2025-11-26T20:34:12.529203Z" }, "updated_at": { "type": "string", "example": "2025-11-26T20:34:12.559289Z" }, "merchant_advice_code": {}, "merchant_advice_code_message": {} } }, "transactions_history": {}, "split_marketplace": { "type": "array", "items": { "type": "object", "properties": {} } }, "callback_url": { "type": "string", "example": "https://example.com/callback" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "explicabo" }, "value": { "type": "string", "example": "nihil" } } } }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": {}, "routing_rules": { "type": "object", "properties": { "smart_routing": { "type": "boolean", "example": false, "default": true }, "monitors": { "type": "boolean", "example": false, "default": true }, "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 64972, "default": 0 }, "name": {}, "description": {} } } } }, "simplified_mode": { "type": "boolean", "example": false, "default": true } } } } } } }, "deprecated": false, "tags": [ "Payments" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] }, "patch": { "summary": "Copy of Dispute a chargeback", "description": "", "operationId": "post_-payment_id-transactions-transaction_id-dispute", "parameters": [ { "name": "payment_id", "in": "path", "description": "The unique identifier of the payment (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "transaction_id", "in": "path", "description": "The unique identifier of the transaction (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "evidence" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account (UUID, 36 chars)." }, "evidence": { "type": "array", "description": "The evidence files object", "items": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the documentation sent (MAX 255; MIN 3)." }, "content_type": { "type": "string", "description": "The type of the documentation sent by the merchant", "enum": [ "application/pdf" ] }, "content_category": { "type": "string", "description": "The category of the documentation sent by the merchant", "enum": [ "CANCEL_POLICY", "CUSTOMER_INTERACTION", "OTHERS", "PAYMENT_DETAIL", "PROOF_OF_AUTHENTICITY", "PROOF_OF_DELIVERY", "PROOF_OF_SERVICE", "RECEIPT", "REFUND_POLICY", "SERVICE_AGREEMENT", "TERMS_AND_CONDITIONS" ] }, "content": { "type": "string", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 1MB." } }, "required": [ "file_name", "content_type", "content_category", "content" ] } } } }, "examples": { "Request Example": { "value": "\"account_id\": \"cba2c4b1-db19-4a4c-8af2-296e35240427\",\n \"evidence\": [\n {\n \"content_type\": \"application/pdf\",\n \"file_name\": \"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\",\n \"content_category\": \"RECEIPT\",\n \"content\": \"JVBERi0xLjYKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nJ1Zy4osNwzdz1f0OtCd8qO6XDAU9GN6kd2FgSxCdrnJLpC7ye/HlmTr+NHVQxjoqYcfsnSkI6mmkzn8+/bPYTpMp8mGw9mY07qYw7Ly/x/f33796fA3j4h/P/56u36+rVOcdg4u/n7+cfj5YQ7GHj7//O19Mtv5fbKT247+ffKbfZ/mLV6dp2UK6W7djnHAJT27pvtb+rnTaL1f0w/dfmxHl97H14/taKqntMgtrWemdLmWV8bQWJoWL60MgHfG0og0xThdmO79ZmQ3M+urW5bJnLc8M2+TpTfL9vvnL28fn2/fhgqz82keK8yEtOhM50paM6u5mCuJfo0DzI0u70kGu7vHvCynlfewsEeS06YtXFrCx52cXMc952ifLf4sdBni2UgWl64vNJVu+LIskMbKDU04JxGjGvJwx1oTDZFp5tH0hxhoyeBImy5ZMNiULx9JX65oPxnSytkeug3vCOu7BACnCFRlLElYHiR4JeEZpktelXaco2ysJBrk49NdW8xrdhC1ReBdsmLmjGYSg89sWZ1kC3rCkGtPcxN9JPFw9OR5C9KUpYPoGfMq5ZXeez61SYNphQjKtEPg6aBSxo+8BuPK9qwsckcnDkZYonNdZM0zTDCXfD5z5aV5ituyURLCzA0tnBWRxwHyxLa7pvHTybWmUa2wp+k+vCSY/qLmY6WRvj7SKM/qCmIf3wJQ1MZH/1AA0O582aiAXYsVcS9OdGuXAZ8iGc+KDD4EONCH6rfYqbwvdg4S4TQgZIzciywcVL2GkheKtybHwKJ48DvQM2BURWY1PhrvBm/me99AR9YhfwYc44E9RAOwQijxL8KPpoIzgluRBAFvLuAdQ6cjy6wauFqM1aE6TQOfSRYX6+jg9jy7hpjsaWk94PXpcaNk/6jjhAebSMppIAuCPoUrH1zvM+iPjZ3qOJ5JoLabuHqKjISHVmkSY2K81qVEOnEt//4SyEAZrWMQEdAkj7bjIwcVxKxi7T1D+JhGdYydT0AynFUfwh5B1Al+HsxjE+7ICC2QZzFAoQK1mhT8E4Z4glOn2dkziBeGmCFXEr8hmoEUBLAm6wranWCMlwFimHFwaF8PeB2MumuQ89zTdjoZmR2x0Ft97PnC7a6i41ZtElqzZudeL7UPnkuek5mh4efn2VnhiSalyokZkBWrnoHY6lFpWzJMD3QF0QG8HrQnB6sgs2sWfx5Ttmxy0yCBNvrIKCoEUsgW8l/JU3wypBL6k3PXvp1xAMkAkJQ6S3jCYKytlVOHmxo7jNOHJyl1DvpeIHF5nQN5s3RUbCeCIvK+HTlfjZwjwfe1A7r+vZLNOL3CCV3OLJi972jIjuJWm5E5iGNYJbURRxLZqJ0SVAW+VdbC46zZ1b4Loedfx7nY7rxYVKxtEUkEd5mWmIFGMR+0/SS4ShCLj7w84XryYrkuvhFnSHm50jCzTgtMtjYXxjKFVs8P0rZcp1pHs/lFxKEY0zdz5Z53tHOcTaKZSoB9BRjbxQEpGyAWIXMCd/kuS1BPjCd1r+vJnC9H41u3VasLI0F6YX2pZDuBfK6IBkX2uGSgIsgJNx4tZjxNGiz+2zK+JsVYEFT774PPrq4LGRgKIOmzGgnB0Vc+8K775qxixuj3NGpU9WRAJ5aCpVsB4pC4MiRT48gjO5f4pKEEWBcS9T4YXjeDbC0WrSrZDJoBs2dm+ZKNFt8HFv+/y+q2agEPKnFz1iwoA2vQwGHP0dmTckyVhUJ+MipAxx2pLkXP3aFBEYkKRequInzpmAWuEULnc8COXzHLPPdp/l7rbJxsg6a+CqkqV/mC3bXAzRlRW7vByQtGZO69DokstZ0bV1GEc8Fyg+qP3Qyyqalh22cRsW6B+C8ZxS19qt9GGFs2ydViqSmh7dHHn3FPpfNE0F4XKc+lXOL7cXuozeIx/xn3fMauhx20poTTNIeBUrlEqENnGxDt80Ry1zYm9DxPgLxD+QA9OqfGqarTvF/Miff2M2Ht0+Gm44IAg2y0qzegrJ0VRNEN0pcCqFpfNmOfdadHyPpCI711bZj9pDIrNWQhJqgh9ayZ+Echqw1przpTZpl6AtPCCJcOg36Bkk4X1sEvIZi3dmtbivDBQMnLtB7EMmi16YblQQPX198wqkI7rWgyOmzdAh5pZa7O2fmn+juPynLtGmc2PY0Bg9xVg9DWHrfH6u8FzDUYCIcfZYZ0IKe6aUgI0hXQIX36Bjxj0bW/nBvttGD0kFcNexVNZ+W0pCuCFEIcBetdCznXcRorF9hSsiuPKHIV31RZedPUwK8suUfEn40gi6V+DHQIITVou2SQ/LfON+pIZZ8k65yrzCi7S1HQt8N/sIOi2gplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjE3NjAKZW5kb2JqCgo1IDAgb2JqCjw8L0xlbmd0aCA2IDAgUi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJydWcmqKzcQ3fsrvA7YkdSTGkyD3e27yO7BhSxCdhl2gbxNfj9SlaQ6KrXbN+HBfbaGmodTsrna8z+nv8/mbK7G+fNo7XWe7Hma+f/vv59+/uH8F58I/77/eXp8nmYTro3OXKfz52/nHz/s2brz5x+/3KxbLvZmP5b+ZubF3VwfPl+6mxnCivVL2FuXi7vZB/1dl6EcCUtj3t3CVeOIgp3NxKQsbUXSzsSPtGpGe3djIBNODcRpCrtD3LyMcdEtU/my+ESFCZoig3F2rgQjLlZkZIaj6ZdfP386PT9P3/YsMkxd+EsWcdki4Wpg3ZEAvdkisy7K3Udxw5dnWLE2Wi1sRia0e6eFD7w6LF3afAQzGm87Vjcu881IyvhEtzAJluWTccX2C2kf/RDIl1v0MZzrMz/iQSxd/ETUVhLqScTgApOhYyQM879HuzcaeXatN2Nyg41C6muZeJY6cSZxnimcaOvQGUN/7ZQzAmORk7nYpNRwQ4d0Sclif7F+z1plY7l8rwdXyCYbnE8Q63ty9VApCDbcZ5IOeyQSrVjE3mNewiiu+nRHO6YJF7y6patT3PyQS+w+cUgy41fc0g3XQbslxamHNEge6eJml9K3qwzl2T+ONrVW2qAQb228dtnLRLDnG1OJBjZRko4EXXMiX8ZECb5DQpVs40M54UoESzCwk7lOJQVGUV3ZZ6iI9HZkNYsGTr4L86/4xo65ootvRqmmKcSJZpWHQXRDsoGBkxG7HYVz+nvWJYlHScQm0y4Cig/QJcq0RsczB2+HQLIviT1JNVSGLtV3v7oQTxGSWPB5Moa3KrogyTn5qurmxf72fmj/3k/XWfePsS5Ndb5u0j3Ayk8pLJjSbBdwlE92AdfossH6EYfQ20u6UZgxGxJhrAMXO84GOVAylW216+sq5yWcOR11xmNGHYTh/+uDh64a56bVQ9dOqaqr0PtIU/tSCpxYGFq+lD3sJv1+f2G9gAdmYX3/VTnmRqddXPUmXW574BjiP5/goO13y0QptTFIVkjbVGrZr4fuGUzb/F8UZhXPVWGOZ0fQasiLRKDpN33dO1OIR1BcrFQ8PuB9S1i2bUI6E9GwO9mrc/FFQCan9W3+gI0SK6nQG6w2MCIrcOiUzratHxhmiEiSQfv1SfhK64NeTyFEhocIBihldW5CAZCzb2p1F7D+rKYfN/E00UfZw/hAU4mDWScNQ/VcM7iQOTS+9PGqw3ElDUFhqJG5hcYoHnZ4TpmZLHcK4s2E3ZKHJLweVMx8nH0m7Bg58QCUJQj37/G7I+ndugyV3EFAUhA1MpGwTa48tJ0b2+zEguAmibvQ1CvQJ453nkSb44B2b2cnVf35yiNuOtLUbQreA0jgklXNJTWAUDHnnkSRLeajQLOKTxyuBJTpEYFiEBIPcj4V5QE1+z9zUWemNguh/u2itRqCNBCKgNeWxJSenWuFoMRXABfaETSjl+auyq2FnFEjFgbEm6YGZb6q5VBwCzJxCoWJfpvc54sIV13uNgL485x55DDnfYvKARMkgK4nGwCMXRXmdfS18f029ldtwpKyFwEffWTIk2MC4WDhFVJUyu4RgqseRGJQpSo+w+wALhDhWJDKBTstISMYHmaHzOjQLQEBarDeiImPJRAb0PT2E+VlZkM5gdefGr7JcA55hHitMnGpgau8lNHqXbfJKmLHCjZAtAiSf92id+F3plur8gZxJZKHjhpsC9UfEgWAFNQM8AYC2LnLlVQgwJYs0XEn5WZNnx6lvaZuXDptwQLpJZTuMHLYexKNW3wcHiuNUJfXUSH8XNwNGnySgJ9HC0DJxF4CFNbq0Cb98J9G2FXbXXX7Ul+wdVAu6Oegu64pzcPp17qUmi2r+fclYoSQdGTB6nlWd68MdAfIIy5G8IaQeovHCUVv11Dn0C9uapOASsRcRqE8TtS1WupIZyB5k4I5LYu9dQaDuUY1YUNEIKxrBg/uZXoqhglq/4maCPDdTcEqeV6thuyQZOWRgU/ztBYcpRvGfpfyGFE9F7hZmuwXipU1voXG8i7i5CUUWia8o4yl4/NRnqageCIOVWHeVnyBCm2Hggcx3gTP54mtfSpIYyJ4OTPLvww0Qoz4s0ZLcd8TUFc28SQH36p/2BAoe+QaP7e4+fD3BI8ZxcbetzsEKT486Geob+d/Ae828gsKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxNjMxCmVuZG9iagoKOCAwIG9iago8PC9MZW5ndGggOSAwIFIvRmlsdGVyL0ZsYXRlRGVjb2RlPj4Kc3RyZWFtCniclVdLi9swEL7nV/hccCrJki2DMThOfOhtIdBD6a2PW6F76d+v5iFpJHvdLQtZ2ZnRvL75ZqKuuvlz+d2oRl2V8U2v9XUcdDOM9P/1++Xzh+YXSYS/15+X2/MyqqA2qCF8Pr81HzfTaNM8f3yZlJ5bPZlttpPyupvbblLDHD62uTWTMrOeVDeH0wJyQcSFb/pJPUAyyAc1N7eOjyCp7/Cs7rOLUhb03YzycL+4j6ygmlOelKy03ePRozop1o5ZcoAuQS/uKNHDXZ7FyRpeQsf6KowZ3RU+Uag2msgxkoxIl0Z9dqrtySv0+Ovz0+XxvLwcFaT3/tpVBXlvHijNnSKnPAtglvuUmxViZTc9ZYSSY/UWHrSmoh4rb5xG+ESHwBFNkWNJj/WiOZTRHi2w0egDK0CeUun5ixZR4yhUyHn2J1an57j4BbpGRR1zprAegFZOWLClx9n8syL9eHV1i4AFCmTfIAI3RQwZPgbjZDlXwOteX5GbRC+nfjrjop86IcdCfRaDXgzgB7hqVHg0D3RipIpgJ1gsZTeZUUPzG0ob1hXEjMEw8Ag3sLCG4xIyeeacHYbreMgzAQJdRoWPCdL7hqK6PfZ80ZcdFnsS6svOhySsnOWccCEnrIpn8izYTggk/Pl5iMeVsEZKqM/PyfOI8/S+oLk1h4DaNQXuX1jBe44LojmWU5Isbzotlht3Q+EdHLTv95iR5DyXETInqMBrU6V/gQyLoAvGSQI+mb9njyCXcqgwJiTp5FJiMP3BEPLMg2bWRQv21fDbqth4uBDuVrbpCvbk2ZIw9a6KWLWbCnTxDpx56KpMgMLNG0UEWn02n2bnG1q2HtaHnRXJWMoxwyZQjBVIEKCWXos5vKbpzHKCOLu4PMh70K7OzgucCACuTDmOZjOIIJUv5NVZDTpvrkPFr0HZMkMafQMzgQ6h/mA3kCQcV/y8o8y5gc7t2+4mOtjKaXaLyOSWWXOkjxr9dPYyPRH+S+Iymf2CWQ3nNXSp6LLUSCK79R62Mffl/hAzzecKr+KSDJj/WOuIBdDfk7VOtjlj5N9V1/2+8/LWJBs97x68C6UJkCZEzWtD3ouXTFCih5fMiboiKlGHXs60Nk9Kl7lRJPSR1nCZJrm5vYEgngFU02IIHC5nsfo+roaJTNP9Z5k347DfuwS7iI1LrIFif/KJgMucMsBa5Iuh2DDpmLd/b8IbK/NJegr0xrwpSHgKS5ZXLCbJvvg5IX46rDXnChCLqbhW3hJ6fMx/pkxZv8h4ol7Yc/bo1872Ri+f1mnwkRfLOmHjF0uY3HEELKsRXaIzXiLniCU07RaBpFCvIGKJQD+sTBZ3E9zm4xJ+sN3T77nikoys2KiGt9pyAcglFSAQhcprEl7W6Zzwl+Yv2dVniwplbmRzdHJlYW0KZW5kb2JqCgo5IDAgb2JqCjEwNDcKZW5kb2JqCgoxMSAwIG9iago8PC9MZW5ndGggMTIgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDEyNjAwPj4Kc3RyZWFtCnic7Xp5cFzHeWd3vzlxDGYwF4AhiTfzgMExbwbH4CRAajiDgyAgEASvGV4ACICkRIIEQfCSKOoiRQkM5dgrilYixUp0lKPajd9QksPYezAubyqmY6/jq5KKV+WKUmsnW+WqOGstUxEH++t+b3BQpBNv7Z87r2b66+6vu7/7+/oB83Onp0kReYZIJDE5MzGrOqRqQshfEEJLJ8/Myzl35wHAP8V3/tDs4ZnTl0KDhEg7CCmeOXzs/KHq8iPbCXF+kxD/20emJ6ZOfn2mhZDaI9ij7QgGinIxE/pvol91ZGb+XNL1wW70gU9uHzsxOfHjK+nLhNRdQv/gzMS52fOO/0nR/zn68vGJmemCr7/tIqTeRojFOXvi1Hwz+dIiIY1lfH52bnp27sqNOvQ70L+HL8XDP0UALbzPJJPZYrXZCwqLih0lTlep2+P1+cvKKwJr1lbKwZBSVR2uqa2rj6jRWAP5/58Hfr6I5xw5x+4QwkKELDpN0dzfsB8ufsLUxU/03jIORu+yUH6c/Qj9eyvwruM5RU6xPkLE/Mji3dXjfMaY62NbF+8a80/imSbT9Aj5xeKb+l4C/h1j3/x8pZipXE0T6L67gvIfCRqXaZrEs5lspvWLF7Hnz5f2b1mcX3WGgce+Td9kP2OHaSX5nNjvZ/RV9Gdoud7XiCprZGe6NyPLg7eIY9ugZtm+J621BLTazPgheWFnWmPVE39iIzYyOakcDASDGsloJKX03IT9psaTUY2qmjx+KKoxVZ6Stdsjmim852YtLUz1TvZqlt50UJOqM6N700ElGFhIy9rICIYSmYCsdXCoI5ORszr2xJRWiyGjJ2uNfL6RY94eScugZmFC1gpG0uMYkflcAYfaONQ2HhjPZDIBUKsVpCY1MprWyCBHBlYqMKit49C6wYlbTjLJMW6ZycFMZmoio9FIJqNoZCQ9nclENUmVcbKpegK8mFMjac2sJDWLkgTnQB2PaiZVASfyVNZ8MCnzGc5jQKeZ/2r28d5JTaoPYjIlL8gLOCDbaK6GWLalx0cCE6OZtJIJZmQtsT2NuQAXhnF+VDOrmjUVuUmYLlsLukpSgY6U5ITGDh7S6CSo0Mz1Uc2qypzUIvBiIgdlvoOWGM9wlPEeQapNvWktIqneZH1wSVt2dbX2CvRdaAQkpMD3uNy7oExwTQoJkwDXgiYHQGSeSuhTmejRjyh8yHKtCqtIYJm1lYuKVMHQzcICCeYRUIKZ+mBUK1azjPVqUxM9Uc2hAlGWteLUFr4cgJLMaA7eG0XPgV5UK8E2TiESGRKYxLlaSWpcXhiXtRIILao51cEd6axpqidTpRVPK+eimksd3JYe3K4PBoIYd4vxUjVLnKmd6azTmdLoRFIriXArhzUls8X8x4EfjfqgCal6JJ3lwgO3yQXoF8c66oMKluXhgD7Pl8B5+EgGnPSD/n6MrlbVQxSYJcStQFopjWy8SSkVunKrJEtY74605lSScq9WBOMrVGBwSXkcx39YWkpJCUkmF8azpZaI9lIkEIKYPODNHYlqXjVLeeuDnHnrV7MSb8vUrIm35WrWzNsKNWvhbUDNWnm7Rs3aeLtWzdp5W6cqeblrlnFIWJFjGt3PHSSq1a+Y9C1NntQnIysmw0uTc/rkOpVoxZH/C/4qwd860CWDP94GwR9vQ+CPtwr4420V+ONtNfjjbRj88bYG/PG2FvzxVlXlbmGmURXHlo7LKeh2PCVUCddTua3GVC0a0aLwwgY4QL/8EC0qEx0Kj6G/FiPAuW/MqzZbZOnllqY11GfN1NubRvzjXDatEM/DcJpVuVVQHsduOk7vZ8+Esz6QFj5OfB+INNqzUenINlMv57UF8gADD6YfTjLREdVa1Zi/O6q1/WuoMOhJoLdDRcRXLcfkfh4IINqBhYV+pR+RI40cg0CL6NBGqdcDCXcgYvk0F9BMCKLVAi1bQJKaPRWZXogpsty9gD07V6PJMX0/zaQk89iyNs5jSWJb+n0mS3LgfRaWKjJJHl9tCNWKWKH0wbNT97vpOI9xegJiqfEpRZNSE1OYZqmJAOBxHt/uXzMB0hD1lT7oWMEJfTw52VLiFOz3gEMUPZKaEDygDDMMzvyZXbEj56paEIHfET2CLp8FQ1ifl4WMUXPYkIXSDTF1LU1pNjHfp/TzQ7kWu5dEyJnRJa2RHemY3I3czak3BmVOl6EKzVKN3sDKMkFX4oOs3dCWwk1+wwpKUnl1jfNa4n6W8yreiPgR41Ls01yp9EgAmVTuzsSyMeqB3z6yanY0MLJqNvHAtb9uxSZV64j8ugOTqtYZWQBt3MbA1ENRodCYFsOKlGCZ22dYl/yEVqAkdda5gSpwnxg8T9+/B4EJOSa/5Dc06f7/V1bMeeJxrFtBqFphL8GMQWcvAnBHJC+VPvQ6I0HFkIvBzZII+iECr+72qEHg4e6Y1gIv3/yQ8QFsRz1urRXwFlVrRzPIpdgLcct9SLh5aQ2p3KC1QYCPqjcRwgAMA6Ac2KrepGJkBIAY2cZxegGMchwObOc4HNjBcTiwU30fsXAToF2AqIB2q+9TfSwNSB/LcDzKoT0cT0B7OZ6A9nE8Ae3nZ6YAHOBncmCMn8mBcX4mByY4Th+AgxyHA5MchwNTHIcD04KuJKBDgi4OHRZ0ceiIoItDjwm6OPS4oItDRwVdHDom6OLQDGS8fkmBx0VP2wjwhA4+AnCWC130EuidRK41cOZ0kOOcEjjUwJnH4q6lXU+LnlhxRgf5irM6yNHPYR8D4bwOcoQndJAjPAnc7qX9LoieQH9KBzn6RR3k6E9jpYHwjA5yhGd1kCM8B9wNS/s9L3oC/ZIOcvTLOsjRX8BKA+GKDnKEF3WQI7ykvm83sXxFm4xotmlNqho5l0/RUZ5YGeHvKP4Z9zyJWEl9ogZjEiPSNGGUsp2EMbrfBIg+SojVYjYBTXKZLd5I3BV0VQddwQP0d3NfpK25b7M799ribIrwNwkyfqaxZyGRE2sLC+w2s0liNmh8C77PDQLneTLkdbJiXyQYbG131bQGvVaXn07nvr57N+3dvXtXLf1u7a5dtbnmWr7fMAjtYyrxkAODWvlI+kMXZYRuCfDWRLdkxGDCDWrJmMnMCLk2KMGWnqdDgYSfmEyXB8WUma6YySRclDhLHMUFoI54qMdS7InQZp/XpbhawkrIwoG4P97WRi+lH79eH+tpvj7nsVXsZerYY7nX6SNdXft35xZZqK8+zGn04Edj90gZWZ9oL6EmyUnNJgslZmmLlZrpAMiQxogkXRpkIMO8n5jNIEuQ4q4Ou1xOS3FFhCo4VGltb21pa4s3+/zWsKDEG6cXnr0+Otqwuyuy2Rd21ZVXrn2W3swN05uba2v7HpUd9hmzPbw2BH1GcUPfCFkVk3JSmViDE+kYjrmmiwCiv0qGqqqrQ6bisgiYVkLhME7DYT6zxxdvbmsVzLONn3ty6GzPyxcePdOTu9La3dXKv7T0xVeST+998QvJi3u2bd++DR9i6IdmcaabjA9qFSPprzolMAkFJQokKhEnpRLjWsJUohTEkDHJJLQEmp5nUJIPZAppQH90eSKTKGEEKiqyWYibuc26hgyprFDQ04Xr7IW2ioJwX+T6SZ+1bAdTGfstJgW6W3L/wEL76rtJnk7pKugMkcMflFEbHdANJ2CiXDZWi10SZ9tsdL8ZHOgGVEkslsuDBoqdfQYjkyiHxVeuDfh9Xo+rpLjIboVBhWioYIVBGfbUstKuuILRsP+2f+z6aFfz9dGNDdzCync3dG/3F5dn8oZ2ZsfW3C/QLJlbTR03OUPXVeDHR9aSVCJRCD8tgqjZFmImlJnptJWaTGTMkhepMMCr0lCZn5JAhX9t2VqnQ1Droz6bQa036ONm0O615G2jzR+yWOPhMG04eSn3Jut/pGV3rC79yOjFzZvmh9UO81/SOFOfPbv5kc1e3ymPe8OTY2PPJB7v6GpKcho7F/+J/B1oLCR+YY9cx+Q+eqqqqoQ9uoUheoVVulbAnc1VSnOzUtWcb+lfx6qrY2pNTe41AyCGD7IGxB0rCSTKuJ+z/TglH3BccDJ+SpC7WNCr0Jkb32CBb7Chixexdg82+JWIWXWJMMKcySyZpkX802OW2Uz2L+1juGsQAdAb9Ma9ijdIf5WbRiz89Je/pCZ258IbF27p8RX7slewrwP8dyU6rFwvXD+Mmpmun/1cP8/l45KzhBK3q8Tv9BcX8dBJHNSR143HYrG6FYkHCb/i1Z2V1n/havUG5ftffm/bjf8aaxrc1MfuPH6saSDuzH2LluZ+AVr+tLkpHuHyWQ972cN+SAKkPdFSRolUboefFsBspC3c74Q+FrgfsjGwfpUNUeLzOIqsZhKgAeF+sF/P/fZhRCr60u59Ow9E0vGGfZ0nXu4Zvn6s9WhTU+02tuu5k3NPeUqfdpfufef4sXcPBPxPutcQXebsB5CNi6xLBArhYIxukSjXGKyEi9rn8hkqo4rP5+eeQ2GJNa44+8Ht3LdMzMyu/BfaJiELvMjWxA/Fcxry0N83HWymo9h/J/j9EvYvJcHEOhP31+dEGBzXwyB+S0mp4q4yF/sj1OURHLW64i49ELrYlzZdmnz5lRub+7ek2J1c85azvZ8/S/8iN5jpH95OP9D1y2X6t+xHpARSXRFvF1bH27BixNuVQlsdcf924Mb8/I2BgRun518duPe/d41N7NgxPr6LHjrxzr5975448fbeve+cmH322Vl8cS4//Cb7Dmy9lDQlYsWwOrrFQk2Qq4kcEmafj1A2GyG2UlspcK0wXSu4DdYErYo77pZqYqzGwaxWVtKS+7TlrU//5N6/tJidTrPZVWKKv/ce+869OK17F87o8XS1Fr6rx1GuNzfkahYcc+PlJnOAqw5RGwNmYna5TEjvcUgz6N1zg4agl/efMvzhPay1Q+t89bKHSVLew4LVwaX8BJVDUlbIiEPsve/euvPT2Xf2vnFkctumv6HHPvxjdmfk9TNnZnMNS7RJO7G/n4QTireQ8aoDYsABKEIksT3w/MTvcrv8Fm5bkrKOiaAMecR5kG5ra1ck+uK/N8E7r3z3D6X3v3sNWjXdYo2ekX1VuQ/AykcsdK+NjobSWz33/pKfu/jVxRj5R2HLtYlqXjJJyICIxJS3ZJIrhLuTyGUuCuF4Iv5QuKZVRNs2YXUWS8la1elUPBWRshudh75vMV80WTztreyNe1P7TsZ1/mKLn9BF+HAtiSUiAUT7NRa4L0ob+DBEKBx3YTAfZmF81VE9uFbzUGqcB5ML18QkPfHnqwyPz7+O0cWXLp7MxGfaOhqqN9aWr28NPTfbMdXR1DRcF4n1pNofrf+zsZORa77qSDAQDrqLgk19TeNHK8rOeHy1cliVKzq4eBE/uZ6PQh5O1CEh0ppoRhUECyXMgrqImafz6obiTSZhArDUioqKUEUwVBVUZWtxecStZwCrFwoC9UG34S2Kywh+yp6PXv53na1KV+ja+dyvbqST8e5NI5M9be2bYRXTG3bYzTalp2PiOP1KXV1dVe7vv9aq1jbpcvRDjl9gr6JeSyQ2OFBHQk8IIwiKEKNJet4MYzbtF8Ujj890HBRepdAgroKlLqfQYxkts0KP1SvCIa/e2uM8JSCK0JbymL+sv77p0Wj/aGTstdeqZuy2E4UOebifWh9pPjU/m/vnykqylMsj7C7xQlrP6XVJgR2FYyklJsYrKb2Dwilf766Fpi/xxGQUeHqylyxMqD2QCN43D4k/P7hcEQAnk/D7fZSsW+ML+UMuFMMI9F7qtem2aVgH4m1rK/yiRrFYasCpHq5gLf+y99T8ga4hn1myXZ9ba/FtsW5oZk3Jpo6Ogs9d/a3fjoWcG+Sv3LP1hxrODgw4t+7cOTKyTZf9IHhNsRDy9dCHELtEtxgVPCyDscsiFIwbKQAVfH4UfT6VV0UmUYwhD/Eggru4J1OdyPuCeEpU7XGjhofffoQSauwxOpX7U17CU6rTBPnTj1GnlPPcyFOir5BJDIWSBINAkFqSoV6iQnqoN0pLimEG5bSc50ZzKLyqbl9OlFR94nLP+a0d2ytVZcO6+Q3tDZtDocGCF74wdbHbV3LKUfrO6HC572kfbjBkM6j5B9hBITJKNFG/VBNfGjRTUSSLGFtURElRSRFqY6iskBbyy4s7Xy6BCp4qXws2NgZDDQ3HrrO7lfV1slxXX/ljHrkIWVw07gk5FiZIGcgM68gHQg617ABNshwpIuGsZaonEbDRfAwl9HmgzBP+R+Iin1TsjWQtpId6HZJVad3I2mnSEWuNuyedkboSlitw1Ko1xcXueLuP6H9bZp04u4jnYou4v3HRXx5czhrYtUzPGlLc7ePFcbs7Ln3ve68/Zi+Af7ofe/17LJT71prusrb1tP3eR8Jv6sGHi0WRfcPkdMJRjuxXBi+xUGqRDLOqRDgyWyTzYcJt36pXw9DKGMtfEpUHYWCOo+VLoUzCS0lVCM6CKr/QjqoZNZFtqcbPW15LW7vhItaatja31WIUTK00dvz0kbUmZbhnYPyJJ8aitbVD4abIsZfWb+6olRuTLDp2MPfKFrV2R2b3qFkqi9T6XdO+QO57jDXWhNZ2thg2+m3Y6HLstyL2W1bF/murYr9avRz7w6uCP1sZ/EGiCP7fPj3fOVqnHqqJhEuaW1s2yWcOxvc1RWs3VyddTY0NPdV/sD1T4nrSU1HhdfjW+HyRDbGhIY//qMtfVewt87jrNubvWeRj2LBE3AknyLmUr8DFlT+OVPvxdRilwCWLTmEXFaQmUVXhNsPBSpE8mWEdnK1xsHWFDVUr5aIYdBnGIazDsoKx9va3DttsTJIKbNNv/kw+M1xR5SiQXQ1tDjvs5jv+WEVFzE/j9764c6dZOsNMnbWBpXsh6wM9Pu5xJmGbZsTJS0s13NJbA8A+4nOH3DU84Lh5ctJvcitvdx+bma1itDl97Ho6FQefv1s3UMJDjrjMiVvcXT3mD4P3IfFeQ16K+S4YsJ0iV/KYj46kd/Ixf0WQv7YU268O6hLiMZ/HiFXXvvtwEPN9MOS1Aa/sk516APFQz/IVg8tTwT3QuKXyy59hwS304r65M/u6+nw22/XzXqtvS+H6RtqwMd7EVB7xI4H68E+k0v5gYz7g/34+tzmR21TEmDryezojpbj/INeYLMVw1iL+zybglw/S1YMG3yEbxQVsjFqZ4bymMbjq1cG81Qvmw2Dz8qCOueTln0XEhV2u5K5cWSfXVZQ5HeIN0Dq6zi6CqD/ezmsx3aziza3co5d82w9X4aKADy1Od5qKLi5cWT/ZMHXyFIqFNcNNEzOzn3/saGd7G1NH+u7999NPOErP1l8odFY7IuHrl1949fw7b23aVpoeImzx9qLTiPNreMZxguMSYfd59700qL+54g7AixFQXlxU5veUFq0pXlMVssCTVt6XpWX/1mvJzQ0hPQGEK9pKS2XPuvrr4Z3sK/WVIhd8umA1nzabQk2s/95bzaNNJB+jF8RdFTHaTnnYlxhbfmWHXwdx6JU9lRRE6XXMj8DvZgv/9M4vX3tBcjolqaTEdIW/DMSNaXdh1yafb1NXIf3DpZxTJXKO1cg57xp+8An8QK995j40wTLyFYGh9/wLA9N+q+6XPHpzl7zKo3f4IUi83hGY+XrB60cq0qsdnOV1lVbV2O9zY8P+rYqLrjD88McmhgKna9/c/IHuXl9B+Rwu09z0Y23t7G62stsVatA9oJvdzf2n5XKHki4I9g3ItIi/kyiwm6X7XoNW6K9B+bWjHdd7a017nL5xgzFz0DE68D8u0DfKd8qWyqLk3j/WfUmGrMrY9yE7lWxMdLkoMxfgtmHXk4D+XuEw7oGm5ct8PhvIleGqSlVWq8JVrVZxvXJIy9FzhZXzG1d1/qYv8gUrK41ueyrj7XB7VF9molayeHt79h5/fnbgTF8up3Y0NgWb15Q10tc2nD+6vUEynTdZOqaTSuOZY/OXUld3bki0dK+LlgUTdYKHKvDgx535vneUq+/MVdUr78xGZbXqxuxvOr732XONx/c+80TurfrODlXt6Kyn06feTn/jP5x6J/2NP3riSTwXLiy9h+kX73fcpDnRgKqHvzuGpPg9xCzewOilVTFKK6ejyF3sLrCjuENxZV1+/aIo3uV3L3TjwtMt549suvGT3ubEILtz9sgjx5I5dufCD+OdR7g/VS4+TX6KgsnGueQFFKE7ec3BLz6UPAq6bMTm4YVUux+6V6CDv7Y6GsqPOgK2+cLWi+1dL7Tofomwt+7u5emxku5fEavE/8eP/MDxxNP5fzPD7dMpXUXVRolFfzeg+7P436vlDyWrP40sTQ7Qy0RmnyfDKO487CiJ0j8jw9KPyTDbCngt6eSvFFgKc41kD3sF36fIeimK9n+RndIasp7dxHwr+n9H9khfIXvo4OJXWQ2JsTcB3yR+dp5Esf8gVBulTWSzOONx1JmdWLeP1NN/FOPDog86gM+/GFu8zRYwBjrEWDfpwlfGt4rNY++1hF+d6skoeZv8nIboGfoRa2SH8FxiGvtE2igdl96UfmKqMHWYjpjeNv2VWTVfMH/Tst5yyfLnlk+tNmuLddz6Y1u9LWF7zvaf7c32/1hgKWgrSBZoBX9VuL5wvvCPCr9vSK2RRFHNRPBl5IvkPRgooS8Vz3D9YbaEfA0z1GQHfEDcfjlMSSl6OsyAN2vAEnY7Z8AmRP8vG7CZ/Db5pgFbSAXdYcBW1NjHDdgGed00YDuppT8x4AKSZCYDLiQbWZ8BF5FudsmAi9mr7LYBOwgx7yIpcgJUnSdz5DFymByBpcqkGdQ1kVZA/Zg9gfFjZBq9AXKcTJIYoE0YOYZ2dGnVKdGbRjuNvc7gdwqYw1g9j69MtpMJrD5Fkugdw1wzZhvF04VTtuLpB5THz2NHl/A/u5O8NLdLnHkKtJzAjPyQvY8bO0SBeYKcxopJrFtvcNuO307B9Xq0jZg5hLaTxPF0YHZS7CZjh3nMTGA93+sIzjwuZFYLnptwbjvqm38LF48JDibEjnNop3DiDNo5chRjJ3DGw6T/qOCS73MemtNn+MrDgpbDvxazR2iI64zLaQd6E1i7cpTrTSYHsUJ+wPqpVevnjfUxYQHzwFlPGvCcFU8MWMv0x0DRCeA2oD8N3IYlfTQ8ZPXMfacv73AKY6dBC9f3DqEDLss+gT8vLITLbx67cHlOL0n7GFqu8+PCSjmfpwFPCevh3BwRuNshvyG0W8Wpx1ftPLRqBxUj99set4Em4SO/CWVTop0XXnhQ2JZOn77nhPgNweu2C+1uB8ytf5OgdbugYzegHWQzqN6Jlvc3wR9H8TuM/gDpFWu3YkSGz2/FaI9YMSBgfa5PePYwyaAdxAzH4XtPgypdOnOidw6SmROWcErQOCf4mMEol7Du+ZzXacHhby5XGTI6sUonp8SaSWAdEphclxPC2k8Ly9d1MSsonBGyzGvklCG/KUP/M4KXCXyX57mdnhFrjy/50HkjRnAb0WnSfXL+36DVGCKsnpNfR3R50GfwFvnz0XSW0pczGtX/R2k2S6zJROGHv3+NnBgjqQY7qRcjni/bXrE9YzsjHbLssmwxtdmqrHabMXXT8nuWBcuT9LjpgGmEJSxRs5hyJjcV1ieqE3Ji7e3y297bpbeLb9sTSBZ2TJZjkiQ+84hJifRkq+iL29Ja4sV0Vprqydby3i0b4V3Skwlka/jA12zPIIUkXpzcoQ/zT8Lznu1VJNFz0hFL2jJk6rCFrfai+lt08bJmupZlpOd985SF9PSA/f8DiNskHQplbmRzdHJlYW0KZW5kb2JqCgoxMiAwIG9iago3MzMyCmVuZG9iagoKMTMgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErTm90b1NhbnMtQm9sZAovRmxhZ3MgNAovRm9udEJCb3hbLTYzMSAtMzg5IDI3OTkgMTA2OV0vSXRhbGljQW5nbGUgMAovQXNjZW50IDAKL0Rlc2NlbnQgMAovQ2FwSGVpZ2h0IDEwNjkKL1N0ZW1WIDgwCi9Gb250RmlsZTIgMTEgMCBSCj4+CmVuZG9iagoKMTQgMCBvYmoKPDwvTGVuZ3RoIDQyOC9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdk82umzAQRvc8hZe3iyuwMeZeKUJKkyBl0R817QMQcFKkxiCHLPL29TcfbaUuQMfjmfHBGvLdcX8M45J/jVN/8ou6jGGI/j49Yu/V2V/HkGmjhrFf1pW8+1s3Z3mqPT3vi78dw2XabLL8W9q7L/GpXrbDdPYfsvxLHHwcw1W9/Nid0vr0mOdf/ubDooqsadTgL6nPp27+3N18LlWvxyFtj8vzNZX8S/j+nL0ystZU6afB3+eu97ELV59tiqJRm7ZtMh+G//asY8n50v/sYkrVKbUo7HuT2Ai7A7gkO7Alt+BKuDZgx/geXJMr8JtwuQW/C5sCvBWuLPgjz5X8HePSc894CT6QxadlDvJ1wTh89OqvwfS3OzD9Lc7S9Lfw1PS3cNP0r3CWpr+Fg6Z/LbX0d8L0r8WB/k5q6e9wh5r+rcTpX+MONf0dPA39a+QY+js4G/rX6GPW+38D07/GHRr6uxq83j++xdC/wlmG/gfps/rjuwz9S3Ggfyk59C+lP/0rYfqnbQzSOjEYKcz8n1FV/SPGNKbyY8h8YjLH4P/+O/M0o0qe3+lR1w8KZW5kc3RyZWFtCmVuZG9iagoKMTUgMCBvYmoKPDwvVHlwZS9Gb250L1N1YnR5cGUvVHJ1ZVR5cGUvQmFzZUZvbnQvQkFBQUFBK05vdG9TYW5zLUJvbGQKL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciA0NgovV2lkdGhzWzAgMzg5IDY1NyAzODcgNjE5IDQ1NCA5ODIgNTkxIDI4NSAyNjAgNTc5IDU2MCA2NjAgNjM3IDgxMyA3NTYKNzk2IDY5MCA1NjUgNzQwIDk0MyAzMzEgNTUxIDY3MiA0MzQgNjMzIDY1NyA1MTQgMzA1IDYxOSA1NjkgNjA0CjQ5NyAzMDUgNTY5IDY1NyA2MzMgNjMzIDMwNSA2NTAgNTkxIDYzMyA1NzIgNTcyIDU3MiA2MjggMjg1IF0KL0ZvbnREZXNjcmlwdG9yIDEzIDAgUgovVG9Vbmljb2RlIDE0IDAgUgo+PgplbmRvYmoKCjE2IDAgb2JqCjw8L0xlbmd0aCAxNyAwIFIvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aDEgMTMwMDg+PgpzdHJlYW0KeJztemtwW9d54DnnPgAQD+INkpDIC1w+ARAiBb4k0RRI8A2KL5ESoAdJkCApWeJDFKVIVmIrelg2VSetlMROnHjTbZ3uesbphRy7djpt1Tad2cjJbnbW8Xhmm7Wa2Ww92042abte744J7nfOvQBJPdzNzv5cYHDPd875zjnf+/vOJVdXzs0iE7qMOBSdWUgtT3c0VSGEfoQQts+cX5XGC29MAHwffqtzy/ML56754whxYwiZF+ZPX5yL/XjyFwhZf4BQsenEbCp95o/7GxCq+Qns0XQCBqzZMI9QQA/98hMLqxeuWf/2MPRD0P/J6aWZ1Kpy/zXofwr9JxdSF5a/aPklRih4AvrSYmphtv/P3rJB/zmExOrlpbOru9G/2ECoXqHzyyuzyys3XqyBPj1vHX4YvvRjAlCkfcLxgqjTGwqMJrOl0GqzO11uT1FxiXfHztIyyeeXyysqq6prAsFQbXhXXX0E/f/Pw5+j8O1DfeQeQqQIoQ0rX5v9j+S9jY+Jf+NjtbeJA6OfkKLcOPkp9Ne34B2DbxzFSStCbL5r45Pt43RGm2slnRufaPO98G1DbfgE+mjj2+peDP6Gtm9uvozNlG2nCej++y2UU5r+fgtN++AbQiEc2Hgap9DP8/vv3jgP/c0zNDzyLv42uU9SuAx9me13H78E/XlcrPYVFJIUNJ7oSkpS/G1kGYkr4sEjCaXBq1Qnp+aktfGEQipS7+iRHs3MyNNen09BSQXF5M47YL+xqY5aBYcUaWquViEhKS0pd4cVvvLInWpsjHXNdCliV8KncBXJ0aMJn+zzriUkZXgYhqJJr6S0UKglmZQyKnYqrVTDkNaTlDo6X0cx7w4nJKBmLSUpBcOJKRiR6FwBhZoo1DTlnUomk16gVimIzShoNKGgOEUGrJg3rpRSqDSeetuKZijG2wKaTibTqaSCg8mkrKDhxGwyWatwIQlO5itSwIsQG04ogtyhiHIHcA6oU7UKH5KBEymdEaY7JDpDefSqNNOnYpjqmlG4gA8mY9KatAYHZOqEChDLSGJq2JsaTSbkpC8pKdGDCZjzUmFo59cqQkjRxYJ3EFFlK0JX7pBBR3JHSiHTcwqeASoUIVCr6EISJdUEvPBoWqI7KNGpJEWZ6mSk6kN3dCYU6+oI+PLaMoS2a69A3QUHgYQY8D0lda3JKapJJmHkpVpQJC8QmaMS9CmnOtUjjI9ZrpTDKuTdZG3rIlOIMXTHWMCBeXhlXzLgq1XMoQwhXUo61VmrWEKAKEmKOdZPlwMgdyQVC+2NQs8CvVqlELaxMpFIIIEZOFcpjE1Ja1OSUghCq1WsofhYIsOnO5PlinlWvlCr2ELxkUT8oDro9cG4g43bQxlkjY0nMlZrTMGpDqUwSK0crKkjY6YPCzwU7AZNcBXDiQwVHnDbsQb6hWMtAZ8My3KwV52nS8B56EgSOOkB+ntgdLuqHqPADEIOGaQVU1DbHYwx05UjhDKIdI0lFKvcIXUpJjA+owwG1yFNwfFv2u0YFaKOjrWpjF0MKs8HvX4QkxN4cwRrFVcog2nrBjnT1hPKcLQtCmV42haHMgJtS0IZkbbeUEZH2x2hjJ62O0MZA21rQnJO7oo4BRKWpbCCj1MHqVUCWybd+ckz6mRwy2RlfnJFnSwNIcUc/L/grwz4KwW6JOCPtj7gj7Z+4I+2MvBH23Lgj7YVwB9tK4E/2lYBf7StBv5oGwpJrcxMa0NwrH1KioFup2JMleB6IWqr4ZBSG1RqwQt3gQP0SI/RopxqkWkM/UwML+W+LqfajEnsopam7ApkBOzqSkD8o1zWbxHP43B2h6RGRnkEdlNxuh4+E5z1kbTQceT+HkujnW1yS2Y3dlFeG0AewMCj6QcnSbXUKo2hsKe1Vmn651DBoGcAvRlUhNwVUljqoYEARNu3ttYj90DkSECOgUAL0aEJY5cTJNwCEcut2ACNhyBawdAyBahDMcSCs2thWZJa12DPPdvRpLC6n8LLHTlsSZmisSQ6kniDSJzkfYNUciXJDhpf9RCqZbZC7gbPjj3oplM0xqkJiMSm0rLCxVJpmCaxlBfgKRrfHlyTAtIg6svdoGMZTuimyUkfY6fAfo84RFYjKQ/BA5QhgMEJD+0KO1KuKhgR8BxWI+jmWWAIe3OykGBUqNRkIbeCmPblpxQ9m++We+ihVIuteRFSZlRJK2gsEZZaIXdT6rVBidKlqUIRK6DXt7VMUJX4KGvXtCVTk39iCyWxnLqmaC3xIMs5FbdB/AhTKXYrtlhi2AuZVGpNhjNh7AS/3b9tdtQ7vG02+si1n7WiPaS0BD/rwI6Qsie4BrRRGwOmHosKCg0rYVgRYyxT+6xUJZ9SCuQOlXVqoDK4Txg8T92/EwIT5Jjckt/QpHv+X1kx5YnGsVYZQtUWe/ElNTq7IAC3BHNS6YbenqBP1uSicZMXQQ+IwKW6PdQg4OGOsNIAXt77mPE+2A47HUojwP0hpRmaOJViF4hb6oaEm5PWQIgatBIH8EDoDoQwAAYBwBQYCt3BbGQYADYyQnG6ABilOBQ4SHEoMEZxKDAeegNiYTtAhwDCDDocegOrYwmA1LEkxcMUOkLxGHSU4jHoGMVj0HF6ZgyACXomBSbpmRSYomdSIEVxugGYpjgUmKE4FEhTHArMMro6AJpjdFFontFFoROMLgqdZHRR6ElGF4VOMboodJrRRaEFkPHevAIXWU9pA3BJBfcDuEyFznpR6J2BXKvhrKggxTnLcLCGswqL9+V3Pcd6bMV5FaQrPqeCFP0C7KMhXFRBivCUClKES4Dbmt/v86zH0L+gghT9aRWk6M/ASg3hsgpShC+qIEW4ArhP5Pe7ynoM/ZoKUvTrKkjRn4WVGsINFaQIz6kgRXg+9IaBJ7mKtiOo6GcVrnz4Qi5F19LEShB9R/E/4Z7HIR0KROkbDI4gbhYRjMk4IgQf5wHCBxDSiQIPaJxNEF3BiM1nq/DZfBP45exLuDH7Lrm33hQhaUTfJKTg8SvY04hqopWwhBc4fpbtBVq/EkeCgI4D4lU0YKMfq2guCfpgM5f2xb/KnsFfzr6L5ezPcCO5N/Th4AbddxwILiZ+5EDDb1opVf1xpXg4EXXA3miSFwhCL8Q5sKKreMAb9SCevx5nUwLeMpOM2qBus5hNBh0w5MAO0ewM4t1ul022Nch+kbYRT6SpCR+emj58IdmZ6DELJceIf2I++3v48BfTE9n/Sor6AjVIowm9Tj4BLqvjSg0QYwQer8VV9rysl2M2+T2blZjdwQjs/3oiAYtA/uGNj/F94kNeVInORS3FmEdFmONFLAqcxl4ZbC6InDALDKFJHeMFiSKeJDlW5UdhwBxFI5MggpsE2HZhVO4v3eF22gqNBmDdi736POtVsijK/srGhqbm5saGSpCDrqqpyaETRZfTHdnd1Iil6YmojZcHY31TT189urcxMACWNfWtofSB5mDsKPEdmsjeHggFDowOH+Y5KdZQbO1weLO/4PiWSG0gPgiyagZe/wz0V4Kaow1G0J/HRDhShBHH9VPzmASagXCOA2UCDzfRAEYuh9Vi0KESXCIArYK/kpLYFNnt9ugqgUqVuGYXiCPUu7i/faW3+kCRtyi645UDA8HOHd72gr1PTc58fq/N1Gewvpuat5sHLYVUb1ag5SC5jYpQNPqEBROew4iAqSMgheO5qwImhD/OTEgEWhhtNzElyOmw26xmk14ERRXpgKgKlQCZ0maTG5ubI66IS7Y53VjvDJgtDUWBntDAAbnh5Zd3tYlCTGfY2duOWwLyyqXO7L36XaofDsLzTfI34DOFoDz6pgAMGMhhkrgWFzDHMWO+Sga8ccW0bXrtwenaz1odddFBzCE8v3U8mUxGHSYTRqZCE3iHTkBGbKSu4QD7cGq24QHfuOIsK3O6S0vbE+RvvDt3eunvh+sf0bdEINehjY+JC2AHGniTw9ymjwo8IeS6ql2gTHUPT24U+nQqJ+Zk1AxDDuTwO8ptorkoiDct1BaxOalB2oir18yXHGtITSc/l+wiResf9QSqjs/hyewfXE5PYA+TK9gcsYOruZAfffUtu4HwQo6kncD4NRqNNMPTYeo9nEiY6XlVd/Y9gAREXtUwRdVGvYCzOU0Id/xhHJCtx+PGCLzP7/HbrIUWkK8Lu/SqTYNkqUVHwIAaIyqnVcCh6odg4tiRvnAx3TZULBIeohFfNFw/3tWR7OnpKbi5tvZC2GeOFL6/ru/11/Udn7CmT52ZnHoyHy8p78OgCzVeUp48AtB2TQ2N6IGYmR+jOPh4PmZSfbjAG/2OSqoPh8upizA/3Bo2XxfEkmRDaubwhSMxiG8fVss1geNq1JydyP4djXhUJ+MbVlIHccCFZHSK6kTg8zrZooQX8mK/SWm9QZioqcVuyvZhnE1Jyx55u6RxzpKrZLfb5dLCvAdCnRpGmkDgeGzmIoh6xCNiIdFr4osG60c7cXuiLlrWQ/xrN5//UliyNTj+mtP3yXX9xyZsM6caJ1qPLeZsrQr4MqNiVBbdkbPnF/KSBksor6jw89SgnWrAYJp3C2qMZfomVTfO9ixFr6/2Lu/PnoqPjgwMjI72Y/P1W+1fSF7/7fZLycmlpcnJ06dz+Qd/ieXEOVWCRlAZsoJbYdLvpT0u10uqCHYWGDhelbAWE9xMrvmQkZtIRgvVXAnRDjKloApRDb3ilkw5VOi3GM2SuaY3mOgt4IsPEj/HjXB87UhT9uekaDoUzckHA60eVIpi0agJLNIMIYL0IwFhIuDZbXoFT5oEqm5yA8WQInZ4i0qLS22FBXpRQB7s0fQJavS5cylAEyjTqK+yEpd3phuzv0OSw5GhQM1w84HV9n2nuvf36bANtxF/60Jf49FJh/2A3db21JHE0529I72d4yqdVogZfhYzTrxl47fFDGpuNPHm4gVVK6QIjrvBMftk4eyBmLIVJxl1etxIiwTUpZzlVXqzJyjQ1JtPwiwcNEdsHHC2GQa+TzjRMxJNXbw0vX+4iDd3/2q0G3ce7u3u/tUv7HU2fx2NBnVy36ef4F1HJ+xzJ89MTp5CaCtPpSiILkcL3RwRBRA+D0rgcoWGX4+hNJvEOqKVGPwkJMCbNOaxKoJ5YCXwdT2uYuZrkYcRk9FiqQyjyvKyoBQsKbJajAZQXCkuNWg2RLmjPlDVyExf5V7LMv5c0UEd0tE4XiqYus9dOh8f+lzXEMF80/KJc+fOxvp7e0b6B4i/uqZn/cOzq/6RwEi3y1RrGLl19fKL/admZk4eTrkWpoD9jQ3N9rKkEvIr1LLgL+8w/6kmE+jXJAt5tzIjpjujXh0mwGE/qBjhq4CyCj8jMro4syuYEVGnw2UhOrmxjTT/2ly/p2ivpdxvJNkC+549dpO9sdkNe0agtrgDsq5B4WjQCxa+Q0cwB2aNaXGhiugF1dnUoFARUoNChRqdGt1aNKisChPNGFSXA7G4PaUE31mdbhkpk47uirW69zQ29FcvHakfryj191c17Sl5IhLprfzK4LDdOmz1BsudkuR0VreEOvud1m6LUy71lJY6HNV7UC5+cIeAVh86/lZpEdksqt08plFLJ+o5lg4glas5ogT0fT2uzerJ1kmIvRjt9HogzNoKtQLbh32GhwvsbYV2ZDd9kt89euTwwmDs8OJIGy25i8frnq4UvLnCO/nMkUPZD6DJ199HwiGVB/r4FGqOQuSLljL99dMK4zrkNRbFYL4QFXptPC2+uYijlHgioD9HhHv33YkVvd0CBZ/Vrl+Z+BEpyv7A3bTbao00unHr+kfq/jUbz6C7YAh6GtWpYSA8TkMALewxgqsRzOid1ECaPaKok5uamt/RWeqK2i07davGxmea9jzXQG1QrfWpDQqaDb6p5cOPIR/SPO1Dt2i82ZIPadS4thlGtHxHT4cyKVejPIwEfG9mRqo135ZZik6OP4iT3IxMPo9vS2SCXC/mkr2WPnWyzQEK1Ly04XWOCJ7h/emLT83sH/bo7Pv/26H29kRvD/nkHf8+mz8MYem3wlIn+SR7f3qenzn5ZPpd9hfnDSvOgt5KUFW0vMQhQGloh3BENO1tiSYVcrGVOogj4gAHAFqo8sQtztLcjCdWC4tEXiyxLEz+7c7EYFG52VhmC7fYdoBS/11Nr694pAbXrb8ycETgugnfEOxhuu3d+Af0A3QRXNwRtaLNQr/cT69qzQ2bXPeWFxdXVhYXlzdVlJZWlEtS/q77j3DXFVjGR+gK9WsysWl5AhJsquVB4epzpY7gFrgrPzuMyMYPN6xaze9Fr0YLrBCOCxn/av3vzUUIKNXYVZbKg95LbuTvAHmUtUei1P5zu0SLKRM8XAUemqP3AfDhIo/TbvKaveV+EXhwbJEHtxmpaEkuDpa61ZtBS0mluVBySIFEL/nX6v3A++k1ndAjCHI9ObX+Unxc9St6EbtK1qEeOBYttGCeK9SB6UOcZFffnYx4nmdVwLU4AZsQjoO9sjKFRaJi7d3C/ENzyajBUVGhvVrAMgQauJdtj6SuCB64kZiYOHqwrMnhsQbcoeAN/F42hN+rKS07cdSo6xIK9u2Xqd+qdxrqtwbNb/99PqdUsXGzNv4u82f6eJr8GEZsqD4aNmMeoqoIYqaingOLvpKPmHo9BA+b3ga4OpvNpgN381X5dDKOYA6CfxWEEx1crbO/GD+KPSPY/W+HOYuZ19vEkZ/9jPx4PYJrP9AHak1l+2wfqHme2TNQZASpUovUlL+tniovL2fpZqs2bY+y9FyLf15ZWloJJp+9sNX2nwD+v0TeQxLaF20B6yU2uD6XYl4A3ni+nxo/j4TZnB8zG835F6inUlbVE7Ftlm7bUx117EYZv/g/9p6PL700dPg751pPhf2Vk5HLX24+P7Wrw/stfDH7Lx325Ktnll496nYOWotfvj5+ta9A957mm+RF8E072hktARsBLVC/vBLX7p8em5tFFZ+M6YWApiMcgYxri5AXT2av8EQ8eAJ/gYdoOUZG5BPN2TPguRlrNO7Dt7X9uQDs76Lxy1FAr9SscMCgXx6CGT1DvTbZHDY3vTb5uNxBEMkiNA9C1cPhb/4dz/EHr/81f/9aUiD8L8lK2ck92SE47Y9I33oT/qOGOWn9y0zmVfD4Q4iZBvpuTQehBviCiEGDznGUu2BrL5zsNrvKn68R+xp9LuzDf5i9gKXsr/Fy9j9jeS/+RmdHdpHZDZVVgL2zc6Ld0V0IYgLh8SxNFeg4fX92RbsSmE1wvbCYnGZngQFuBUZs1OWvVqJMXQ2uXWr5gkt/63LjF06NHnnzaO9cOknuLab3zUche987kP0vHUNdnZoNJcGG2DshqB64IgNwVAB1CNdPbyLMZtdYUNVeZGHkdlpMcKvT3gnhXLW49QoAJQWYEb599tqlS+GxmurxfQu3+oa+sXhmrNw3Qq5/49nrL1tNg4WWI99ZPv3q8cBAYRHQkgTZzoAMTMgbLSowCEyf6itLJs8S9vrOx7RGHbOqOYJnDhFi9ToGwn/eh/8x2LDD6ra17fua6ou7gTc98FaKQqgtus+KBd4AfOjVQlAAexTIPMQFfpPJXEUolUHlHJJCFVXl5Tp2XbQQNdtFdkPpkr8nsNtjVU4CrGYkem/PF2edTdaq+u6jTUVE9Iy2HzvTMt/VuRj9h7ahWHddd5W/E3/9wFcv9gpC3BweOrnXX39mPn56b9fNZ0fHuoaqWqXgWIvKQz3wYCQ/ffBOu7btTlteIWt32i1kbbvTGutOjl88u+vE+IXz2adjI8NdXcMjMTy3+vuJv3x99fcP//l3b9/6na/cunWLnUlt4idwZiHkxceeCeFjy5l5WWw79Sfx26eWbvf23l4+dSu+/qOVixfPLF98agXPLb167Nh3lhZePXb01aUbL79848bXv07vAqB/1Qek6E4jmDd4MdE/YAQu1Qh8jc22KvApnc2DA9ns2BgmY2MNDrLP2dDgXP8rB/XVAmDGB/vpqD3RNynMRXMb0TffavSB5ORzyTh25EPi+U/k0tAQrK2DtdR2vPStvMVMIHDlHV0LppuOXlVRnXP05jay+fpWjehgqS4f0Wer/7gxXtnd0jhYsyuw0JleDY82fxWf7PuTprHh+n1PlEv75Pq5RMv0VONtXs3PdnhsQKwxUi0YRAjjD1bWdrvdxjIJF/E0RziHXKWT33snvfb8zDt/mb71lRlsx+K9e9n/lf3l+++r97Au2NPCcuZuGBCRY2f+HoJeh7M4VofRK6YmpW2vzIu25Dj6N4tCrerK/WVhS46TVelCeI1wW3Lb7+0pPrVaXlJcUVFcUv5DgtdP5zIaVnO383tDP50sbP3vSMex8v8/WJ56JvfvfLRig9tSllFOtEGs/s8d2vxgtP3TQBJogoRQijyJxlkZADU/qUdhfB8145PICv1BmBsi86iZ4kA7DrbSjL8FbQOMzWs/gHExqsYfogj3B7DXp7CXCdXQveganAUxmFAvMaEUhvoSJ1Ah2xf2Is8w3F7yAXoC7hop7ibgvI+qYC5FLsBYK0rCbzf86jkzegIfhLtxCBVAv47YaGGOuijd2Ix6gacAOoS+Dd+7uAl/Hv+AVJNl8ktuL/cd7j7fxK/x/ySsCpeF10QkTou3xLfEv9C16S7rvq37U32b/pb+Ff1r+o8MpYZFwyuGDwr4gmjBswXfNVqN/cZnjd81/shkMbWYOk1HTM9q0mxAtSDvCGicoJfQaxAAEH7evEDvXexy932YwTytzibgp8LUfic0mCALWtZgDjWhpzWYR370PQ0W0G+j9zVYRBKe02Ad6sTParAeBfA9DTaAHv5JgwtQB9mhwUbURnLnmlAr+aYGm8nXQPYqbIHSaBHF0BJQdRGtoJNoHp2AG6YEXlGH6lEjQD0wuwTjp9Es9PrQIppBYYDaYeQ0tKP5VWdZbxbaWdjrPDzTgDkIq1fhJ6GDkN0XYZbizKNzsDoFeLsBp45998FZQ/DtASi3Krem9oFVD+8qPYBxiFFxFqhbgnnpMecsavvUAuYSrF0B7mbRXo3/ZnjuYXLYC20dzMxBuwcsIIJaYHaG7SbBDqswk4L1dK8TcOYik2I1SAF8AjBrfgOOTjJuUmzfFWjTgLfAcE7B2BKc9DitHGC80n0ugkbVGbpynlE0/5mYnUxzVJdUWmPQS8HaraNUnxKahhXSI9ant61f1daHmWWsAs5etAu+n2PfMGBt0h8GipYAdxf0ZwF3V14rux6zeuGB0zd3OAtj54AWqvUxpgkqy26Gv8qshcpvFXah8pzNS/s0tFTzi8x6KZ/nAE4zG6LcnGC4B0F+A9AOsVMXt+08sG2HEIw8aIHUEuqZ7/wmlKVZu8q8c5pZmEqfumeKPf3gjQeZdg8CLKEO1qc9SsdhgMYgWg5Bdhtj/XawvVF4DkK/D3LhQcbTKDxj0A6C1vvYDIXVuW7m8YNQm0ooDjMUh+49C1Sp0llhvQsgmRVmCWcZjSuMjwUYpRJWIwLldZZx+JvLVQIZLW3TyVm2Zgaw5himxPxpkXlWilkUpXOZUbjAZJnTyFlNfmlN/wuMlxT8NuepnZ5naxfzPnRRixTURlSaVJ9c/T/Qahgir5rDv8kqj4c/8bfRvxlNZDD+UlLB6v+OLWeQriNqfPN3X0BLkyi2y4ACbMT5r/Rf0V/Wn+fmxENiP9+kL9cZ9NrUHfEVcU28hBf5CX6YRMVagU1ZO9qNgWhFFCrLu8V3XXftd813DVFIIgaYLIZJFH3oyyY51Jkpx8+NJJToc4kMl+7MVNPe23pEu6gz6c1U0YHv6y9Daok+NzOmDtNP1Pma/mv6K/oL3AkxIQ7wLfpKncEUeBtvXFf4FzIEdb4hpEXU2Qns/29aVF7qCmVuZHN0cmVhbQplbmRvYmoKCjE3IDAgb2JqCjczODYKZW5kb2JqCgoxOCAwIG9iago8PC9UeXBlL0ZvbnREZXNjcmlwdG9yL0ZvbnROYW1lL0NBQUFBQStOb3RvU2Fucy1SZWd1bGFyCi9GbGFncyA0Ci9Gb250QkJveFstNjIxIC0zODkgMjc5OSAxMDY3XS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgMAovRGVzY2VudCAwCi9DYXBIZWlnaHQgMTA2NwovU3RlbVYgODAKL0ZvbnRGaWxlMiAxNiAwIFIKPj4KZW5kb2JqCgoxOSAwIG9iago8PC9MZW5ndGggNDQ0L0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nF2TzY6bMBRG9zyFl9PFCPwTmEgRUiYBKYvOjJr2AQg4KdIEkEMWefv6ux/TSl0kOr6+vj421+nusD8M/Zx+hLE9+lmd+6EL/jbeQ+vVyV/6IdFGdX07LyP5b6/NlKRx7fFxm/31MJzHzSZJf8S52xwe6mnbjSf/LUnfQ+dDP1zU06/dMY6P92n69Fc/zCpLylJ1/hzrfG+mt+bqU1n1fOjidD8/nuOSfwk/H5NXRsaaKu3Y+dvUtD40w8Unmywr1aauy8QP3X9zbs0lp3P7uwkxVcfULHOrMrIRziuwFTYZ2DG+A6/IGpyTLbgQLhz4hfE1eM241N8yLjmv5Bfwjjmy157xGlwxbsA146ijM8bhoOmfF2D6V9hX07+Am17892D6FzmY/gbn0vSvpObij3314i816W9wP5r+TtbSP9+CF3+pT/9a4vSv4WPo77CXob9FjqG/w1kM/R32MvR38DeLv+TTf4V7M/R3Up/+VurT38Lf0N9K/uKPezb0d5JD/xW+kaG/xT0Y+hf4Xpb+FXws/eMx0GxLV6Ht8C6+2lm19xBiK8vjkR5G9/aD//u+pnHCKvn9AU7z3mMKZW5kc3RyZWFtCmVuZG9iagoKMjAgMCBvYmoKPDwvVHlwZS9Gb250L1N1YnR5cGUvVHJ1ZVR5cGUvQmFzZUZvbnQvQ0FBQUFBK05vdG9TYW5zLVJlZ3VsYXIKL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciA0OQovV2lkdGhzWzAgNTU2IDYxOCAyNjAgMjU4IDU2MSA0ODAgMzYxIDI1OCA2MTggNjE1IDYxOCA2MTUgNjA1IDQxMyA1NjQKNjE1IDYxNSA1NjQgNDc5IDkzNSA1MDggMjY4IDU2MSA2MTUgNTEwIDI2OCA1MjQgMjU4IDM0NCA2MTggNjA1CjYzOSAyNjggNzI4IDc2MCA5MDcgNDcwIDYwNSA2MzIgNTcyIDU3MiA1NzIgNzgxIDMzOSA1NTYgNTcyIDUyOQoyNTggMjY5IF0KL0ZvbnREZXNjcmlwdG9yIDE4IDAgUgovVG9Vbmljb2RlIDE5IDAgUgo+PgplbmRvYmoKCjIxIDAgb2JqCjw8L0YxIDE1IDAgUi9GMiAyMCAwIFIKPj4KZW5kb2JqCgoyMiAwIG9iago8PC9Gb250IDIxIDAgUgovUHJvY1NldFsvUERGL1RleHRdCj4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDEwIDAgUi9SZXNvdXJjZXMgMjIgMCBSL01lZGlhQm94WzAgMCA2MTIgNzkyXS9Db250ZW50cyAyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDEwIDAgUi9SZXNvdXJjZXMgMjIgMCBSL01lZGlhQm94WzAgMCA2MTIgNzkyXS9Db250ZW50cyA1IDAgUj4+CmVuZG9iagoKNyAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDEwIDAgUi9SZXNvdXJjZXMgMjIgMCBSL01lZGlhQm94WzAgMCA2MTIgNzkyXS9Db250ZW50cyA4IDAgUj4+CmVuZG9iagoKMjMgMCBvYmoKPDwvQ291bnQgOC9GaXJzdCAyNCAwIFIvTGFzdCAyNCAwIFIKPj4KZW5kb2JqCgoyNCAwIG9iago8PC9Db3VudCA3L0ZpcnN0IDI1IDAgUi9MYXN0IDMxIDAgUgovVGl0bGU8RkVGRjAwNDkwMDZFMDA2NjAwNkYwMDcyMDA2RDAwNjUwMDNBMDAyMDAwNTQwMDQ1MDA1MjAwNDMwMDQ1MDA1MjAwMjAwMDQ1MDA0RTAwNDMwMDU1MDA0NTAwNEUwMDU0MDA1MjAwNEYwMDIwMDA0RTAwNDEwMDQzMDA0OTAwNEYwMDRFMDA0MTAwNEMwMDIwMDA0NDAwNDUwMDIwMDA0RDAwNTUwMDRBMDA0NTAwNTIwMDQ1MDA1MzAwMjAwMDQxMDA0MzAwNDUwMDQyPgovRGVzdFsxIDAgUi9YWVogOTAgNjk2IDBdL1BhcmVudCAyMyAwIFI+PgplbmRvYmoKCjI1IDAgb2JqCjw8L0NvdW50IDAvVGl0bGU8RkVGRjAwNDkwMDZFMDA3NDAwNzIwMDZGMDA2NDAwNzUwMDYzMDA2MzAwNjkwMEYzMDA2RT4KL0Rlc3RbMSAwIFIvWFlaIDkwIDYzOC40IDBdL1BhcmVudCAyNCAwIFIvTmV4dCAyNiAwIFI+PgplbmRvYmoKCjI2IDAgb2JqCjw8L0NvdW50IDAvVGl0bGU8RkVGRjAwNEUwMDc1MDA2NTAwNzYwMDYxMDA3MzAwMjAwMDZEMDA2MTAwNzMwMDYzMDA3NTAwNkMwMDY5MDA2RTAwNjkwMDY0MDA2MTAwNjQwMDY1MDA3MzAwMjAwMDc5MDAyMDAwNkMwMDYxMDAyMDAwNkMwMDc1MDA2MzAwNjgwMDYxMDAyMDAwNzAwMDZGMDA3MjAwMjAwMDZDMDA2MTAwMjAwMDY5MDA2NzAwNzUwMDYxMDA2QzAwNjQwMDYxMDA2ND4KL0Rlc3RbMSAwIFIvWFlaIDkwIDM3Mi44IDBdL1BhcmVudCAyNCAwIFIvUHJldiAyNSAwIFIvTmV4dCAyNyAwIFI+PgplbmRvYmoKCjI3IDAgb2JqCjw8L0NvdW50IDAvVGl0bGU8RkVGRjAwNEMwMDYxMDAyMDAwNzAwMDYxMDA3MjAwNzQwMDY5MDA2MzAwNjkwMDcwMDA2MTAwNjMwMDY5MDBGMzAwNkUwMDIwMDA2NDAwNjUwMDIwMDA2QzAwNjEwMDczMDAyMDAwNkQwMDc1MDA2QTAwNjUwMDcyMDA2NTAwNzMwMDIwMDA2NTAwNkUwMDIwMDA2NTAwNkMwMDIwMDA3MzAwNjkwMDZFMDA2NDAwNjkwMDYzMDA2MTAwNkMwMDY5MDA3MzAwNkQwMDZGPgovRGVzdFs0IDAgUi9YWVogOTAgNjMzLjYgMF0vUGFyZW50IDI0IDAgUi9QcmV2IDI2IDAgUi9OZXh0IDI4IDAgUj4+CmVuZG9iagoKMjggMCBvYmoKPDwvQ291bnQgMC9UaXRsZTxGRUZGMDA1NjAwNjkwMDZGMDA2QzAwNjUwMDZFMDA2MzAwNjkwMDYxMDAyMDAwNjQwMDY1MDAyMDAwNjcwMEU5MDA2RTAwNjUwMDcyMDA2RjAwMjAwMDY1MDA2RTAwMjAwMDY1MDA2QzAwMjAwMDc0MDA3MjAwNjEwMDYyMDA2MTAwNkEwMDZGMDAyMDAwNzkwMDIwMDA2NTAwNkMwMDIwMDA0MzAwNkYwMDZFMDA3NjAwNjUwMDZFMDA2OTAwNkYwMDIwMDAzMTAwMzkwMDMwMDAyMDAwNjQwMDY1MDAyMDAwNkMwMDYxMDAyMDAwNEYwMDQ5MDA1ND4KL0Rlc3RbNCAwIFIvWFlaIDkwIDM4Ni44IDBdL1BhcmVudCAyNCAwIFIvUHJldiAyNyAwIFIvTmV4dCAyOSAwIFI+PgplbmRvYmoKCjI5IDAgb2JqCjw8L0NvdW50IDAvVGl0bGU8RkVGRjAwNTAwMDcyMDA2RjAwNzQwMDZGMDA2MzAwNkYwMDZDMDA2RjAwMjAwMDY0MDA2NTAwMjAwMDYxMDA3NDAwNjUwMDZFMDA2MzAwNjkwMEYzMDA2RTAwMjAwMDY1MDA2RTAwMjAwMDYzMDA2MTAwNzMwMDZGMDA3MzAwMjAwMDY0MDA2NTAwMjAwMDc2MDA2OTAwNkYwMDZDMDA2NTAwNkUwMDYzMDA2OTAwNjEwMDIwMDA2NDAwNjUwMDIwMDA2NzAwRTkwMDZFMDA2NTAwNzIwMDZGPgovRGVzdFs0IDAgUi9YWVogOTAgMjA2LjQgMF0vUGFyZW50IDI0IDAgUi9QcmV2IDI4IDAgUi9OZXh0IDMwIDAgUj4+CmVuZG9iagoKMzAgMCBvYmoKPDwvQ291bnQgMC9UaXRsZTxGRUZGMDA0RDAwNzUwMDZBMDA2NTAwNzIwMDY1MDA3MzAwMkMwMDIwMDA3NDAwNzIwMDYxMDA2MjAwNjEwMDZBMDA2RjAwMjAwMDc5MDAyMDAwNzMwMDYxMDA2QzAwNzUwMDY0PgovRGVzdFs3IDAgUi9YWVogOTAgNTM4LjQgMF0vUGFyZW50IDI0IDAgUi9QcmV2IDI5IDAgUi9OZXh0IDMxIDAgUj4+CmVuZG9iagoKMzEgMCBvYmoKPDwvQ291bnQgMC9UaXRsZTxGRUZGMDA0MzAwNkYwMDZFMDA2MzAwNkMwMDc1MDA3MzAwNjkwMEYzMDA2RT4KL0Rlc3RbNyAwIFIvWFlaIDkwIDM5NS42IDBdL1BhcmVudCAyNCAwIFIvUHJldiAzMCAwIFI+PgplbmRvYmoKCjEwIDAgb2JqCjw8L1R5cGUvUGFnZXMKL1Jlc291cmNlcyAyMiAwIFIKL01lZGlhQm94WyAwIDAgNjEyIDc5MiBdCi9LaWRzWyAxIDAgUiA0IDAgUiA3IDAgUiBdCi9Db3VudCAzPj4KZW5kb2JqCgozMiAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMTAgMCBSCi9PcGVuQWN0aW9uWzEgMCBSIC9YWVogbnVsbCBudWxsIDBdCi9PdXRsaW5lcyAyMyAwIFIKL0xhbmcoZW4tVVMpCj4+CmVuZG9iagoKMzMgMCBvYmoKPDwvQXV0aG9yPEZFRkYwMDcwMDA3OTAwNzQwMDY4MDA2RjAwNkUwMDJEMDA2NDAwNkYwMDYzMDA3OD4KL0NyZWF0b3I8RkVGRjAwNTcwMDcyMDA2OTAwNzQwMDY1MDA3Mj4KL1Byb2R1Y2VyPEZFRkYwMDRDMDA2OTAwNjIwMDcyMDA2NTAwNEYwMDY2MDA2NjAwNjkwMDYzMDA2NTAwMjAwMDM3MDAyRTAwMzQ+Ci9DcmVhdGlvbkRhdGUoRDoyMDI1MDMxMDIzMTIzNlonKT4+CmVuZG9iagoKeHJlZgowIDM0CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAyMTg2NyAwMDAwMCBuIAowMDAwMDAwMDE5IDAwMDAwIG4gCjAwMDAwMDE4NTAgMDAwMDAgbiAKMDAwMDAyMTk2NiAwMDAwMCBuIAowMDAwMDAxODcxIDAwMDAwIG4gCjAwMDAwMDM1NzMgMDAwMDAgbiAKMDAwMDAyMjA2NSAwMDAwMCBuIAowMDAwMDAzNTk0IDAwMDAwIG4gCjAwMDAwMDQ3MTIgMDAwMDAgbiAKMDAwMDAyNDI5MiAwMDAwMCBuIAowMDAwMDA0NzMzIDAwMDAwIG4gCjAwMDAwMTIxNTIgMDAwMDAgbiAKMDAwMDAxMjE3NCAwMDAwMCBuIAowMDAwMDEyMzY2IDAwMDAwIG4gCjAwMDAwMTI4NjQgMDAwMDAgbiAKMDAwMDAxMzIwNyAwMDAwMCBuIAowMDAwMDIwNjgwIDAwMDAwIG4gCjAwMDAwMjA3MDIgMDAwMDAgbiAKMDAwMDAyMDg5NyAwMDAwMCBuIAowMDAwMDIxNDExIDAwMDAwIG4gCjAwMDAwMjE3NjkgMDAwMDAgbiAKMDAwMDAyMTgxMiAwMDAwMCBuIAowMDAwMDIyMTY0IDAwMDAwIG4gCjAwMDAwMjIyMjAgMDAwMDAgbiAKMDAwMDAyMjUyOCAwMDAwMCBuIAowMDAwMDIyNjcyIDAwMDAwIG4gCjAwMDAwMjI5NzIgMDAwMDAgbiAKMDAwMDAyMzI4MCAwMDAwMCBuIAowMDAwMDIzNjMyIDAwMDAwIG4gCjAwMDAwMjM5NTIgMDAwMDAgbiAKMDAwMDAyNDE1NiAwMDAwMCBuIAowMDAwMDI0NDA0IDAwMDAwIG4gCjAwMDAwMjQ1MTkgMDAwMDAgbiAKdHJhaWxlcgo8PC9TaXplIDM0L1Jvb3QgMzIgMCBSCi9JbmZvIDMzIDAgUgovSUQgWyA8QTMyOUJGMUI2NEM3ODQ2MjA3NEZDOEM2MDkzRDZERjI+CjxBMzI5QkYxQjY0Qzc4NDYyMDc0RkM4QzYwOTNENkRGMj4gXQovRG9jQ2hlY2tzdW0gL0ExMDg2QzhCRUIxRjgzQzU5QTI1NEU5NDVDMjExNEEyCj4+CnN0YXJ0eHJlZgoyNDc0NwolJUVPRgo=\"\n }\n ]\n}'" } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success": { "value": { "id": "b001d824-3f3f-48fc-98ef-a3114b918c1e", "account_id": "210a524f-7ad3-437a-be7e-9e99bdf4d742", "description": "Test Purchase", "country": "AR", "status": "IN_DISPUTE", "sub_status": "PENDING_REVIEW", "merchant_order_id": "65742358", "created_at": "2025-11-26T20:34:08.330622Z", "updated_at": "2025-11-26T20:34:12.580560Z", "amount": { "captured": 0, "currency": "ARS", "currency_conversion": null, "refunded": 0, "value": 2000 }, "checkout": null, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": null, "installment_amount": null, "installments_total_amount": null, "soft_descriptor": "", "authorization_code": "393119", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Diaz", "iin": "45130761", "lfd": "5348", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "BANCOLOMBIA", "issuer_code": null, "country_code": "CO", "category": "CLASSIC", "type": "CREDIT", "fingerprint": "2213e58a-33d7-4bdc-8cbe-4785f683c410", "expiration_month": 6, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": "1b9ef2f7-b69e-4dd0-b0a1-3605dfc2ad2f", "merchant_customer_id": "6a1b6e7e0e104f28929015fd6182e9f9", "first_name": "Margarita", "last_name": "Parra", "gender": "NB", "date_of_birth": "1952-02-27", "email": "qpacheco@example.com", "nationality": "AR", "ip_address": "205.52.88.44", "device_fingerprint": "90ede54c-d2d4-4e2e-8189-6b81091231b0", "device_fingerprints": [ { "provider_id": "DEFAULT", "id": "90ede54c-d2d4-4e2e-8189-6b81091231b0" }, { "provider_id": "CLEAR_SALE", "id": "c1c4907c-3339-4217-a4bd-1e9be74b3819" }, { "provider_id": "CYBERSOURCE", "id": "d5c56387-4d06-479b-b55b-eab81e5211bc" }, { "provider_id": "OPENPAY", "id": "89451345904503181146447710703990" }, { "provider_id": "MERCADO_PAGO", "id": "armor.cofxzlvhsrpuslf5ychwxvszwaicsanbuub2on7rfuzmyfijppqm8vcziky3h3emxkz3b2aopl04ublu0jufbtwk8sm232fin19btcnd3q1jdpku6cp9ybn8exc2vcuoalosq51bpfefzhsqx4tuythte5jaruh4keo2fcm9r9wwy96s8djk0e5nmsi8z6pfi7e94tsoe7h09s227umko9kyf4p0xanqn" } ], "browser_info": { "user_agent": "Chrome", "accept_header": "true", "accept_content": "true", "accept_browser": "true", "color_depth": "red", "screen_height": "500", "screen_width": "100", "javascript_enabled": true, "java_enabled": true, "browser_time_difference": "-3:00", "language": "es", "platform": null }, "document": { "document_type": "DNI", "document_number": "82183204" }, "phone": { "number": "91112345678", "country_code": "54" }, "billing_address": { "address_line_1": "Avenida Putumayo 1780", "address_line_2": "Diagonal 181G 6572", "country": "AR", "state": "Álava", "city": "Suárez", "zip_code": "25207", "neighborhood": "Barrio Núñez" }, "shipping_address": { "address_line_1": "Diagonal 61 2487", "address_line_2": "Av. carrera 54 7627", "country": "AR", "state": "Guipúzcoa", "city": "San Benito", "zip_code": "31718", "neighborhood": "Villa La Esperanza" }, "merchant_customer_created_at": "2025-11-26T20:34:06.941Z", "geolocation": { "latitude": "80.00", "longitude": "103.00" } }, "additional_data": { "airline": { "pnr": "ABC123", "legs": [ { "order": null, "route_order": null, "passenger_id": null, "departure_airport": "JFK", "departure_datetime": "2024-07-03T05:00:00", "departure_airport_timezone": "GMT-05", "arrival_airport": "LAX", "arrival_airport_timezone": "+00:00", "arrival_datetime": "2030-07-03T22:59:00", "carrier_code": "AA", "flight_number": "123", "fare_basis_code": "Y", "fare_class_code": "S", "base_fare": 1800, "base_fare_currency": "USD", "stopover_code": "O", "departure_airport_country": "NL", "departure_airport_city": "Amsterdam", "arrival_airport_country": "AR", "arrival_airport_city": "Buenos aires", "expedited_boarding": null, "extra_baggage": null, "purchased_meals": null, "selected_seat": null } ], "passengers": [ { "id": null, "first_name": "Antonio", "last_name": "Vargas", "middle_name": "Piedad", "type": "A", "date_of_birth": "1999-12-17", "nationality": "US", "document": { "document_type": "DNI", "document_number": "82183204" }, "country": "CO", "loyalty_number": "79250001", "loyalty_tier": "DIAMOND", "email": "anaarias@example.com", "phone": { "number": "91112345678", "country_code": "54" }, "address": null, "evidence_document_source": null }, { "id": null, "first_name": "Álvaro", "last_name": "Bravo", "middle_name": "Edwin", "type": "C", "date_of_birth": "1973-07-25", "nationality": "CO", "document": { "document_type": "DNI", "document_number": "82183204" }, "country": "CO", "loyalty_number": "79250002", "loyalty_tier": "SILVER", "email": "leidysanchez@example.com", "phone": { "number": "91112345678", "country_code": "54" }, "address": null, "evidence_document_source": null } ], "type": null, "ticket": { "ticket_number": "BRB0001", "passenger_id": null, "e_ticket": true, "restricted": false, "total_fare_amount": 2000, "total_tax_amount": 180, "total_fee_amount": 20, "issue": { "carrier_prefix_code": "AA", "travel_agent_code": "A12345", "travel_agent_name": "TRAVEL AGENCY", "date": "2023-10-31", "address": "123 Main St", "city": "New York", "country": "US", "zip_code": "10001", "booking_system_code": "1G", "booking_system_name": "Galileo" } }, "tickets": [ { "ticket_number": "BRB0001", "passenger_id": null, "e_ticket": true, "restricted": false, "total_fare_amount": 2000, "total_tax_amount": 180, "total_fee_amount": 20, "issue": { "carrier_prefix_code": "AA", "travel_agent_code": "A12345", "travel_agent_name": "TRAVEL AGENCY", "date": "2023-10-31", "address": "123 Main St", "city": "New York", "country": "US", "zip_code": "10001", "booking_system_code": "1G", "booking_system_name": "Galileo" } } ] }, "transportations": null, "order": { "fee_amount": 1, "shipping_amount": 3, "tip_amount": 2, "items": [ { "id": "97029", "name": "SKIRT", "quantity": 3, "unit_amount": 2000, "category": "OTHERS", "brand": "Barrera Group", "sku_code": "SC-01905", "manufacture_part_number": "MPN-70919" }, { "id": "61906", "name": "SKIRT", "quantity": 1, "unit_amount": 2000, "category": "OTHERS", "brand": "Suárez-Castellanos", "sku_code": "SC-14444", "manufacture_part_number": "MPN-43825" } ], "taxes": [ { "type": "VAT", "tax_base": 100, "value": 10, "percentage": 10 } ], "shipping": { "type": "ELECTRONIC", "description": "q4O6W8x8ONwpbgHjlxlz", "carrier": "AR_OCA", "deliver_at": "2025-11-26T20:34:07.500866Z", "recipients": [] }, "account_funding": { "sender": { "national_entity": null, "first_name": "Reinaldo", "last_name": "Rojas", "legal_name": null, "email": null, "country": null, "date_of_birth": null, "document": null, "phone": null, "address": null }, "beneficiary": { "national_entity": null, "first_name": "Leidy", "last_name": "González", "legal_name": null, "email": null, "country": "AR", "date_of_birth": "1983-12-07", "document": null, "phone": { "number": "91112345678", "country_code": "54" }, "address": { "address_line_1": "Calle 4ª 3050", "address_line_2": "Carrera 98 6425", "country": "AR", "city": "", "zip_code": "", "neighborhood": "Barrio Colegiales" } } }, "tickets": [ { "id": "57bfc6e7-c270-4fcc-a578-a76e6eaa4576", "name": "Ticket vitae", "description": "Description 4I%n", "type": "VIRTUAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "3e9d0621-e8ca-4415-9025-95d568cac569", "name": "Event doloremque", "description": "Description ipsam", "type": "CIRCUS", "date": "2025-11-26", "address": { "address_line_1": "Diagonal 33 2395", "address_line_2": "Cl. 112E 6497", "city": "Paz de Ariporo", "country": "AR", "state": "Lleida", "zip_code": "18124", "neighborhood": "Conjunto Los Laureles" } } }, { "id": "f842ae67-2f7d-4415-9d9e-9a51d2712c13", "name": "Ticket aspernatur", "description": "Description jS3*", "type": "VIRTUAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "af726450-abf5-49d1-b43a-9e65f88d606e", "name": "Event officia", "description": "Description quo", "type": "CIRCUS", "date": "2025-11-26", "address": { "address_line_1": "Tr. 194B 459", "address_line_2": "Cl. 102L Sur 2950", "city": "Moniquirá", "country": "AR", "state": "Segovia", "zip_code": "31278", "neighborhood": "Barrio Los Olivos" } } }, { "id": "51100a8e-04ec-45c1-8fea-2fa70a7966d3", "name": "Ticket hic", "description": "Description mR;2", "type": "PHYSICAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "2164fb39-7be3-46aa-adc9-310eb33b4f05", "name": "Event hic", "description": "Description beatae", "type": "SPORTS", "date": "2025-11-26", "address": { "address_line_1": "Av. Pérez 8882", "address_line_2": "Carrera 23 5900", "city": "Vijes", "country": "AR", "state": "Zamora", "zip_code": "24300", "neighborhood": "Barrio El Paraíso" } } }, { "id": "6f465375-0ded-4ac7-848c-39450bff069d", "name": "Ticket totam", "description": "Description t0}E", "type": "VIRTUAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "e564bf42-0385-4ad8-a38a-eb481a434cbf", "name": "Event neque", "description": "Description facilis", "type": "OTHERS", "date": "2025-11-26", "address": { "address_line_1": "Avenida carrera 153 3115", "address_line_2": "Cr. 121G Bis 4048", "city": "La Ceja", "country": "AR", "state": "Castellón", "zip_code": "39464", "neighborhood": "Conjunto Belgrano" } } }, { "id": "b40b5fb7-3a1b-4315-bf01-4ba9b7ef99aa", "name": "Ticket esse", "description": "Description wI2;", "type": "VIRTUAL", "amount": { "value": 2000, "currency": "ARS" }, "event": { "id": "a4f1f47f-8853-4ac2-b574-6b05d4a611fd", "name": "Event eos", "description": "Description natus", "type": "CINEMA", "date": "2025-11-26", "address": { "address_line_1": "Cr. 6E Bis 3665", "address_line_2": "Carrera 9 Este 1918", "city": "Teorama", "country": "AR", "state": "Madrid", "zip_code": "32993", "neighborhood": "Villa Las Flores" } } } ], "fulfillment": null, "discounts": [ { "id": "10FF", "name": "10% Discount", "unit_amount": 10 } ], "sales_channel": "marketplace" }, "seller_details": { "name": "Mendoza-Cerón", "website": "http://navarro.info/category/postsregister.html", "email": "iospina@example.net", "address": { "address_line_1": "Av. calle 5ª 3906", "address_line_2": "Dg. 8ª 8965", "country": "AR", "state": "ARGENTINA", "city": "Curití", "zip_code": "15484" }, "reference": "39245884", "country": "AR", "phone": { "number": "6844503463", "country_code": "23" }, "document": { "document_type": "DNI", "document_number": "82183204" }, "industry": "ELECTRONICS", "merchant_category_code": "6628" } }, "transactions": { "id": "4a963490-70c2-4669-975a-a6901b4b5abf", "type": "CHARGEBACK", "status": "CREATED", "category": "CARD", "amount": 2000, "provider_id": "BAMBOO", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": null, "installment_amount": null, "installments_total_amount": null, "soft_descriptor": "", "authorization_code": "393119", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "Pepito Perez", "iin": "45130761", "lfd": "5348", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "BANCOLOMBIA", "issuer_code": null, "country_code": "CO", "category": "CLASSIC", "type": "CREDIT", "fingerprint": "2213e58a-33d7-4bdc-8cbe-4785f683c410", "expiration_month": 6, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "CHARGEBACK_CREATED", "reason": "REQUESTED_BY_CUSTOMER", "description": "webhook transaction", "merchant_reference": "Reference-ac04c8a6-78c7-4588-b915-5498455369ef", "provider_data": { "id": "BAMBOO", "transaction_id": "121030201030210312", "account_id": "", "status": "APPROVED", "sub_status": "", "status_detail": "", "response_message": null, "response_code": null, "raw_response": null, "third_party_transaction_id": null, "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null, "merchant_advice_code": null, "merchant_advice_code_message": null, "reason_code": null, "reason_description": null }, "connection_data": { "id": null, "name": null }, "created_at": "2025-11-26T20:34:12.529203Z", "updated_at": "2025-11-26T20:34:12.559289Z", "merchant_advice_code": null, "merchant_advice_code_message": null }, "transactions_history": null, "split_marketplace": [], "callback_url": "https://example.com/callback", "workflow": "DIRECT", "metadata": [ { "key": "explicabo", "value": "nihil" }, { "key": "quas", "value": "veritatis" }, { "key": "numquam", "value": "placeat" }, { "key": "eos", "value": "quo" }, { "key": "corrupti", "value": "eveniet" }, { "key": "occaecati", "value": "consectetur" } ], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": { "smart_routing": false, "monitors": false, "condition": { "id": 64972, "name": null, "description": null } }, "simplified_mode": false }, "summary": "Success" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "b001d824-3f3f-48fc-98ef-a3114b918c1e" }, "account_id": { "type": "string", "example": "210a524f-7ad3-437a-be7e-9e99bdf4d742" }, "description": { "type": "string", "example": "Test Purchase" }, "country": { "type": "string", "example": "AR" }, "status": { "type": "string", "example": "IN_DISPUTE" }, "sub_status": { "type": "string", "example": "PENDING_REVIEW" }, "merchant_order_id": { "type": "string", "example": "65742358" }, "created_at": { "type": "string", "example": "2025-11-26T20:34:08.330622Z" }, "updated_at": { "type": "string", "example": "2025-11-26T20:34:12.580560Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "ARS" }, "currency_conversion": {}, "refunded": { "type": "integer", "example": 0, "default": 0 }, "value": { "type": "integer", "example": 2000, "default": 0 } } }, "checkout": {}, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "parent_payment_method_type": {}, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": {}, "installment_amount": {}, "installments_total_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "393119" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Diaz" }, "iin": { "type": "string", "example": "45130761" }, "lfd": { "type": "string", "example": "5348" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "BANCOLOMBIA" }, "issuer_code": {}, "country_code": { "type": "string", "example": "CO" }, "category": { "type": "string", "example": "CLASSIC" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "2213e58a-33d7-4bdc-8cbe-4785f683c410" }, "expiration_month": { "type": "integer", "example": 6, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "1b9ef2f7-b69e-4dd0-b0a1-3605dfc2ad2f" }, "merchant_customer_id": { "type": "string", "example": "6a1b6e7e0e104f28929015fd6182e9f9" }, "first_name": { "type": "string", "example": "Margarita" }, "last_name": { "type": "string", "example": "Parra" }, "gender": { "type": "string", "example": "NB" }, "date_of_birth": { "type": "string", "example": "1952-02-27" }, "email": { "type": "string", "example": "qpacheco@example.com" }, "nationality": { "type": "string", "example": "AR" }, "ip_address": { "type": "string", "example": "205.52.88.44" }, "device_fingerprint": { "type": "string", "example": "90ede54c-d2d4-4e2e-8189-6b81091231b0" }, "device_fingerprints": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "example": "DEFAULT" }, "id": { "type": "string", "example": "90ede54c-d2d4-4e2e-8189-6b81091231b0" } } } }, "browser_info": { "type": "object", "properties": { "user_agent": { "type": "string", "example": "Chrome" }, "accept_header": { "type": "string", "example": "true" }, "accept_content": { "type": "string", "example": "true" }, "accept_browser": { "type": "string", "example": "true" }, "color_depth": { "type": "string", "example": "red" }, "screen_height": { "type": "string", "example": "500" }, "screen_width": { "type": "string", "example": "100" }, "javascript_enabled": { "type": "boolean", "example": true, "default": true }, "java_enabled": { "type": "boolean", "example": true, "default": true }, "browser_time_difference": { "type": "string", "example": "-3:00" }, "language": { "type": "string", "example": "es" }, "platform": {} } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "DNI" }, "document_number": { "type": "string", "example": "82183204" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "91112345678" }, "country_code": { "type": "string", "example": "54" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Avenida Putumayo 1780" }, "address_line_2": { "type": "string", "example": "Diagonal 181G 6572" }, "country": { "type": "string", "example": "AR" }, "state": { "type": "string", "example": "Álava" }, "city": { "type": "string", "example": "Suárez" }, "zip_code": { "type": "string", "example": "25207" }, "neighborhood": { "type": "string", "example": "Barrio Núñez" } } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Diagonal 61 2487" }, "address_line_2": { "type": "string", "example": "Av. carrera 54 7627" }, "country": { "type": "string", "example": "AR" }, "state": { "type": "string", "example": "Guipúzcoa" }, "city": { "type": "string", "example": "San Benito" }, "zip_code": { "type": "string", "example": "31718" }, "neighborhood": { "type": "string", "example": "Villa La Esperanza" } } }, "merchant_customer_created_at": { "type": "string", "example": "2025-11-26T20:34:06.941Z" }, "geolocation": { "type": "object", "properties": { "latitude": { "type": "string", "example": "80.00" }, "longitude": { "type": "string", "example": "103.00" } } } } }, "additional_data": { "type": "object", "properties": { "airline": { "type": "object", "properties": { "pnr": { "type": "string", "example": "ABC123" }, "legs": { "type": "array", "items": { "type": "object", "properties": { "order": {}, "route_order": {}, "passenger_id": {}, "departure_airport": { "type": "string", "example": "JFK" }, "departure_datetime": { "type": "string", "example": "2024-07-03T05:00:00" }, "departure_airport_timezone": { "type": "string", "example": "GMT-05" }, "arrival_airport": { "type": "string", "example": "LAX" }, "arrival_airport_timezone": { "type": "string", "example": "+00:00" }, "arrival_datetime": { "type": "string", "example": "2030-07-03T22:59:00" }, "carrier_code": { "type": "string", "example": "AA" }, "flight_number": { "type": "string", "example": "123" }, "fare_basis_code": { "type": "string", "example": "Y" }, "fare_class_code": { "type": "string", "example": "S" }, "base_fare": { "type": "integer", "example": 1800, "default": 0 }, "base_fare_currency": { "type": "string", "example": "USD" }, "stopover_code": { "type": "string", "example": "O" }, "departure_airport_country": { "type": "string", "example": "NL" }, "departure_airport_city": { "type": "string", "example": "Amsterdam" }, "arrival_airport_country": { "type": "string", "example": "AR" }, "arrival_airport_city": { "type": "string", "example": "Buenos aires" }, "expedited_boarding": {}, "extra_baggage": {}, "purchased_meals": {}, "selected_seat": {} } } }, "passengers": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "first_name": { "type": "string", "example": "Antonio" }, "last_name": { "type": "string", "example": "Vargas" }, "middle_name": { "type": "string", "example": "Piedad" }, "type": { "type": "string", "example": "A" }, "date_of_birth": { "type": "string", "example": "1999-12-17" }, "nationality": { "type": "string", "example": "US" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "DNI" }, "document_number": { "type": "string", "example": "82183204" } } }, "country": { "type": "string", "example": "CO" }, "loyalty_number": { "type": "string", "example": "79250001" }, "loyalty_tier": { "type": "string", "example": "DIAMOND" }, "email": { "type": "string", "example": "anaarias@example.com" }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "91112345678" }, "country_code": { "type": "string", "example": "54" } } }, "address": {}, "evidence_document_source": {} } } }, "type": {}, "ticket": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "BRB0001" }, "passenger_id": {}, "e_ticket": { "type": "boolean", "example": true, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 2000, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 180, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 20, "default": 0 }, "issue": { "type": "object", "properties": { "carrier_prefix_code": { "type": "string", "example": "AA" }, "travel_agent_code": { "type": "string", "example": "A12345" }, "travel_agent_name": { "type": "string", "example": "TRAVEL AGENCY" }, "date": { "type": "string", "example": "2023-10-31" }, "address": { "type": "string", "example": "123 Main St" }, "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" }, "booking_system_code": { "type": "string", "example": "1G" }, "booking_system_name": { "type": "string", "example": "Galileo" } } } } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "ticket_number": { "type": "string", "example": "BRB0001" }, "passenger_id": {}, "e_ticket": { "type": "boolean", "example": true, "default": true }, "restricted": { "type": "boolean", "example": false, "default": true }, "total_fare_amount": { "type": "integer", "example": 2000, "default": 0 }, "total_tax_amount": { "type": "integer", "example": 180, "default": 0 }, "total_fee_amount": { "type": "integer", "example": 20, "default": 0 }, "issue": { "type": "object", "properties": { "carrier_prefix_code": { "type": "string", "example": "AA" }, "travel_agent_code": { "type": "string", "example": "A12345" }, "travel_agent_name": { "type": "string", "example": "TRAVEL AGENCY" }, "date": { "type": "string", "example": "2023-10-31" }, "address": { "type": "string", "example": "123 Main St" }, "city": { "type": "string", "example": "New York" }, "country": { "type": "string", "example": "US" }, "zip_code": { "type": "string", "example": "10001" }, "booking_system_code": { "type": "string", "example": "1G" }, "booking_system_name": { "type": "string", "example": "Galileo" } } } } } } } }, "transportations": {}, "order": { "type": "object", "properties": { "fee_amount": { "type": "integer", "example": 1, "default": 0 }, "shipping_amount": { "type": "integer", "example": 3, "default": 0 }, "tip_amount": { "type": "integer", "example": 2, "default": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "97029" }, "name": { "type": "string", "example": "SKIRT" }, "quantity": { "type": "integer", "example": 3, "default": 0 }, "unit_amount": { "type": "integer", "example": 2000, "default": 0 }, "category": { "type": "string", "example": "OTHERS" }, "brand": { "type": "string", "example": "Barrera Group" }, "sku_code": { "type": "string", "example": "SC-01905" }, "manufacture_part_number": { "type": "string", "example": "MPN-70919" } } } }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "VAT" }, "tax_base": { "type": "integer", "example": 100, "default": 0 }, "value": { "type": "integer", "example": 10, "default": 0 }, "percentage": { "type": "integer", "example": 10, "default": 0 } } } }, "shipping": { "type": "object", "properties": { "type": { "type": "string", "example": "ELECTRONIC" }, "description": { "type": "string", "example": "q4O6W8x8ONwpbgHjlxlz" }, "carrier": { "type": "string", "example": "AR_OCA" }, "deliver_at": { "type": "string", "example": "2025-11-26T20:34:07.500866Z" }, "recipients": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "account_funding": { "type": "object", "properties": { "sender": { "type": "object", "properties": { "national_entity": {}, "first_name": { "type": "string", "example": "Reinaldo" }, "last_name": { "type": "string", "example": "Rojas" }, "legal_name": {}, "email": {}, "country": {}, "date_of_birth": {}, "document": {}, "phone": {}, "address": {} } }, "beneficiary": { "type": "object", "properties": { "national_entity": {}, "first_name": { "type": "string", "example": "Leidy" }, "last_name": { "type": "string", "example": "González" }, "legal_name": {}, "email": {}, "country": { "type": "string", "example": "AR" }, "date_of_birth": { "type": "string", "example": "1983-12-07" }, "document": {}, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "91112345678" }, "country_code": { "type": "string", "example": "54" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 4ª 3050" }, "address_line_2": { "type": "string", "example": "Carrera 98 6425" }, "country": { "type": "string", "example": "AR" }, "city": { "type": "string", "example": "" }, "zip_code": { "type": "string", "example": "" }, "neighborhood": { "type": "string", "example": "Barrio Colegiales" } } } } } } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "57bfc6e7-c270-4fcc-a578-a76e6eaa4576" }, "name": { "type": "string", "example": "Ticket vitae" }, "description": { "type": "string", "example": "Description 4I%n" }, "type": { "type": "string", "example": "VIRTUAL" }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 2000, "default": 0 }, "currency": { "type": "string", "example": "ARS" } } }, "event": { "type": "object", "properties": { "id": { "type": "string", "example": "3e9d0621-e8ca-4415-9025-95d568cac569" }, "name": { "type": "string", "example": "Event doloremque" }, "description": { "type": "string", "example": "Description ipsam" }, "type": { "type": "string", "example": "CIRCUS" }, "date": { "type": "string", "example": "2025-11-26" }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Diagonal 33 2395" }, "address_line_2": { "type": "string", "example": "Cl. 112E 6497" }, "city": { "type": "string", "example": "Paz de Ariporo" }, "country": { "type": "string", "example": "AR" }, "state": { "type": "string", "example": "Lleida" }, "zip_code": { "type": "string", "example": "18124" }, "neighborhood": { "type": "string", "example": "Conjunto Los Laureles" } } } } } } } }, "fulfillment": {}, "discounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "10FF" }, "name": { "type": "string", "example": "10% Discount" }, "unit_amount": { "type": "integer", "example": 10, "default": 0 } } } }, "sales_channel": { "type": "string", "example": "marketplace" } } }, "seller_details": { "type": "object", "properties": { "name": { "type": "string", "example": "Mendoza-Cerón" }, "website": { "type": "string", "example": "http://navarro.info/category/postsregister.html" }, "email": { "type": "string", "example": "iospina@example.net" }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Av. calle 5ª 3906" }, "address_line_2": { "type": "string", "example": "Dg. 8ª 8965" }, "country": { "type": "string", "example": "AR" }, "state": { "type": "string", "example": "ARGENTINA" }, "city": { "type": "string", "example": "Curití" }, "zip_code": { "type": "string", "example": "15484" } } }, "reference": { "type": "string", "example": "39245884" }, "country": { "type": "string", "example": "AR" }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "6844503463" }, "country_code": { "type": "string", "example": "23" } } }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "DNI" }, "document_number": { "type": "string", "example": "82183204" } } }, "industry": { "type": "string", "example": "ELECTRONICS" }, "merchant_category_code": { "type": "string", "example": "6628" } } } } }, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "4a963490-70c2-4669-975a-a6901b4b5abf" }, "type": { "type": "string", "example": "CHARGEBACK" }, "status": { "type": "string", "example": "CREATED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 2000, "default": 0 }, "provider_id": { "type": "string", "example": "BAMBOO" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "parent_payment_method_type": {}, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": {}, "installment_amount": {}, "installments_total_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "393119" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "Pepito Perez" }, "iin": { "type": "string", "example": "45130761" }, "lfd": { "type": "string", "example": "5348" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "BANCOLOMBIA" }, "issuer_code": {}, "country_code": { "type": "string", "example": "CO" }, "category": { "type": "string", "example": "CLASSIC" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "2213e58a-33d7-4bdc-8cbe-4785f683c410" }, "expiration_month": { "type": "integer", "example": 6, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "CHARGEBACK_CREATED" }, "reason": { "type": "string", "example": "REQUESTED_BY_CUSTOMER" }, "description": { "type": "string", "example": "webhook transaction" }, "merchant_reference": { "type": "string", "example": "Reference-ac04c8a6-78c7-4588-b915-5498455369ef" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "BAMBOO" }, "transaction_id": { "type": "string", "example": "121030201030210312" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "APPROVED" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": {}, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": {}, "third_party_transaction_id": {}, "third_party_account_id": {}, "iso8583_response_code": {}, "iso8583_response_message": {}, "merchant_advice_code": {}, "merchant_advice_code_message": {}, "reason_code": {}, "reason_description": {} } }, "connection_data": { "type": "object", "properties": { "id": {}, "name": {} } }, "created_at": { "type": "string", "example": "2025-11-26T20:34:12.529203Z" }, "updated_at": { "type": "string", "example": "2025-11-26T20:34:12.559289Z" }, "merchant_advice_code": {}, "merchant_advice_code_message": {} } }, "transactions_history": {}, "split_marketplace": { "type": "array", "items": { "type": "object", "properties": {} } }, "callback_url": { "type": "string", "example": "https://example.com/callback" }, "workflow": { "type": "string", "example": "DIRECT" }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "explicabo" }, "value": { "type": "string", "example": "nihil" } } } }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": {}, "routing_rules": { "type": "object", "properties": { "smart_routing": { "type": "boolean", "example": false, "default": true }, "monitors": { "type": "boolean", "example": false, "default": true }, "condition": { "type": "object", "properties": { "id": { "type": "integer", "example": 64972, "default": 0 }, "name": {}, "description": {} } } } }, "simplified_mode": { "type": "boolean", "example": false, "default": true } } } } } } }, "deprecated": false, "tags": [ "Payments" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/payments/{id}/transactions/{transaction_id}/refund": { "post": { "summary": "Refund Payment", "description": "", "operationId": "refund-payment", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the payment (UUID, 36 chars).", "schema": { "type": "string" }, "required": true }, { "name": "transaction_id", "in": "path", "description": "The unique identifier of the transaction (UUID, 36 chars).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchant_reference" ], "properties": { "description": { "type": "string", "description": "Description of the refund. (MAX 255; MIN 3)." }, "reason": { "type": "string", "description": "Indicating the reason for the refund. If set, possible values are `DUPLICATE`, `FRAUDULENT`, `REQUESTED_BY_CUSTOMER`, and `REVERSE`. Use `REVERSE` to request an automatic reverse of the recipient funds when a recipient is involved in the transaction.", "enum": [ "DUPLICATE", "FRAUDULENT", "REQUESTED_BY_CUSTOMER", "REVERSE" ] }, "merchant_reference": { "type": "string", "description": "Identification of the payment transaction defined by the merchant (MAX 255; MIN 3)." }, "amount": { "type": "object", "description": "Specifies the amount object for refund. **Only required for partial refunds**.", "properties": { "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." }, "value": { "type": "number", "format": "float", "description": "The refund amount (multiple of 0.0001)." } } }, "split_marketplace": { "type": "array", "description": "Split marketplace array of objects", "items": { "properties": { "recipient_id": { "type": "string", "description": "The unique identifier of the recipient in the Yuno system.
You must provide the [`recipient_id`](/reference/create-recipient-1) (Yuno-generated) or the `provider_recipient_id` (external provider's ID) when creating a payment." }, "provider_recipient_id": { "type": "string", "description": "The recipient ID provided by the external payment provider, if applicable.
You must provide the `provider_recipient_id` or the [`recipient_id`](/reference/create-recipients) (Yuno-generated) when creating a payment." }, "description": { "type": "string", "description": "Description for the split. (MAX 255; MIN 3)." }, "type": { "type": "string", "description": "The type of split. `recipient_id` is mandatory for `PURCHASE` and `MARKETPLACE`.", "enum": [ "PURCHASE", "PAYMENTFEE", "VAT", "COMMISSION", "MARKETPLACE", "SHIPPING" ] }, "merchant_reference": { "type": "string", "description": "Optional unique identifier for the split transaction (MAX 255; MIN 3)." }, "recipient_type": { "type": "string", "description": "The type of recipient for the provider.", "enum": [ "MEAL", "FOOD", "MULTI_BENEFITS", "FLEET" ], "example": "MEAL" }, "amount": { "type": "object", "description": "Defines the amount of the split.", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The split amount (multiple of 0.0001).", "format": "float" }, "currency": { "type": "string", "description": "The currency used to make the payment. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217)." } } }, "liability": { "type": "object", "description": "Optional information regarding the recipient's liability for fees and chargebacks.", "properties": { "processing_fee": { "type": "string", "description": "Indicates who will be charged the transaction fee.", "enum": [ "MERCHANT", "RECIPIENT", "SHARED" ] }, "chargebacks": { "type": "boolean", "description": "The recipient is responsible in case of a chargeback." } } } }, "required": [ "type" ], "type": "object" } }, "simplified_mode": { "type": "boolean", "description": "Determines whether Yuno should automatically attempt to refund a payment after an initial error or decline. When set to `true`, Yuno will retry the process if the first attempt fails. By default, this is set to `false`. Access [Transaction Retries](https://docs.y.uno/docs/transaction-retries) for more details." }, "response_additional_data": { "type": "object", "description": "Specifies additional data for required the transaction response", "properties": { "receipt": { "type": "boolean", "description": "Indicates if a receipt is necessary for the transaction response" }, "receipt_language": { "type": "string", "description": "Indicates the language of the receipt to be generated", "enum": [ "ES", "EN", "PT" ] } } }, "customer_payer": { "type": "object", "description": "Specifies customer object for payments.", "properties": { "first_name": { "type": "string", "description": "The customer's first name (MAX 255; MIN 3)." }, "last_name": { "type": "string", "description": "The customer's last name (MAX 255; MIN 3)." }, "gender": { "type": "string", "description": "The customer's gender (MAX 2; MIN 1).
- M=Male
- F=Female
- NB=Non Binary
- NA=Not applicable
- NK=Not Known
- U=Undefined.", "enum": [ "M", "F", "NB", "NA", "NK", "U" ] }, "date_of_birth": { "type": "string", "description": "The customer's date of birth in the `YYYY-MM-DD` format (Length: 10)." }, "email": { "type": "string", "description": "The customer's e-mail (MAX 255; MIN 3)." }, "nationality": { "type": "string", "description": "The customer's nationality (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference))." }, "document": { "type": "object", "description": "Specifies the customer's document object, including its number and type.", "required": [ "document_number", "document_type" ], "properties": { "document_number": { "type": "string", "description": "Document number for customer (MAX 40; MIN 3)" }, "document_type": { "type": "string", "description": "The customer's document type (MAX 6, MIN 2). Access [Document Type List](/reference/country-reference) for more details.", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC" ] } } }, "phone": { "type": "object", "description": "Specifies the customer's phone object.", "properties": { "country_code": { "type": "string", "description": "The country code of the customer's phone (MAX 3; MIN 1)." }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1)." } } }, "billing_address": { "type": "object", "description": "Specifies the customer's billing address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the billing address (MAX 2; MIN 2; [ISO 3166-1](https://docs.y.uno/reference/customer-object#country-code-list-iso-3166-1)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state considered for the billing address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the billing address (MAX 10; MIN 5)." } } }, "shipping_address": { "type": "object", "description": "Specifies the customer's shipping address object.", "properties": { "address_line_1": { "type": "string", "description": "The primary shipping address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary shipping address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the shipping address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country considered for the shipping address (MAX 2; MIN 2; [ISO 3166-1](https://docs.y.uno/reference/customer-object#country-code-list-iso-3166-1)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state considered for the shipping address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the shipping address (MAX 10; MIN 5)." } } } } }, "payment_method": { "type": "object", "description": "Specifies payment method object for payments.", "properties": { "detail": { "type": "object", "description": "Specifies the payment method detail object.", "properties": { "bank_transfer": { "type": "object", "description": "Specifies bank transfer payment method details.", "properties": { "account_type": { "type": "string", "description": "Type of bank account (MAX 255; MIN 3)", "enum": [ "CHECKINGS", "SAVINGS" ] }, "bank_name": { "type": "string", "description": "Name of the bank (MAX 255; MIN 3)" }, "bank_id": { "type": "string", "description": "ID of the bank (MAX 255; MIN 3)" }, "beneficiary_name": { "type": "string", "description": "Name of the account holder (MAX 255; MIN 3)" }, "bank_account": { "type": "string", "description": "Bank account number (MAX 255; MIN 3)" }, "beneficiary_document_type": { "type": "string", "description": "Document type of the account holder (MAX 255; MIN 3)" }, "beneficiary_document": { "type": "string", "description": "Document number of the account holder (MAX 255; MIN 3)" }, "reference": { "type": "string", "description": "Reference code for the user (MAX 255; MIN 1)" }, "bank_account_mask_number": { "type": "string", "description": "Masked bank account number associated with the bank transfer (for example, ****6789). This is account data, not mandate data." }, "mandate": { "type": "object", "description": "Direct debit mandate details, for bank transfer methods that operate with mandates (for example, ACH, SEPA, BACS, PAD).", "properties": { "id": { "type": "string", "description": "Mandate identifier, as provided by the payment provider." }, "info": { "type": "string", "description": "Free-text mandate information." }, "received_status": { "type": "string", "description": "Provider status indicating whether the mandate was received. Forwarded as provided by the payment provider." }, "existing_status": { "type": "string", "description": "Provider status of the existing mandate. Forwarded as provided by the payment provider." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was created (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the mandate was last updated (ISO 8601)." } } } } } } } } } } }, "examples": { "Full Refund": { "value": { "description": "Duplicate", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "AAB01-432245" } }, "Partial Refund": { "value": { "amount": { "currency": "USD", "value": 30 }, "description": "Duplicate transaction", "reason": "REQUESTED_BY_CUSTOMER", "merchant_reference": "US-INV-432245" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Full Refund": { "value": { "id": "f2d6884a-f737-4565-ae32-ff60b19089e3", "account_id": "", "description": "Duplicate", "country": "US", "status": "REFUNDED", "sub_status": "REFUNDED", "merchant_order_id": "AAB01-432245", "created_at": "2025-04-14T17:51:45.179645Z", "updated_at": "2025-04-14T17:52:07.908698Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 30000, "value": 30000 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "216303", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CHASE BANK USA", "issuer_code": null, "country_code": "US", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "d244e20d-43a1-43f7-9b48-0a76423be35e", "expiration_month": 3, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1744653105", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "john.doe@example.com", "nationality": "US", "ip_address": "192.168.1.1", "device_fingerprint": null, "device_fingerprints": [], "browser_info": null, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "1234 Elm Street", "address_line_2": "Apt 5B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001", "neighborhood": null }, "shipping_address": { "address_line_1": "1234 Elm Street", "address_line_2": "Apt 5B", "country": "US", "state": "California", "city": "Los Angeles", "zip_code": "90001", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "5414f862-51e6-433f-a54c-b46b176e87a0", "type": "REFUND", "status": "SUCCEEDED", "category": "CARD", "amount": 30000, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "216303", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CHASE BANK USA", "issuer_code": null, "country_code": "US", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "d244e20d-43a1-43f7-9b48-0a76423be35e", "expiration_month": 3, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": "REQUESTED_BY_CUSTOMER", "description": "Test refund", "merchant_reference": "REFUND_001", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "2e5c04d5-4cf7-4d2a-b57a-dd5eb9a687bc", "account_id": "", "status": "", "sub_status": "", "status_detail": "", "response_message": null, "response_code": "SUCCEEDED", "raw_request": { "amount": { "currency": "BRL", "value": 2100 }, "reference": "34343434" }, "raw_response": { "message": "provider response" }, "third_party_transaction_id": null, "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": null, "created_at": "2025-04-14T17:52:07.768528Z", "updated_at": "2025-04-14T17:52:07.862912Z" }, "transactions_history": null, "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": null, "simplified_mode": false } }, "Partial Refund": { "value": { "id": "b908fd70-9af7-41a6-8e1c-3a5ec78ea88b", "account_id": "", "description": "Duplicate transaction", "country": "US", "status": "SUCCEEDED", "sub_status": "PARTIALLY_REFUNDED", "merchant_order_id": "0000023", "created_at": "2025-04-14T17:50:55.936358Z", "updated_at": "2025-04-14T17:51:23.347308Z", "amount": { "captured": 0, "currency": "USD", "currency_conversion": null, "refunded": 30, "value": 300 }, "checkout": { "session": "", "sdk_action_required": false }, "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "payment_method_detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "344836", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CHASE BANK USA", "issuer_code": null, "country_code": "US", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "d244e20d-43a1-43f7-9b48-0a76423be35e", "expiration_month": 3, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "customer_payer": { "id": null, "merchant_customer_id": "1744653056", "first_name": "John", "last_name": "Doe", "gender": "M", "date_of_birth": "1990-02-28", "email": "john.doe@example.com", "nationality": "US", "ip_address": "192.0.2.1", "device_fingerprint": null, "device_fingerprints": [], "browser_info": null, "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "number": "5551234567", "country_code": "1" }, "billing_address": { "address_line_1": "456 Maple Ave", "address_line_2": "Apt 12C", "country": "US", "state": "New York", "city": "New York", "zip_code": "10001", "neighborhood": null }, "shipping_address": { "address_line_1": "456 Maple Ave", "address_line_2": "Apt 12C", "country": "US", "state": "New York", "city": "New York", "zip_code": "10001", "neighborhood": null }, "merchant_customer_created_at": null }, "additional_data": null, "transactions": { "id": "3f47548e-a1c9-418e-b899-40d30da9c699", "type": "REFUND", "status": "SUCCEEDED", "category": "CARD", "amount": 30, "provider_id": "YUNO_TEST_PAYMENT_GW", "payment_method": { "vaulted_token": "", "type": "CARD", "vault_on_success": false, "token": "", "parent_payment_method_type": null, "detail": { "card": { "verify": false, "capture": false, "installments": 1, "installments_plan_id": null, "first_installment_deferral": 0, "installments_type": "MERCHANT", "installment_amount": null, "soft_descriptor": "", "authorization_code": "344836", "retrieval_reference_number": "", "acquirer_reference_number": "", "voucher": null, "card_data": { "holder_name": "John Doe", "iin": "41111111", "lfd": "1111", "number_length": 16, "security_code_length": 3, "brand": "VISA", "issuer_name": "CHASE BANK USA", "issuer_code": null, "country_code": "US", "category": "CLASSIC", "type": "DEBIT", "three_d_secure": { "version": null, "electronic_commerce_indicator": null, "cryptogram": null, "transaction_id": null, "directory_server_transaction_id": null, "pares_status": null, "acs_id": null }, "fingerprint": "d244e20d-43a1-43f7-9b48-0a76423be35e", "expiration_month": 3, "expiration_year": 26 }, "stored_credentials": { "reason": null, "usage": null, "subscription_agreement_id": null, "network_transaction_id": null } } } }, "response_code": "SUCCEEDED", "response_message": "Transaction successful", "reason": "REQUESTED_BY_CUSTOMER", "description": "Test refund", "merchant_reference": "US-INV-432245", "provider_data": { "id": "YUNO_TEST_PAYMENT_GW", "transaction_id": "831017b2-928f-4f19-8f0b-0e0ae14013bd", "account_id": "", "status": "", "sub_status": "", "status_detail": "", "response_message": null, "response_code": "SUCCEEDED", "raw_response": { "message": "provider response" }, "third_party_transaction_id": null, "third_party_account_id": null, "iso8583_response_code": null, "iso8583_response_message": null }, "connection_data": null, "created_at": "2025-04-14T17:51:23.232152Z", "updated_at": "2025-04-14T17:51:23.322335Z" }, "transactions_history": null, "metadata": [], "fraud_screening": null, "payment_link_id": "", "subscription_code": null, "routing_rules": null, "simplified_mode": false } } }, "schema": { "oneOf": [ { "title": "Full Refund", "type": "object", "properties": { "id": { "type": "string", "example": "f2d6884a-f737-4565-ae32-ff60b19089e3" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Duplicate" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "REFUNDED" }, "sub_status": { "type": "string", "example": "REFUNDED" }, "merchant_order_id": { "type": "string", "example": "AAB01-432245" }, "created_at": { "type": "string", "example": "2025-04-14T17:51:45.179645Z" }, "updated_at": { "type": "string", "example": "2025-04-14T17:52:07.908698Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "currency_conversion": {}, "refunded": { "type": "integer", "example": 30000, "default": 0 }, "value": { "type": "integer", "example": 30000, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "parent_payment_method_type": {}, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "216303" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "CHASE BANK USA" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "CLASSIC" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": { "type": "string", "example": "d244e20d-43a1-43f7-9b48-0a76423be35e" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1744653105" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.168.1.1" }, "device_fingerprint": {}, "device_fingerprints": { "type": "array" }, "browser_info": {}, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1234 Elm Street" }, "address_line_2": { "type": "string", "example": "Apt 5B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "1234 Elm Street" }, "address_line_2": { "type": "string", "example": "Apt 5B" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "California" }, "city": { "type": "string", "example": "Los Angeles" }, "zip_code": { "type": "string", "example": "90001" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "5414f862-51e6-433f-a54c-b46b176e87a0" }, "type": { "type": "string", "example": "REFUND" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 30000, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "parent_payment_method_type": {}, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "216303" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "CHASE BANK USA" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "CLASSIC" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": { "type": "string", "example": "d244e20d-43a1-43f7-9b48-0a76423be35e" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": { "type": "string", "example": "REQUESTED_BY_CUSTOMER" }, "description": { "type": "string", "example": "Test refund" }, "merchant_reference": { "type": "string", "example": "REFUND_001" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "2e5c04d5-4cf7-4d2a-b57a-dd5eb9a687bc" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "message": { "type": "string", "example": "provider response" } } }, "third_party_transaction_id": {}, "third_party_account_id": {}, "iso8583_response_code": {}, "iso8583_response_message": {} } }, "connection_data": {}, "created_at": { "type": "string", "example": "2025-04-14T17:52:07.768528Z" }, "updated_at": { "type": "string", "example": "2025-04-14T17:52:07.862912Z" } } }, "transactions_history": {}, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": {}, "routing_rules": {}, "simplified_mode": { "type": "boolean", "example": false, "default": true } } }, { "title": "Partial Refund", "type": "object", "properties": { "id": { "type": "string", "example": "b908fd70-9af7-41a6-8e1c-3a5ec78ea88b" }, "account_id": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Duplicate transaction" }, "country": { "type": "string", "example": "US" }, "status": { "type": "string", "example": "SUCCEEDED" }, "sub_status": { "type": "string", "example": "PARTIALLY_REFUNDED" }, "merchant_order_id": { "type": "string", "example": "0000023" }, "created_at": { "type": "string", "example": "2025-04-14T17:50:55.936358Z" }, "updated_at": { "type": "string", "example": "2025-04-14T17:51:23.347308Z" }, "amount": { "type": "object", "properties": { "captured": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "USD" }, "currency_conversion": {}, "refunded": { "type": "integer", "example": 30, "default": 0 }, "value": { "type": "integer", "example": 300, "default": 0 } } }, "checkout": { "type": "object", "properties": { "session": { "type": "string", "example": "" }, "sdk_action_required": { "type": "boolean", "example": false, "default": true } } }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "parent_payment_method_type": {}, "payment_method_detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "344836" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "CHASE BANK USA" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "CLASSIC" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": { "type": "string", "example": "d244e20d-43a1-43f7-9b48-0a76423be35e" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "customer_payer": { "type": "object", "properties": { "id": {}, "merchant_customer_id": { "type": "string", "example": "1744653056" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "M" }, "date_of_birth": { "type": "string", "example": "1990-02-28" }, "email": { "type": "string", "example": "john.doe@example.com" }, "nationality": { "type": "string", "example": "US" }, "ip_address": { "type": "string", "example": "192.0.2.1" }, "device_fingerprint": {}, "device_fingerprints": { "type": "array" }, "browser_info": {}, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "5551234567" }, "country_code": { "type": "string", "example": "1" } } }, "billing_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "456 Maple Ave" }, "address_line_2": { "type": "string", "example": "Apt 12C" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "New York" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" }, "neighborhood": {} } }, "shipping_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "456 Maple Ave" }, "address_line_2": { "type": "string", "example": "Apt 12C" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "New York" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" }, "neighborhood": {} } }, "merchant_customer_created_at": {} } }, "additional_data": {}, "transactions": { "type": "object", "properties": { "id": { "type": "string", "example": "3f47548e-a1c9-418e-b899-40d30da9c699" }, "type": { "type": "string", "example": "REFUND" }, "status": { "type": "string", "example": "SUCCEEDED" }, "category": { "type": "string", "example": "CARD" }, "amount": { "type": "integer", "example": 30, "default": 0 }, "provider_id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "payment_method": { "type": "object", "properties": { "vaulted_token": { "type": "string", "example": "" }, "type": { "type": "string", "example": "CARD" }, "vault_on_success": { "type": "boolean", "example": false, "default": true }, "token": { "type": "string", "example": "" }, "parent_payment_method_type": {}, "detail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "capture": { "type": "boolean", "example": false, "default": true }, "installments": { "type": "integer", "example": 1, "default": 0 }, "installments_plan_id": {}, "first_installment_deferral": { "type": "integer", "example": 0, "default": 0 }, "installments_type": { "type": "string", "example": "" }, "installment_amount": {}, "soft_descriptor": { "type": "string", "example": "" }, "authorization_code": { "type": "string", "example": "344836" }, "retrieval_reference_number": { "type": "string", "example": "" }, "acquirer_reference_number": { "type": "string", "example": "" }, "voucher": {}, "card_data": { "type": "object", "properties": { "holder_name": { "type": "string", "example": "John Doe" }, "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer_name": { "type": "string", "example": "CHASE BANK USA" }, "issuer_code": {}, "country_code": { "type": "string", "example": "US" }, "category": { "type": "string", "example": "CLASSIC" }, "type": { "type": "string", "example": "DEBIT" }, "three_d_secure": { "type": "object", "properties": { "version": {}, "electronic_commerce_indicator": {}, "cryptogram": {}, "transaction_id": {}, "directory_server_transaction_id": {}, "pares_status": {}, "acs_id": {} } }, "fingerprint": { "type": "string", "example": "d244e20d-43a1-43f7-9b48-0a76423be35e" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 } } }, "stored_credentials": { "type": "object", "properties": { "reason": {}, "usage": {}, "subscription_agreement_id": {}, "network_transaction_id": {} } } } } } } } }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "response_message": { "type": "string", "example": "Transaction successful" }, "reason": { "type": "string", "example": "REQUESTED_BY_CUSTOMER" }, "description": { "type": "string", "example": "Test refund" }, "merchant_reference": { "type": "string", "example": "US-INV-432245" }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "YUNO_TEST_PAYMENT_GW" }, "transaction_id": { "type": "string", "example": "831017b2-928f-4f19-8f0b-0e0ae14013bd" }, "account_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "" }, "sub_status": { "type": "string", "example": "" }, "status_detail": { "type": "string", "example": "" }, "response_message": {}, "response_code": { "type": "string", "example": "SUCCEEDED" }, "raw_request": { "type": "object", "description": "Obfuscated copy of the request Yuno sent to the provider. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "properties": { "message": { "type": "string", "example": "provider response" } } }, "third_party_transaction_id": {}, "third_party_account_id": {}, "iso8583_response_code": {}, "iso8583_response_message": {} } }, "connection_data": {}, "created_at": { "type": "string", "example": "2025-04-14T17:51:23.232152Z" }, "updated_at": { "type": "string", "example": "2025-04-14T17:51:23.322335Z" } } }, "transactions_history": {}, "metadata": { "type": "array" }, "fraud_screening": {}, "payment_link_id": { "type": "string", "example": "" }, "subscription_code": {}, "routing_rules": {}, "simplified_mode": { "type": "boolean", "example": false, "default": true } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Payments" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/payments/{payment_id}/transactions/{transaction_id}/split-marketplace/transfer-reversal": { "post": { "description": "", "parameters": [ { "in": "path", "name": "payment_id", "schema": { "type": "string" }, "required": true, "description": "The unique identifier of the payment (MAX 64; MIN 36)." }, { "in": "path", "name": "transaction_id", "schema": { "type": "string" }, "required": true, "description": "The unique identifier of the transaction (MAX 64; MIN 36)." }, { "in": "header", "name": "X-Idempotency-Key", "schema": { "type": "string" }, "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts." } ], "operationId": "post_payments-payment-id-transactions-transaction-id-split-marketplace-transfer-reversal", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency of the transaction. Visit the [country reference](/reference/country-reference) for the full list of supported currencies.", "default": "" }, "value": { "type": "number", "description": "The value amount of the transaction.", "default": "" } }, "description": "The payment amount (multiple of 0.0001).", "required": [ "currency", "value" ] }, "description": { "type": "string", "description": "The unique identifier of the transaction (MAX 256; MIN 3).", "default": "" } }, "required": [ "amount" ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Success": { "value": { "id": "94036ceb-5cca-4384-b144-e2a5a908af77", "recipient_id": "e56c3329-f3d9-48e5-a677-284b147abf95", "amount": { "currency": "USD", "value": 100 }, "status": "SUCCEEDED", "description": "test transfer", "merchant_reference": "c19e858a-ffd6-4635-8a31-4f60c5becf4d", "metadata": [], "provider": null, "transactions": [ { "code": "7ac2c5f3-7c79-4e99-b45e-aa5952620188", "type": "SPLIT_TRANSFER", "status": "SUCCEEDED", "provider_transfer_id": "tr_1T9eKVIiMnPsFcbbRTb8ObsZ", "raw_response": "{\n \"id\": \"tr_1T9eKVIiMnPsFcbbRTb8ObsZ\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9eKVIiMnPsFcbbOPnvz3xM\",\n \"created\": 1773203107,\n \"currency\": \"usd\",\n \"description\": \"test transfer\",\n \"destination\": \"acct_1T9PSQIZEg1WWTvj\",\n \"destination_payment\": \"py_1T9eKVIZEg1WWTvjbVjmnzFK\",\n \"livemode\": false,\n \"metadata\": {},\n \"reversals\": {\n \"object\": \"list\",\n \"data\": [],\n \"has_more\": false,\n \"total_count\": 0,\n \"url\": \"/v1/transfers/tr_1T9eKVIiMnPsFcbbRTb8ObsZ/reversals\"\n },\n \"reversed\": false,\n \"source_transaction\": null,\n \"source_type\": \"card\",\n \"transfer_group\": null\n}", "created_at": "2026-03-11T04:25:06.229027Z", "updated_at": "2026-03-11T04:25:07.917364Z" } ], "created_at": "2026-03-11T04:25:06.208761Z", "updated_at": "2026-03-11T04:25:07.928000342Z", "completed_at": "2026-03-11T04:25:07.927971142Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Transfer Error": { "value": { "id": "9778f631-504d-448f-b2c1-f7b903781df7", "recipient_id": "82b12c8c-7d3d-4a21-a3c6-165cc04ca741", "amount": { "currency": "USD", "value": 50000 }, "status": "ERROR", "description": "test transfer", "merchant_reference": "cb18df20-21ae-4fed-8da9-fb81cfd56797", "metadata": [], "provider": null, "transactions": [ { "code": "9eee65d1-6c3a-4076-9ef9-fa4bff73d597", "type": "SPLIT_TRANSFER", "status": "ERROR", "provider_transfer_id": "tr_1T9PTLIiMnPsFcbbFKyh1Nds", "provider_response_message": "{\n \"id\": \"tr_1T9PTLIiMnPsFcbbFKyh1Nds\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9PTMIiMnPsFcbbxRKvaZ3G\",\n \"created\": 1773145996,\n \"currency\": \"usd\",\n \"description\": \"test transfer\"\n}", "provider_raw_response": "{.... }", "created_at": "2026-03-10T13:39:19.342902Z", "updated_at": "2026-03-10T13:39:19.342914Z" } ], "created_at": "2026-03-10T13:39:19.241990247Z", "updated_at": "2026-03-10T13:39:19.242012664Z" } } } } } } }, "tags": [ "Recipients For Marketplace" ] } }, "/payouts": { "get": { "summary": "Retrieve Payout by Merchant Reference", "description": "", "operationId": "retrieve-payout-by-merchant-reference", "parameters": [ { "name": "merchant_reference", "in": "query", "description": "Identification of the payout defined by the merchant.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": [ { "id": "565c9733-000d-4066-a4bf-b084908dc74c", "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c", "status": "SUCCEEDED", "merchant_reference": "MR-Test-12345", "purpose": "", "country": "US", "description": "Test", "amount": { "currency": "USD", "value": 100 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "legal_name": "John Doe", "email": "john.doe@email.com", "country": "US", "date_of_birth": "1980-01-01", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "country_code": "1", "number": "1234567890" }, "address": { "address_line_1": "123 Main St", "address_line_2": "Apt 1", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001" } }, "metadata": [], "created_at": "2024-05-27T15:17:30.952178Z", "updated_at": "2024-05-27T15:17:32.901454Z", "transactions": [ { "id": "bd594d5c-d7b7-48b1-9678-0b5052a69863", "status": "SUCCEEDED", "type": "ASTROPAY_PAYOUT", "response_code": "SUCCEEDED", "merchant_reference": "MR-Test-12345", "purpose": "", "description": "Test", "amount": { "currency": "USD", "value": 100 }, "withdrawal_method": { "type": "ASTROPAY_PAYOUT", "detail": { "bank_transfer": null, "wallet": { "code": "h15sg84U6rCl", "email": null, "country": null, "document": null, "phone": null } } }, "provider_data": { "id": "ASTROPAY", "transaction_id": "32376", "account_id": "", "beneficiary_id": "test_merchant_deposit_id", "status": "APPROVED", "status_detail": "APPROVED", "raw_response": "\"{\\n \\\"cashout_id\\\" : 32376,\\n \\\"merchant_cashout_id\\\" : \\\"bd594d5c-d7b7-48b1-9678-0b5052a69863\\\",\\n \\\"status\\\" : \\\"APPROVED\\\",\\n \\\"user_id\\\" : \\\"h15sg84U6rCl\\\"\\n}\"" }, "created_at": "2024-05-27T15:17:31.265607Z", "updated_at": "2024-05-27T15:17:32.901448Z" } ] } ] } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "565c9733-000d-4066-a4bf-b084908dc74c" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "status": { "type": "string", "example": "SUCCEEDED" }, "merchant_reference": { "type": "string", "example": "MR-Test-12345" }, "purpose": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "beneficiary": { "type": "object", "properties": { "merchant_beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "national_entity": { "type": "string", "example": "INDIVIDUAL" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "legal_name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "country": { "type": "string", "example": "US" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "1" }, "number": { "type": "string", "example": "1234567890" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 1" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" } } } } }, "metadata": { "type": "array" }, "created_at": { "type": "string", "example": "2024-05-27T15:17:30.952178Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:17:32.901454Z" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "bd594d5c-d7b7-48b1-9678-0b5052a69863" }, "status": { "type": "string", "example": "SUCCEEDED" }, "type": { "type": "string", "example": "ASTROPAY_PAYOUT" }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "merchant_reference": { "type": "string", "example": "MR-Test-12345" }, "purpose": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "withdrawal_method": { "type": "object", "properties": { "type": { "type": "string", "example": "ASTROPAY_PAYOUT" }, "detail": { "type": "object", "properties": { "bank_transfer": {}, "wallet": { "type": "object", "properties": { "code": { "type": "string", "example": "h15sg84U6rCl" }, "email": {}, "country": {}, "document": {}, "phone": {} } } } } } }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ASTROPAY" }, "transaction_id": { "type": "string", "example": "32376" }, "account_id": { "type": "string", "example": "" }, "beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "status": { "type": "string", "example": "APPROVED" }, "status_detail": { "type": "string", "example": "APPROVED" }, "raw_response": { "type": "string", "example": "\"{\\n \\\"cashout_id\\\" : 32376,\\n \\\"merchant_cashout_id\\\" : \\\"bd594d5c-d7b7-48b1-9678-0b5052a69863\\\",\\n \\\"status\\\" : \\\"APPROVED\\\",\\n \\\"user_id\\\" : \\\"h15sg84U6rCl\\\"\\n}\"" } } }, "created_at": { "type": "string", "example": "2024-05-27T15:17:31.265607Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:17:32.901448Z" } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] }, "summary": "Bad Request" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Payouts" ] }, "post": { "summary": "Create Payout", "description": "", "operationId": "create-payout", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "merchant_reference", "country", "purpose", "amount", "beneficiary", "withdrawal_method" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account. You find this information on [the Yuno dashboard](https://dashboard.y.uno/) (UUID, 36 chars.).", "default": "{{account_id}}" }, "merchant_reference": { "type": "string", "description": "The unique identifier of the merchant's payout (MAX 255; MIN 3).", "default": "test-reference" }, "description": { "type": "string", "description": "The description of the payout (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "Country where the transaction must be processed (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "purpose": { "type": "string", "description": "Indicates the purpose for the payout. Possible enum values: Check the Purpose list.", "enum": [ "FAMILY_AND_FRIENDS", "PERSONAL_TRANSFER", "REMITTANCES", "PROVIDER_SERVICES", "ADVERTISING_SERVICES", "REPRESENTATION_SERVICES", "ADVISORY_SERVICES", "FREELANCER_SERVICES", "SUPPLIER", "BUSINESS_TO_BUSINESS", "MARKETPLACE", "PAYROLL", "GIFTS_AND_BENEFITS", "EXPENSES", "CORPORATE_PAYMENT", "PURCHASE_OF _PHYSICAL_GOODS", "PURCHASE_OF _DIGITAL_GOODS", "PURCHASE_OF_SERVICES", "INVESTMENTS", "CAPITAL_CONTRIBUTION", "INVESTMENTS_SHARES", "TAXES", "LOGISTICS_AND_TRANSPORTATION", "DELIVERY", "AFFILIATION_PROGRAM", "LOANS", "REAL_STATE", "RENT", "TRAVEL_FLIGHTS", "TRAVEL_ACCOMMODATIONS", "EDUCATION", "TUITION_COSTS", "TRAININGS", "CHARITY", "MEDICAL_SERVICES", "SAVINGS", "RETIREMENT", "PENSION", "INSURANCE", "REWARDS", "TRADEMARKS_AND_COPYRIGHT", "ENTERTAINMENT", "GOVERNMENT", "OTHERS" ] }, "amount": { "type": "object", "description": "Specifies the payout amount object, with the value and currency.", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The payout amount (multiple of 0.0001).", "default": "100" }, "currency": { "type": "string", "description": "The currency used to make the payout. For a full list of currency codes, see [Country reference](/reference/country-reference) (MAX 3; MIN 3; ISO 4217).", "default": "USD" } } }, "beneficiary": { "type": "object", "description": "Specifies the beneficiary object with their identification.", "required": [ "merchant_beneficiary_id", "country" ], "properties": { "merchant_beneficiary_id": { "type": "string", "description": "Unique identifier of the recipient defined by the merchant (MAX 255; MIN 1).", "default": "test-beneficiary" }, "national_entity": { "type": "string", "description": "Beneficiary's national entity type. Individual by default", "enum": [ "INDIVIDUAL", "ENTITY" ] }, "first_name": { "type": "string", "description": "Beneficiary's name (MAX 80)." }, "last_name": { "type": "string", "description": "Beneficiary's last name (MAX 80)." }, "legal_name": { "type": "string", "description": "Beneficiary's name (MAX 80). Only necessary when national entity is ENTITY." }, "email": { "type": "string", "description": "The beneficiary's email (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The beneficiary's country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "date_of_birth": { "type": "string", "description": "The beneficiary's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10)." }, "document": { "type": "object", "description": "Beneficiary's national document", "required": [ "document_number" ], "properties": { "document_number": { "type": "string", "description": "The document number (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "Document type (MAX 6, MIN 1; [Country reference](country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC" ] } } }, "phone": { "type": "object", "description": "Beneficiary's cell phone", "properties": { "country_code": { "type": "string", "description": "The country calling code of the phone (MAX 3; MIN 1). Check the [Country reference](country-reference) to see the phone codes." }, "number": { "type": "string", "description": "The phone number, without the country code (MAX 32; MIN 1)." } } }, "address": { "type": "object", "description": "Beneficiary's address", "properties": { "address_line_1": { "type": "string", "description": "The primary address line (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary address line (MAX 255; MIN 1)." }, "city": { "type": "string", "description": "The city considered for the address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY" ] }, "state": { "type": "string", "description": "The state/province from the address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode for the address (MAX 11; MIN 4)." } } } } }, "withdrawal_method": { "type": "object", "description": "The withdrawal method to make the payout.", "required": [ "type", "provider_id" ], "properties": { "type": { "type": "string", "description": "Withdrawal method type.", "enum": [ "ASTROPAY_PAYOUT", "CARD", "NEQUI_PAYOUT", "PAYPAL_PAYOUT", "PIX_PAYOUT", "AFIRME_PAYOUT", "ECOMMPAY_PAYOUT", "QI_PAYOUT", "STP_PAYOUT", "TRANSFIYA_PAYOUT", "UNLIMINT_PAYOUT" ] }, "provider_id": { "type": "string", "description": "The provider to process the payouts with", "enum": [ "ASTROPAY", "NEQUI", "PAYPAL", "UNLIMINT" ] }, "vaulted_token": { "type": "string", "description": "The vaulted token for a previously stored payment_method. If a payment is created using a vaulted_token (MAX: 64; MIN: 36)." }, "original_transaction_id": { "type": "string", "description": "Id of the referenced payment transaction. Only for payouts to CARD. (MAX 64; MIN 36)" }, "original_payment_id": { "type": "string", "description": "The id of the referenced payment (UUID; 36 chars.)." }, "on_hold": { "type": "boolean", "description": "Defines if the merchant wants to hold the payout and sets it to be processed later using the Release payout endpoint." }, "detail": { "type": "object", "description": "Withdrawal method details. Only the object corresponding to the withdrawal method type is necessary.", "properties": { "bank_transfer": { "type": "object", "description": "Bank transfer details to make the payout.", "required": [ "code" ], "properties": { "code": { "type": "string", "description": "The beneficiary's specific financial institution code (MAX 8)." }, "branch": { "type": "string", "description": "The beneficiary's specific financial institution branch (MAX 8)." }, "branch_digit": { "type": "string", "description": "The beneficiary's specific financial institution branch digit (MAX 2)." }, "account": { "type": "object", "description": "Beneficiary's financial institution account number or financial institution account alias, such as Clabe for MX (MAX 255; MIN 3).", "required": [ "number" ], "properties": { "number": { "type": "string", "description": "Beneficiary's bank account number or bank account alias, such as Clabe for MX (MAX 250; MIN 3)" }, "digit": { "type": "string", "description": "Beneficiary's bank account digit (MAX 250; MIN 3)" }, "type": { "type": "string", "description": "Beneficiary's bank account type.", "enum": [ "CHECKINGS", "SAVINGS", "VISTA", "PIX_EMAIL", "PIX_PHONE", "PIX_DOCUMENT_ID", "PIX_BANK_ACCOUNT" ] } } }, "address": { "type": "object", "description": "Bank transfer address details", "properties": { "address_line_1": { "type": "string", "description": "The primary address line (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary address line (MAX 255; MIN 1)." }, "city": { "type": "string", "description": "The city considered for the address (MAX 255; MIN 3)." }, "country": { "type": "string", "description": "The country (MAX 2; MIN 2; [ISO 3166-1](country-reference)).", "enum": [ "AR", "BO", "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PY", "PE", "US", "UY", "" ] }, "state": { "type": "string", "description": "The state/province from the address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode for the address (MAX 11; MIN 4)." } } } } }, "wallet": { "type": "object", "description": "Wallet details to make the withdrawal.", "properties": { "code": { "type": "string", "description": "Beneficiary's wallet account identification code (MAX 3; MIN 250)" }, "email": { "type": "string", "description": "The Beneficiary's email (MAX 255; MIN 3)" }, "country": { "type": "string", "description": "The Beneficiary's country (ISO 3166-1 MAX 2; MIN 2)" }, "document": { "type": "object", "description": "Wallet's owner national document associated to the withdrawal account.", "required": [ "document_number" ], "properties": { "document_number": { "type": "string", "description": "The document number (MAX 40; MIN 3)." }, "document_type": { "type": "string", "description": "Document type (MAX 6, MIN 1; [Country reference](country-reference)).", "enum": [ "DNI", "CI", "LC", "LE", "CUIT", "CUIL", "PAS", "CPF", "RG", "CNH", "CNPJ", "RUT", "RUN", "CC", "CE", "NIT", "DUI", "PIC", "DPI", "IFR", "INE", "CP", "RFC", "CURP", "CIP", "CIC", "CUI", "RUC" ] } } }, "phone": { "type": "object", "description": "Wallet's owner phone associated to the withdrawal account.", "properties": { "country_code": { "type": "string", "description": "The country calling code of the phone (MAX 3; MIN 1). Check the [Country reference](country-reference) to see the phone codes." }, "number": { "type": "string", "description": "The phone number, without the country code (MAX 32; MIN 1)." } } } } } } } } }, "metadata": { "type": "array", "description": "Specifies a list of metadata objects. You can add up to 50 metadata objects.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48; MIN 1)." }, "value": { "type": "string", "description": "The metadata key value (MAX 512; MIN 1)." } }, "type": "object" } } } }, "examples": { "Wallet Payout": { "value": { "account_id": "{{account_id}}", "merchant_reference": "MR-Test-123", "description": "Test", "country": "US", "purpose": "EXPENSES", "amount": { "currency": "USD", "value": 100 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id", "country": "US", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "legal_name": "John Doe", "email": "john.doe@email.com", "date_of_birth": "1980-01-01", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "country_code": "1", "number": "1234567890" }, "address": { "address_line_1": "123 Main St", "address_line_2": "Apt 1", "city": "New York", "state": "NY", "zip_code": "10001", "country": "US" } }, "withdrawal_method": { "type": "WALLET", "provider_id": "NEQUI", "detail": { "wallet": { "code": "h15sg84U6rCl" } } }, "metadata": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] } }, "Wallet - AstroPay - Phone": { "value": { "account_id": "{{account_id}}", "merchant_reference": "MR-12345", "country": "BR", "purpose": "EXPENSES", "amount": { "currency": "BRL", "value": 10.01 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id_10", "country": "BR" }, "withdrawal_method": { "type": "ASTROPAY_PAYOUT", "provider_id": "ASTROPAY", "detail": { "wallet": { "phone": { "number": "987654321", "country_code": "55" } } } } } }, "Wallet - AstroPay - Account": { "value": { "account_id": "{{account_id}}", "merchant_reference": "MR-12345", "country": "BR", "purpose": "EXPENSES", "amount": { "currency": "BRL", "value": 10.01 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id_10", "country": "BR" }, "withdrawal_method": { "type": "ASTROPAY_PAYOUT", "provider_id": "ASTROPAY", "detail": { "wallet": { "code": "{{beneficiary-provider-account-code}}" } } } } }, "Wallet - PayPal - Account": { "value": { "account_id": "{{account_id}}", "merchant_reference": "MR-Test-12345", "description": "Test", "country": "BR", "purpose": "EXPENSES", "amount": { "currency": "USD", "value": 10 }, "beneficiary": { "merchant_beneficiary_id": "AA01", "country": "BR" }, "withdrawal_method": { "type": "PAYPAL_PAYOUT", "provider_id": "PAYPAL", "detail": { "wallet": { "code": "XMBXXFEMM22ML" } } }, "metadata": [ { "key": "key1", "value": "value1" } ] }, "summary": "Wallet - PayPal - Account" } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": { "id": "5223d101-0019-43d3-92cb-5c23391a7410", "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c", "status": "SUCCEEDED", "merchant_reference": "MR-Test-123", "purpose": "EXPENSES", "country": "BR", "description": "Test", "amount": { "currency": "BRL", "value": 100 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "legal_name": "John Doe", "email": "john.doe@email.com", "country": "BR", "date_of_birth": "1980-01-01", "document": { "document_type": "CPF", "document_number": "123456789" }, "phone": { "country_code": "55", "number": "1234567890" }, "address": { "address_line_1": "123 Main St", "address_line_2": "Apt 1", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001" } }, "metadata": [], "created_at": "2024-05-27T15:12:22.712914616Z", "updated_at": "2024-05-27T15:12:22.712916116Z", "transactions": [ { "id": "f0642eb0-31cb-44bc-9dc6-03d55ff4d664", "status": "SUCCEEDED", "type": "PAYOUT", "response_code": "SUCCEEDED", "merchant_reference": "", "purpose": "", "description": "Test", "amount": { "currency": "BRL", "value": 100 }, "withdrawal_method": { "type": "ASTROPAY_PAYOUT", "detail": { "bank_transfer": null, "wallet": { "code": "h15sg84U6rCl", "email": null, "country": null, "document": null, "phone": null } } }, "provider_data": { "id": "ASTROPAY", "transaction_id": "32373", "account_id": "", "beneficiary_id": "test_merchant_deposit_id", "status": "APPROVED", "status_detail": "APPROVED", "raw_response": "{\n \"cashout_id\" : 32373,\n \"merchant_cashout_id\" : \"f0642eb0-31cb-44bc-9dc6-03d55ff4d664\",\n \"status\" : \"APPROVED\",\n \"user_id\" : \"h15sg84U6rCl\"\n}" }, "created_at": "2024-05-27T15:12:23.022588031Z", "updated_at": "2024-05-27T15:12:23.022588361Z" } ] } }, "Payout - Pending": { "value": { "id": "64bc81c3-928f-45bf-af97-f3772238627b", "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c", "status": "PENDING", "merchant_reference": "MR-12345", "purpose": "EXPENSES", "country": "BR", "description": null, "amount": { "currency": "BRL", "value": 10.01 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id_10", "national_entity": null, "first_name": null, "last_name": null, "legal_name": null, "email": null, "country": "BR", "date_of_birth": null, "document": null, "phone": null, "address": null }, "metadata": [], "created_at": "2024-05-27T14:49:10.215801437Z", "updated_at": "2024-05-27T14:49:10.215801717Z", "transactions": [ { "id": "abff6234-7617-44fb-9958-98b2105274b1", "status": "PENDING", "type": "PAYOUT", "response_code": "PENDING_PROVIDER_CONFIRMATION", "merchant_reference": "", "purpose": "", "description": null, "amount": { "currency": "BRL", "value": 10.01 }, "withdrawal_method": { "type": "ASTROPAY_PAYOUT", "detail": { "bank_transfer": null, "wallet": { "code": null, "email": null, "country": null, "document": null, "phone": { "country_code": "55", "number": "987654321" } } } }, "provider_data": { "id": "ASTROPAY", "transaction_id": "32368", "account_id": "", "beneficiary_id": "test_merchant_deposit_id_10", "status": "PENDING", "status_detail": "PENDING", "raw_response": "{\n \"cashout_id\" : 32368,\n \"merchant_cashout_id\" : \"abff6234-7617-44fb-9958-98b2105274b1\",\n \"status\" : \"PENDING\"\n}" }, "created_at": "2024-05-27T14:49:10.916986279Z", "updated_at": "2024-05-27T14:49:10.916987669Z" } ] } }, "Payout - Succeeded": { "value": { "id": "72ec87c6-8124-4638-9333-6537d057fef5", "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c", "status": "SUCCEEDED", "merchant_reference": "MR-12345", "purpose": "EXPENSES", "country": "BR", "description": null, "amount": { "currency": "BRL", "value": 100 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id", "national_entity": null, "first_name": null, "last_name": null, "legal_name": null, "email": null, "country": "BR", "date_of_birth": null, "document": null, "phone": null, "address": null }, "metadata": [], "created_at": "2024-05-27T15:03:35.353595038Z", "updated_at": "2024-05-27T15:03:35.353596398Z", "transactions": [ { "id": "7f0e69dd-cc0d-437a-b99a-05a0bfbfd9ca", "status": "SUCCEEDED", "type": "PAYOUT", "response_code": "SUCCEEDED", "merchant_reference": "", "purpose": "", "description": null, "amount": { "currency": "BRL", "value": 100 }, "withdrawal_method": { "type": "ASTROPAY_PAYOUT", "detail": { "bank_transfer": null, "wallet": { "code": "h15sg84U6rCl", "email": null, "country": null, "document": null, "phone": null } } }, "provider_data": { "id": "ASTROPAY", "transaction_id": "32371", "account_id": "", "beneficiary_id": "test_merchant_deposit_id", "status": "APPROVED", "status_detail": "APPROVED", "raw_response": "{\n \"cashout_id\" : 32371,\n \"merchant_cashout_id\" : \"7f0e69dd-cc0d-437a-b99a-05a0bfbfd9ca\",\n \"status\" : \"APPROVED\",\n \"user_id\" : \"h15sg84U6rCl\"\n}" }, "created_at": "2024-05-27T15:03:35.768162244Z", "updated_at": "2024-05-27T15:03:35.768162864Z" } ] } }, "Payout - Declined": { "value": { "id": "57b0f7b9-1885-48d4-bb75-6a4fd645a64f", "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c", "status": "DECLINED", "merchant_reference": "MR-12345", "purpose": "EXPENSES", "country": "BR", "description": null, "amount": { "currency": "BRL", "value": 0 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id", "national_entity": null, "first_name": null, "last_name": null, "legal_name": null, "email": null, "country": "US", "date_of_birth": null, "document": null, "phone": null, "address": null }, "metadata": [], "created_at": "2024-05-27T15:05:10.957146047Z", "updated_at": "2024-05-27T15:05:10.957147867Z", "transactions": [ { "id": "54afddd3-4af4-458c-b57c-4909e1cfbcfd", "status": "DECLINED", "type": "PAYOUT", "response_code": "INVALID_REQUEST", "merchant_reference": "", "purpose": "", "description": null, "amount": { "currency": "BRL", "value": 0 }, "withdrawal_method": { "type": "ASTROPAY_PAYOUT", "detail": { "bank_transfer": null, "wallet": { "code": "h15sg84U6rCl", "email": null, "country": null, "document": null, "phone": null } } }, "provider_data": { "id": "ASTROPAY", "transaction_id": "", "account_id": "", "beneficiary_id": "test_merchant_deposit_id", "status": "commons_invalid_request", "status_detail": "Errors. amount :: must be greater than 0", "raw_response": "{\n \"error\" : \"commons_invalid_request\",\n \"description\" : \"Errors. amount :: must be greater than 0\"\n}" }, "created_at": "2024-05-27T15:05:11.559306917Z", "updated_at": "2024-05-27T15:05:11.559307247Z" } ] } }, "Payout - Pending - Paypal": { "value": { "id": "6509a7bb-e3ff-4def-b056-c4f4407d73c0", "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c", "status": "PENDING", "merchant_reference": "MR-Test-12345", "purpose": "EXPENSES", "country": "BR", "description": "Test", "amount": { "currency": "USD", "value": 10 }, "beneficiary": { "merchant_beneficiary_id": "AA01", "national_entity": null, "first_name": null, "last_name": null, "legal_name": null, "email": null, "country": "BR", "date_of_birth": null, "document": null, "phone": null, "address": null }, "metadata": [ { "key": "key1", "value": "value1" } ], "transactions": [ { "id": "7ac96c45-1242-426b-9d08-61c9e29750a2", "status": "PENDING", "type": "PAYOUT", "response_code": "PENDING_PROVIDER_CONFIRMATION", "merchant_reference": "MR-Test-12345", "purpose": "EXPENSES", "description": "Test", "amount": { "currency": "USD", "value": 10 }, "withdrawal_method": { "type": "PAYPAL_PAYOUT", "provider_id": "PAYPAL", "original_transaction_id": null, "detail": { "bank_transfer": null, "wallet": { "code": "XMBXXFEMM22ML", "email": null, "country": null, "document": null, "phone": null } } }, "provider_data": { "id": "PAYPAL", "transaction_id": "8SM8JP8UCM6E2", "account_id": "", "beneficiary_id": "AA01", "status": "PENDING", "status_detail": "Batch Status: PENDING, Item Status: PENDING", "raw_response": "{\"batch_header\":{\"payout_batch_id\":\"8SM8JP8UCM6E2\",\"batch_status\":\"PENDING\",\"time_created\":\"2024-11-22T12:29:56Z\",\"sender_batch_header\":{\"sender_batch_id\":\"7ac96c45-1242-426b-9d08-61c9e29750a2\",\"email_subject\":\"Payout from nicolas_mana_20230104123227380452\",\"email_message\":\"Test\"},\"funding_source\":\"BALANCE\",\"amount\":{\"currency\":\"USD\",\"value\":\"10.00\"},\"fees\":{\"currency\":\"USD\",\"value\":\"0.25\"}},\"items\":[{\"payout_item_id\":\"999RNFY7XEKMY\",\"transaction_status\":\"PENDING\",\"payout_item_fee\":{\"currency\":\"USD\",\"value\":\"0.25\"},\"payout_batch_id\":\"8SM8JP8UCM6E2\",\"payout_item\":{\"recipient_type\":\"PAYPAL_ID\",\"amount\":{\"currency\":\"USD\",\"value\":\"10.00\"},\"note\":\"Test\",\"receiver\":\"XMBXXFEMM22ML\",\"sender_item_id\":\"MR-Test-12345\",\"recipient_wallet\":\"PAYPAL\",\"purpose\":\"GOODS\"},\"links\":[{\"href\":\"https://api.sandbox.paypal.com/v1/payments/payouts-item/999RNFY7XEKMY\",\"rel\":\"item\",\"method\":\"GET\",\"encType\":\"application/json\"}]}],\"links\":[{\"href\":\"https://api.sandbox.paypal.com/v1/payments/payouts/8SM8JP8UCM6E2?page_size=1000&page=1\",\"rel\":\"self\",\"method\":\"GET\",\"encType\":\"application/json\"}]}" }, "created_at": "2024-11-22T12:29:54.640135912Z", "updated_at": "2024-11-22T12:29:54.640137783Z" } ], "created_at": "2024-11-22T12:29:51.436108161Z", "updated_at": "2024-11-22T12:29:51.436110603Z" } } }, "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "example": "5223d101-0019-43d3-92cb-5c23391a7410" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "status": { "type": "string", "example": "SUCCEEDED" }, "merchant_reference": { "type": "string", "example": "MR-Test-123" }, "purpose": { "type": "string", "example": "EXPENSES" }, "country": { "type": "string", "example": "BR" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "beneficiary": { "type": "object", "properties": { "merchant_beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "national_entity": { "type": "string", "example": "INDIVIDUAL" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "legal_name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "country": { "type": "string", "example": "BR" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CPF" }, "document_number": { "type": "string", "example": "123456789" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "55" }, "number": { "type": "string", "example": "1234567890" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 1" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" } } } } }, "metadata": { "type": "array" }, "created_at": { "type": "string", "example": "2024-05-27T15:12:22.712914616Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:12:22.712916116Z" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "f0642eb0-31cb-44bc-9dc6-03d55ff4d664" }, "status": { "type": "string", "example": "SUCCEEDED" }, "type": { "type": "string", "example": "PAYOUT" }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "merchant_reference": { "type": "string", "example": "" }, "purpose": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "withdrawal_method": { "type": "object", "properties": { "type": { "type": "string", "example": "ASTROPAY_PAYOUT" }, "detail": { "type": "object", "properties": { "bank_transfer": {}, "wallet": { "type": "object", "properties": { "code": { "type": "string", "example": "h15sg84U6rCl" }, "email": {}, "country": {}, "document": {}, "phone": {} } } } } } }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ASTROPAY" }, "transaction_id": { "type": "string", "example": "32373" }, "account_id": { "type": "string", "example": "" }, "beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "status": { "type": "string", "example": "APPROVED" }, "status_detail": { "type": "string", "example": "APPROVED" }, "raw_response": { "type": "string", "example": "{\n \"cashout_id\" : 32373,\n \"merchant_cashout_id\" : \"f0642eb0-31cb-44bc-9dc6-03d55ff4d664\",\n \"status\" : \"APPROVED\",\n \"user_id\" : \"h15sg84U6rCl\"\n}" } } }, "created_at": { "type": "string", "example": "2024-05-27T15:12:23.022588031Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:12:23.022588361Z" } } } } } }, { "title": "Payout - Pending", "type": "object", "properties": { "id": { "type": "string", "example": "64bc81c3-928f-45bf-af97-f3772238627b" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "status": { "type": "string", "example": "PENDING" }, "merchant_reference": { "type": "string", "example": "MR-12345" }, "purpose": { "type": "string", "example": "EXPENSES" }, "country": { "type": "string", "example": "BR" }, "description": {}, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "number", "example": 10.01, "default": 0 } } }, "beneficiary": { "type": "object", "properties": { "merchant_beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id_10" }, "national_entity": {}, "first_name": {}, "last_name": {}, "legal_name": {}, "email": {}, "country": { "type": "string", "example": "BR" }, "date_of_birth": {}, "document": {}, "phone": {}, "address": {} } }, "metadata": { "type": "array" }, "created_at": { "type": "string", "example": "2024-05-27T14:49:10.215801437Z" }, "updated_at": { "type": "string", "example": "2024-05-27T14:49:10.215801717Z" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "abff6234-7617-44fb-9958-98b2105274b1" }, "status": { "type": "string", "example": "PENDING" }, "type": { "type": "string", "example": "PAYOUT" }, "response_code": { "type": "string", "example": "PENDING_PROVIDER_CONFIRMATION" }, "merchant_reference": { "type": "string", "example": "" }, "purpose": { "type": "string", "example": "" }, "description": {}, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "number", "example": 10.01, "default": 0 } } }, "withdrawal_method": { "type": "object", "properties": { "type": { "type": "string", "example": "ASTROPAY_PAYOUT" }, "detail": { "type": "object", "properties": { "bank_transfer": {}, "wallet": { "type": "object", "properties": { "code": {}, "email": {}, "country": {}, "document": {}, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "55" }, "number": { "type": "string", "example": "987654321" } } } } } } } } }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ASTROPAY" }, "transaction_id": { "type": "string", "example": "32368" }, "account_id": { "type": "string", "example": "" }, "beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id_10" }, "status": { "type": "string", "example": "PENDING" }, "status_detail": { "type": "string", "example": "PENDING" }, "raw_response": { "type": "string", "example": "{\n \"cashout_id\" : 32368,\n \"merchant_cashout_id\" : \"abff6234-7617-44fb-9958-98b2105274b1\",\n \"status\" : \"PENDING\"\n}" } } }, "created_at": { "type": "string", "example": "2024-05-27T14:49:10.916986279Z" }, "updated_at": { "type": "string", "example": "2024-05-27T14:49:10.916987669Z" } } } } } }, { "title": "Payout - Succeeded", "type": "object", "properties": { "id": { "type": "string", "example": "72ec87c6-8124-4638-9333-6537d057fef5" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "status": { "type": "string", "example": "SUCCEEDED" }, "merchant_reference": { "type": "string", "example": "MR-12345" }, "purpose": { "type": "string", "example": "EXPENSES" }, "country": { "type": "string", "example": "BR" }, "description": {}, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "beneficiary": { "type": "object", "properties": { "merchant_beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "national_entity": {}, "first_name": {}, "last_name": {}, "legal_name": {}, "email": {}, "country": { "type": "string", "example": "BR" }, "date_of_birth": {}, "document": {}, "phone": {}, "address": {} } }, "metadata": { "type": "array" }, "created_at": { "type": "string", "example": "2024-05-27T15:03:35.353595038Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:03:35.353596398Z" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "7f0e69dd-cc0d-437a-b99a-05a0bfbfd9ca" }, "status": { "type": "string", "example": "SUCCEEDED" }, "type": { "type": "string", "example": "PAYOUT" }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "merchant_reference": { "type": "string", "example": "" }, "purpose": { "type": "string", "example": "" }, "description": {}, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "withdrawal_method": { "type": "object", "properties": { "type": { "type": "string", "example": "ASTROPAY_PAYOUT" }, "detail": { "type": "object", "properties": { "bank_transfer": {}, "wallet": { "type": "object", "properties": { "code": { "type": "string", "example": "h15sg84U6rCl" }, "email": {}, "country": {}, "document": {}, "phone": {} } } } } } }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ASTROPAY" }, "transaction_id": { "type": "string", "example": "32371" }, "account_id": { "type": "string", "example": "" }, "beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "status": { "type": "string", "example": "APPROVED" }, "status_detail": { "type": "string", "example": "APPROVED" }, "raw_response": { "type": "string", "example": "{\n \"cashout_id\" : 32371,\n \"merchant_cashout_id\" : \"7f0e69dd-cc0d-437a-b99a-05a0bfbfd9ca\",\n \"status\" : \"APPROVED\",\n \"user_id\" : \"h15sg84U6rCl\"\n}" } } }, "created_at": { "type": "string", "example": "2024-05-27T15:03:35.768162244Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:03:35.768162864Z" } } } } } }, { "title": "Payout - Declined", "type": "object", "properties": { "id": { "type": "string", "example": "57b0f7b9-1885-48d4-bb75-6a4fd645a64f" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "status": { "type": "string", "example": "DECLINED" }, "merchant_reference": { "type": "string", "example": "MR-12345" }, "purpose": { "type": "string", "example": "EXPENSES" }, "country": { "type": "string", "example": "BR" }, "description": {}, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 0, "default": 0 } } }, "beneficiary": { "type": "object", "properties": { "merchant_beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "national_entity": {}, "first_name": {}, "last_name": {}, "legal_name": {}, "email": {}, "country": { "type": "string", "example": "US" }, "date_of_birth": {}, "document": {}, "phone": {}, "address": {} } }, "metadata": { "type": "array" }, "created_at": { "type": "string", "example": "2024-05-27T15:05:10.957146047Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:05:10.957147867Z" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "54afddd3-4af4-458c-b57c-4909e1cfbcfd" }, "status": { "type": "string", "example": "DECLINED" }, "type": { "type": "string", "example": "PAYOUT" }, "response_code": { "type": "string", "example": "INVALID_REQUEST" }, "merchant_reference": { "type": "string", "example": "" }, "purpose": { "type": "string", "example": "" }, "description": {}, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 0, "default": 0 } } }, "withdrawal_method": { "type": "object", "properties": { "type": { "type": "string", "example": "ASTROPAY_PAYOUT" }, "detail": { "type": "object", "properties": { "bank_transfer": {}, "wallet": { "type": "object", "properties": { "code": { "type": "string", "example": "h15sg84U6rCl" }, "email": {}, "country": {}, "document": {}, "phone": {} } } } } } }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ASTROPAY" }, "transaction_id": { "type": "string", "example": "" }, "account_id": { "type": "string", "example": "" }, "beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "status": { "type": "string", "example": "commons_invalid_request" }, "status_detail": { "type": "string", "example": "Errors. amount :: must be greater than 0" }, "raw_response": { "type": "string", "example": "{\n \"error\" : \"commons_invalid_request\",\n \"description\" : \"Errors. amount :: must be greater than 0\"\n}" } } }, "created_at": { "type": "string", "example": "2024-05-27T15:05:11.559306917Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:05:11.559307247Z" } } } } } }, { "title": "Payout - Pending - Paypal", "type": "object", "properties": { "id": { "type": "string", "example": "6509a7bb-e3ff-4def-b056-c4f4407d73c0" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "status": { "type": "string", "example": "PENDING" }, "merchant_reference": { "type": "string", "example": "MR-Test-12345" }, "purpose": { "type": "string", "example": "EXPENSES" }, "country": { "type": "string", "example": "BR" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 10, "default": 0 } } }, "beneficiary": { "type": "object", "properties": { "merchant_beneficiary_id": { "type": "string", "example": "AA01" }, "national_entity": {}, "first_name": {}, "last_name": {}, "legal_name": {}, "email": {}, "country": { "type": "string", "example": "BR" }, "date_of_birth": {}, "document": {}, "phone": {}, "address": {} } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "key1" }, "value": { "type": "string", "example": "value1" } } } }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "7ac96c45-1242-426b-9d08-61c9e29750a2" }, "status": { "type": "string", "example": "PENDING" }, "type": { "type": "string", "example": "PAYOUT" }, "response_code": { "type": "string", "example": "PENDING_PROVIDER_CONFIRMATION" }, "merchant_reference": { "type": "string", "example": "MR-Test-12345" }, "purpose": { "type": "string", "example": "EXPENSES" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 10, "default": 0 } } }, "withdrawal_method": { "type": "object", "properties": { "type": { "type": "string", "example": "PAYPAL_PAYOUT" }, "provider_id": { "type": "string", "example": "PAYPAL" }, "original_transaction_id": {}, "detail": { "type": "object", "properties": { "bank_transfer": {}, "wallet": { "type": "object", "properties": { "code": { "type": "string", "example": "XMBXXFEMM22ML" }, "email": {}, "country": {}, "document": {}, "phone": {} } } } } } }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "PAYPAL" }, "transaction_id": { "type": "string", "example": "8SM8JP8UCM6E2" }, "account_id": { "type": "string", "example": "" }, "beneficiary_id": { "type": "string", "example": "AA01" }, "status": { "type": "string", "example": "PENDING" }, "status_detail": { "type": "string", "example": "Batch Status: PENDING, Item Status: PENDING" }, "raw_response": { "type": "string", "example": "{\"batch_header\":{\"payout_batch_id\":\"8SM8JP8UCM6E2\",\"batch_status\":\"PENDING\",\"time_created\":\"2024-11-22T12:29:56Z\",\"sender_batch_header\":{\"sender_batch_id\":\"7ac96c45-1242-426b-9d08-61c9e29750a2\",\"email_subject\":\"Payout from nicolas_mana_20230104123227380452\",\"email_message\":\"Test\"},\"funding_source\":\"BALANCE\",\"amount\":{\"currency\":\"USD\",\"value\":\"10.00\"},\"fees\":{\"currency\":\"USD\",\"value\":\"0.25\"}},\"items\":[{\"payout_item_id\":\"999RNFY7XEKMY\",\"transaction_status\":\"PENDING\",\"payout_item_fee\":{\"currency\":\"USD\",\"value\":\"0.25\"},\"payout_batch_id\":\"8SM8JP8UCM6E2\",\"payout_item\":{\"recipient_type\":\"PAYPAL_ID\",\"amount\":{\"currency\":\"USD\",\"value\":\"10.00\"},\"note\":\"Test\",\"receiver\":\"XMBXXFEMM22ML\",\"sender_item_id\":\"MR-Test-12345\",\"recipient_wallet\":\"PAYPAL\",\"purpose\":\"GOODS\"},\"links\":[{\"href\":\"https://api.sandbox.paypal.com/v1/payments/payouts-item/999RNFY7XEKMY\",\"rel\":\"item\",\"method\":\"GET\",\"encType\":\"application/json\"}]}],\"links\":[{\"href\":\"https://api.sandbox.paypal.com/v1/payments/payouts/8SM8JP8UCM6E2?page_size=1000&page=1\",\"rel\":\"self\",\"method\":\"GET\",\"encType\":\"application/json\"}]}" } } }, "created_at": { "type": "string", "example": "2024-11-22T12:29:54.640135912Z" }, "updated_at": { "type": "string", "example": "2024-11-22T12:29:54.640137783Z" } } } }, "created_at": { "type": "string", "example": "2024-11-22T12:29:51.436108161Z" }, "updated_at": { "type": "string", "example": "2024-11-22T12:29:51.436110603Z" } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] }, "summary": "Bad Request" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Payouts" ] } }, "/payouts/{payout_id}": { "get": { "summary": "Retrieve Payout by ID", "description": "", "operationId": "retrieve-payout-by-id", "parameters": [ { "in": "path", "name": "payout_id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "1c58426d-2c1b-4476-b3c0-447a8c683466", "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c", "status": "SUCCEEDED", "merchant_reference": "MR-Test-123", "purpose": "", "country": "US", "description": "Test", "amount": { "currency": "USD", "value": 100 }, "beneficiary": { "merchant_beneficiary_id": "test_merchant_deposit_id", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "legal_name": "John Doe", "email": "john.doe@email.com", "country": "US", "date_of_birth": "1980-01-01", "document": { "document_type": "SSN", "document_number": "123-45-6789" }, "phone": { "country_code": "1", "number": "1234567890" }, "address": { "address_line_1": "123 Main St", "address_line_2": "Apt 1", "country": "US", "state": "NY", "city": "New York", "zip_code": "10001" } }, "metadata": [], "created_at": "2024-05-27T15:14:19.012803Z", "updated_at": "2024-05-27T15:14:20.577061Z", "transactions": [ { "id": "30c91532-5777-410a-887f-ccfdcc7c7b1b", "status": "SUCCEEDED", "type": "ASTROPAY_PAYOUT", "response_code": "SUCCEEDED", "merchant_reference": "MR-Test-123", "purpose": "", "description": "Test", "amount": { "currency": "USD", "value": 100 }, "withdrawal_method": { "type": "ASTROPAY_PAYOUT", "detail": { "bank_transfer": null, "wallet": { "code": "h15sg84U6rCl", "email": null, "country": null, "document": null, "phone": null } } }, "provider_data": { "id": "ASTROPAY", "transaction_id": "32375", "account_id": "", "beneficiary_id": "test_merchant_deposit_id", "status": "APPROVED", "status_detail": "APPROVED", "raw_response": "\"{\\n \\\"cashout_id\\\" : 32375,\\n \\\"merchant_cashout_id\\\" : \\\"30c91532-5777-410a-887f-ccfdcc7c7b1b\\\",\\n \\\"status\\\" : \\\"APPROVED\\\",\\n \\\"user_id\\\" : \\\"h15sg84U6rCl\\\"\\n}\"" }, "created_at": "2024-05-27T15:14:19.574485Z", "updated_at": "2024-05-27T15:14:20.577057Z" } ] } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "1c58426d-2c1b-4476-b3c0-447a8c683466" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "status": { "type": "string", "example": "SUCCEEDED" }, "merchant_reference": { "type": "string", "example": "MR-Test-123" }, "purpose": { "type": "string", "example": "" }, "country": { "type": "string", "example": "US" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "beneficiary": { "type": "object", "properties": { "merchant_beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "national_entity": { "type": "string", "example": "INDIVIDUAL" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "legal_name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "country": { "type": "string", "example": "US" }, "date_of_birth": { "type": "string", "example": "1980-01-01" }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "SSN" }, "document_number": { "type": "string", "example": "123-45-6789" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "1" }, "number": { "type": "string", "example": "1234567890" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "123 Main St" }, "address_line_2": { "type": "string", "example": "Apt 1" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "NY" }, "city": { "type": "string", "example": "New York" }, "zip_code": { "type": "string", "example": "10001" } } } } }, "metadata": { "type": "array" }, "created_at": { "type": "string", "example": "2024-05-27T15:14:19.012803Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:14:20.577061Z" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "30c91532-5777-410a-887f-ccfdcc7c7b1b" }, "status": { "type": "string", "example": "SUCCEEDED" }, "type": { "type": "string", "example": "ASTROPAY_PAYOUT" }, "response_code": { "type": "string", "example": "SUCCEEDED" }, "merchant_reference": { "type": "string", "example": "MR-Test-123" }, "purpose": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Test" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 100, "default": 0 } } }, "withdrawal_method": { "type": "object", "properties": { "type": { "type": "string", "example": "ASTROPAY_PAYOUT" }, "detail": { "type": "object", "properties": { "bank_transfer": {}, "wallet": { "type": "object", "properties": { "code": { "type": "string", "example": "h15sg84U6rCl" }, "email": {}, "country": {}, "document": {}, "phone": {} } } } } } }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "example": "ASTROPAY" }, "transaction_id": { "type": "string", "example": "32375" }, "account_id": { "type": "string", "example": "" }, "beneficiary_id": { "type": "string", "example": "test_merchant_deposit_id" }, "status": { "type": "string", "example": "APPROVED" }, "status_detail": { "type": "string", "example": "APPROVED" }, "raw_response": { "type": "string", "example": "\"{\\n \\\"cashout_id\\\" : 32375,\\n \\\"merchant_cashout_id\\\" : \\\"30c91532-5777-410a-887f-ccfdcc7c7b1b\\\",\\n \\\"status\\\" : \\\"APPROVED\\\",\\n \\\"user_id\\\" : \\\"h15sg84U6rCl\\\"\\n}\"" } } }, "created_at": { "type": "string", "example": "2024-05-27T15:14:19.574485Z" }, "updated_at": { "type": "string", "example": "2024-05-27T15:14:20.577057Z" } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] }, "summary": "Bad Request" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Payouts" ] } }, "/pci-proxy/destinations": { "get": { "summary": "List Destinations", "description": "Returns the destinations registered on your account's allowlist. Only hosts on this list can be reached by the [forward proxy](/reference/pci-proxy/invoke-forward-proxy); a request to any other host is rejected with `403 DESTINATION_NOT_ALLOWED`.", "operationId": "listPciProxyDestinations", "responses": { "200": { "description": "The destinations registered for your account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/Destination" } } } }, "example": { "destinations": [ { "id": "d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4", "account_id": null, "hostname": "api.example-processor.com", "status": "ENABLED", "purpose": "Direct acquiring — Processor X", "created_at": "2026-07-09T13:05:36Z", "updated_at": "2026-07-09T13:05:36Z" } ] } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "tags": [ "Pci Proxy" ] }, "post": { "summary": "Register Destination", "description": "Adds a host to your account's allowlist so the forward proxy can send card data to it. Matching is on the exact hostname, case-insensitive; subdomains and wildcards are not implied. A newly registered host is usable within minutes.", "operationId": "registerPciProxyDestination", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationInput" }, "example": { "hostname": "api.example-processor.com", "purpose": "Direct acquiring — Processor X" } } } }, "responses": { "201": { "description": "The destination was registered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Destination" }, "example": { "id": "d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4", "account_id": null, "hostname": "api.example-processor.com", "status": "ENABLED", "purpose": "Direct acquiring — Processor X", "created_at": "2026-07-09T13:05:36Z", "updated_at": "2026-07-09T13:05:36Z" } } } }, "400": { "description": "The request body could not be parsed, or the `account_id` is not a valid account for your organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationError" }, "examples": { "Invalid request": { "value": { "code": "INVALID_REQUEST", "messages": [ "invalid body" ] } }, "Invalid account id": { "value": { "code": "INVALID_ACCOUNT_ID", "messages": [ "account_id is not a valid account" ] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "409": { "description": "The hostname is already registered on your allowlist (for this account scope).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationError" }, "examples": { "Destination exists": { "value": { "code": "DESTINATION_EXISTS", "messages": [ "destination already registered" ] } } } } } }, "422": { "description": "The hostname is not a bare public hostname (a URL, a host with a scheme, port, or path, an IP address, or a wildcard).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationError" }, "examples": { "Invalid hostname": { "value": { "code": "INVALID_HOSTNAME", "messages": [ "hostname must be a bare public FQDN with no scheme, port, path, or wildcard" ] } } } } } } }, "tags": [ "Pci Proxy" ] } }, "/pci-proxy/destinations/{id}": { "delete": { "summary": "Remove Destination", "description": "Removes a host from your account's allowlist. This takes effect immediately: the next proxy request to that host is rejected with `403 DESTINATION_NOT_ALLOWED`.", "operationId": "removePciProxyDestination", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The `id` (UUID) of the destination to remove, as returned by [List Destinations](/reference/pci-proxy/list-destinations).", "schema": { "type": "string", "format": "uuid", "example": "d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4" } } ], "responses": { "204": { "description": "The destination was removed. No response body." }, "400": { "description": "The `id` path parameter is not a valid UUID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationError" }, "examples": { "Invalid id": { "value": { "code": "INVALID_REQUEST", "messages": [ "invalid id" ] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "No destination with that `id` is registered for your account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationError" }, "examples": { "Not found": { "value": { "code": "NOT_FOUND", "messages": [ "destination not found" ] } } } } } } }, "tags": [ "Pci Proxy" ] } }, "/pci-proxy/destinations/{id}/disable": { "post": { "summary": "Disable Destination", "description": "Turns a destination off without removing it — the record and its audit history are kept, but the forward path rejects it with `403 DESTINATION_NOT_ALLOWED` until it is enabled again.", "operationId": "disablePciProxyDestination", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The `id` (UUID) of the destination to disable.", "schema": { "type": "string", "format": "uuid", "example": "d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4" } } ], "responses": { "200": { "description": "The destination was disabled; the updated object is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Destination" } } } }, "400": { "$ref": "#/components/responses/InvalidId" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/DestinationNotFound" } }, "tags": [ "Pci Proxy" ] } }, "/pci-proxy/destinations/{id}/enable": { "post": { "summary": "Enable Destination", "description": "Re-enables a disabled destination. Only `ENABLED` destinations are used by the forward path.", "operationId": "enablePciProxyDestination", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The `id` (UUID) of the destination to enable.", "schema": { "type": "string", "format": "uuid", "example": "d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4" } } ], "responses": { "200": { "description": "The destination was enabled; the updated object is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Destination" } } } }, "400": { "$ref": "#/components/responses/InvalidId" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/DestinationNotFound" } }, "tags": [ "Pci Proxy" ] } }, "/pci-proxy/forward": { "post": { "summary": "Invoke Forward Proxy", "description": "Forwards your request to the destination indicated in the `yuno-proxy-destination-url` header, replacing `{{vaulted_token..}}` expressions in the body and header values with real card data inside Yuno's PCI DSS Level 1 environment. The destination's status code, headers, and body are returned unchanged. `GET`, `PUT`, `PATCH`, and `DELETE` are also supported and forwarded verbatim. The full destination (including its path and query string) is specified in `yuno-proxy-destination-url`; a query string on the `/pci-proxy/forward` request itself is rejected. Every proxy response carries a `yuno-proxy-request-id` header; a `401` returned before the request reaches the proxy is the only exception.", "operationId": "invokeForwardProxy", "parameters": [ { "name": "yuno-proxy-destination-url", "in": "header", "required": true, "description": "The complete destination URL, including its path and any query string (for example `https://api.example-processor.com/charges/ch_123/capture?expand=true`). Must be a public HTTPS hostname on port 443, and the host must be registered on your destination allowlist; IP addresses and internal networks are rejected. It must not contain `{{vaulted_token...}}` expressions (card data must never appear in a URL).", "schema": { "type": "string", "example": "https://api.example-processor.com/charges" } }, { "name": "yuno-proxy-timeout", "in": "header", "required": false, "description": "Destination timeout in seconds. Default 30, maximum 120.", "schema": { "type": "integer", "minimum": 1, "maximum": 120, "example": 30 } }, { "name": "yuno-account-id", "in": "header", "required": false, "description": "Optional account scope. Narrows which allowlisted destinations are permitted for this request; it does not affect token resolution (vaulted tokens are always scoped to your organization). Like all `yuno-*` headers it is removed before forwarding and never reaches the destination.", "schema": { "type": "string", "example": "acc_123" } }, { "name": "yuno-proxy-auth", "in": "header", "required": false, "description": "Signing scheme for destinations that require HMAC request signing over the body. The proxy computes the signature over the resolved body (after expression substitution) and injects the destination's auth headers; your signing secret is used in memory and discarded — nothing is stored. Supported: `DLOCAL_HMAC` (the proxy generates `X-Date` and computes `Authorization: V2-HMAC-SHA256, Signature: ` over `X-Login + X-Date + resolved body`; you send `X-Login`, `X-Trans-Key`, and `X-Version` as normal destination headers). An unknown value — or a `DLOCAL_HMAC` request missing the `X-Login` or `X-Trans-Key` headers — is rejected with `400 INVALID_REQUEST` before the destination is contacted.", "schema": { "type": "string", "enum": [ "DLOCAL_HMAC" ], "example": "DLOCAL_HMAC" } }, { "name": "yuno-proxy-auth-secret-key", "in": "header", "required": false, "description": "Your signing secret for this request (required when `yuno-proxy-auth` is present). Like every `yuno-*` header it is stripped before forwarding and excluded from logs.", "schema": { "type": "string" } } ], "requestBody": { "description": "The body the destination API expects, with vaulted token expressions where card data belongs. The proxy is content-transparent: it forwards your body and `Content-Type` unchanged and resolves `{{vaulted_token..}}` expressions anywhere in the raw body, so any content type is supported (JSON, form-encoded, XML). The JSON object below is illustrative. Supported fields: `number`, `expiration_month`, `expiration_year`, `holder_name`; when the card has a network token, `network_token_number` (DPAN), `network_token_expiration_month`, `network_token_expiration_year`; and `network_transaction_id` (NTID: the scheme's reference for the card's original transaction, for merchant-initiated transactions). The security code is not stored and cannot be injected; cryptograms are per-transaction and are not resolved — include the value directly in the body if your destination requires one. At most 20 distinct tokens per request; maximum body size 1 MB. Expressions are also resolved in header values. All non-expression content is forwarded untouched.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "example": { "amount": 2500, "currency": "USD", "card": { "number": "{{vaulted_token.1a2b3c4d-5678-90ab-cdef-111213141516.number}}", "expiration_month": "{{vaulted_token.1a2b3c4d-5678-90ab-cdef-111213141516.expiration_month}}", "expiration_year": "{{vaulted_token.1a2b3c4d-5678-90ab-cdef-111213141516.expiration_year}}", "holder_name": "{{vaulted_token.1a2b3c4d-5678-90ab-cdef-111213141516.holder_name}}" } } } }, "*/*": { "schema": { "description": "Any other content type (form-encoded, XML, plain text) is forwarded as-is with expressions resolved in the raw body." } } } }, "responses": { "200": { "description": "Response from the destination, passed through unchanged (the actual status code is whatever the destination returned; check `yuno-proxy-destination-status`).", "headers": { "yuno-proxy-request-id": { "description": "Unique identifier of this proxy invocation.", "schema": { "type": "string" } }, "yuno-proxy-destination-status": { "description": "HTTP status code returned by the destination. Present only when the destination was reached.", "schema": { "type": "integer" } }, "yuno-proxy-replacements": { "description": "Number of expressions replaced before forwarding.", "schema": { "type": "integer" } }, "yuno-proxy-response-redactions": { "description": "Number of card numbers redacted from the destination response (a non-zero value means the destination returned card data).", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The destination's response body, unchanged." } } } }, "400": { "description": "Proxy-originated request error (invalid destination URL, expression problems, invalid timeout, too many tokens, or an invalid signing setup — unknown `yuno-proxy-auth`, missing `yuno-proxy-auth-secret-key`, or `DLOCAL_HMAC` without the `X-Login` or `X-Trans-Key` headers). The `yuno-proxy-destination-status` header is absent because the destination was not called.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyError" }, "examples": { "Invalid request": { "value": { "code": "INVALID_REQUEST", "messages": [ "yuno-proxy-destination-url header is required" ] } }, "Expression resolution failed": { "value": { "code": "EXPRESSION_RESOLUTION_FAILED", "messages": [ "a vaulted_token expression could not be resolved: network_transaction_id" ] } }, "Invalid account id": { "value": { "code": "INVALID_ACCOUNT_ID", "messages": [ "account_id is not a valid account" ] } } } } } }, "401": { "description": "Authentication failed. Returned before the request reaches the proxy, so it carries no `yuno-proxy-*` headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyError" }, "examples": { "Not authenticated": { "value": { "code": "NOT_AUTHENTICATED", "messages": [ "not authenticated" ] } }, "Authorization unavailable": { "value": { "code": "AuthenticationFail", "messages": [ "authorization unavailable" ] } } } } } }, "403": { "description": "The destination is not allowed, or the PCI Proxy is not activated for your organization (production only).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyError" }, "examples": { "Destination not allowed": { "value": { "code": "DESTINATION_NOT_ALLOWED", "messages": [ "destination host is not registered on your allowlist" ] } }, "Product not enabled": { "value": { "code": "PRODUCT_NOT_ENABLED", "messages": [ "The PCI Proxy is enabled per organization. Contact your Key Account Manager (KAM) to activate it." ] } } } } } }, "413": { "description": "Request body over 1 MB.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyError" }, "examples": { "Request too large": { "value": { "code": "REQUEST_TOO_LARGE", "messages": [ "request body exceeds 1 MB" ] } } } } } }, "429": { "description": "Rate limit exceeded for the account (enforced at the Yuno edge).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyError" }, "examples": { "Too many requests": { "value": { "code": "TOO_MANY_REQUESTS", "messages": [ "rate limit exceeded" ] } } } } } }, "500": { "description": "Unexpected proxy-side error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyError" }, "examples": { "Proxy error": { "value": { "code": "PROXY_ERROR", "messages": [ "internal error" ] } } } } } }, "502": { "description": "The destination could not be reached, or (when Yuno is configured service-wide to block rather than redact) its response contained card data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyError" }, "examples": { "Destination unreachable": { "value": { "code": "DESTINATION_UNREACHABLE", "messages": [ "connection to destination failed" ] } }, "Response blocked": { "value": { "code": "RESPONSE_BLOCKED", "messages": [ "destination returned card data" ] } } } } } }, "504": { "description": "The destination did not respond within the timeout.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyError" }, "examples": { "Destination timeout": { "value": { "code": "DESTINATION_TIMEOUT", "messages": [ "destination did not respond within the configured timeout" ] } } } } } } }, "tags": [ "Pci Proxy" ] } }, "/plans": { "get": { "summary": "List Plans", "description": "Returns a paginated, grid-ready list of plans for the authenticated account. 1-indexed pagination.", "operationId": "list-plans", "parameters": [ { "name": "page", "in": "query", "description": "1-indexed page number. Must be >= 1, else `400 BAD_REQUEST` (\"The page must be greater than or equal to 1\").", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "size", "in": "query", "description": "Page size. Must be between 1 and 100 inclusive, else `400 BAD_REQUEST` (\"The size must be greater than or equal to 1\" if too low, \"The size must be at most 100\" if too high).", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "items": [ { "id": "00000000-0000-4000-8000-000000000001", "account_id": "00000000-0000-4000-8000-000000000002", "name": "Streaming Pro", "merchant_reference": "streaming-pro-monthly", "status": "ACTIVE", "base_amount": { "currency": "USD", "value": 20 }, "frequency": { "type": "MONTH", "value": 1 }, "subscribers_count": 3, "countries": [ "BR", "US" ], "created_at": "2024-01-15T10:30:00.000000Z" } ], "pagination": { "page": 1, "size": 20, "total": 1, "total_pages": 1 } } } }, "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "merchant_reference": { "type": "string" }, "status": { "type": "string" }, "base_amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" } } }, "subscribers_count": { "type": "integer" }, "countries": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "size": { "type": "integer" }, "total": { "type": "integer" }, "total_pages": { "type": "integer" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "BAD_REQUEST", "messages": [ "The page must be greater than or equal to 1" ] }, "summary": "Result" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "BAD_REQUEST" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } } }, "deprecated": false, "tags": [ "Plans" ] }, "post": { "summary": "Create Plan", "description": "Creates a reusable pricing plan. Plans are immutable once created — a price change means creating a new plan; existing subscriptions on the old plan are unaffected.", "operationId": "create-plan", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "base_amount", "frequency" ], "properties": { "name": { "type": "string", "description": "The plan name (MAX 255; MIN 3)." }, "description": { "type": "string", "description": "The plan description. No length limit is currently enforced." }, "merchant_reference": { "type": "string", "description": "Your own identifier for the plan. No length limit is currently enforced." }, "base_amount": { "type": "object", "description": "The default price used for any country without an explicit entry in `country_prices`.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "MAX 3; MIN 3; [ISO 4217](/reference/country-reference)." }, "value": { "type": "number", "description": "Multiple of 0.0001.", "format": "float" } } }, "frequency": { "type": "object", "description": "The billing frequency for the plan. Subscriptions created from this plan inherit it.", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] }, "value": { "type": "integer", "format": "int32" } } }, "country_prices": { "type": "array", "description": "Optional explicit per-country prices. A country not listed falls back to `base_amount`.", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "[ISO 3166-1](/reference/country-reference)." }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number", "format": "float" } } } } } }, "allowed_payment_methods": { "type": "array", "description": "Payment method types accepted for subscriptions on this plan.", "items": { "type": "string" } }, "metadata": { "type": "array", "description": "Key-value pairs attached to the plan. Independent of any `metadata` set on a subscription created from it.", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "MAX 48." }, "value": { "type": "string", "description": "MAX 512." } } } }, "phases": { "type": "array", "description": "Optional leading ladder (for example, a trial) before the plan's regular price. Omit for a flat plan. The last entry must be the terminal REGULAR phase with no `duration`.", "items": { "type": "object", "required": [ "order", "type", "name" ], "properties": { "order": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Required, non-empty — each phase must have a name." }, "type": { "type": "string", "enum": [ "TRIAL", "REGULAR" ] }, "duration": { "type": "object", "description": "Required on every non-terminal phase, omitted on the terminal REGULAR phase.", "properties": { "type": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] }, "value": { "type": "integer", "format": "int32" } } }, "frequency": { "type": "object", "description": "Optional. If omitted, the phase bills as a single lump-sum charge covering the whole `duration`. If set, the phase bills every `frequency` interval instead, and the server computes `total_payments = duration / frequency` (both in the same unit) — e.g. a 3-month duration with a 1-month frequency produces 3 charges. Not applicable to the terminal phase.", "properties": { "type": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] }, "value": { "type": "integer", "format": "int32" } } }, "amount": { "type": "object", "description": "Flat price for the phase. 0 is allowed (a free trial). On a **non-terminal** phase, this or `country_prices` is required (one of the two). On the **terminal** REGULAR phase, omit this entirely — sending it is rejected with `400 BAD_REQUEST` (\"The terminal phase price comes from the plan base_amount/country_prices - remove the phase amount\"); the terminal price always comes from the plan's own `base_amount`/`country_prices`.", "properties": { "currency": { "type": "string" }, "value": { "type": "number", "format": "float" } } }, "country_prices": { "type": "array", "description": "Per-country prices for this phase. On a non-terminal phase, this or `amount` is required. Not applicable to the terminal phase — its pricing always comes from the plan's own `country_prices`.", "items": { "type": "object", "properties": { "country": { "type": "string" }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number", "format": "float" } } } } } } } } } } }, "examples": { "Plan": { "value": { "name": "Streaming Pro", "description": "Access to Pro features, billed monthly", "merchant_reference": "streaming-pro-monthly", "base_amount": { "currency": "USD", "value": 20 }, "frequency": { "type": "MONTH", "value": 1 }, "country_prices": [ { "country": "US", "amount": { "currency": "USD", "value": 20 } }, { "country": "BR", "amount": { "currency": "BRL", "value": 99.9 } } ], "allowed_payment_methods": [ "CARD", "PIX" ], "metadata": [ { "key": "campaign", "value": "app_store" } ], "phases": [ { "order": 1, "name": "Intro", "type": "TRIAL", "duration": { "type": "MONTH", "value": 3 }, "frequency": { "type": "MONTH", "value": 1 }, "amount": { "currency": "USD", "value": 9.99 } }, { "order": 2, "name": "Regular", "type": "REGULAR" } ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "00000000-0000-4000-8000-000000000001", "account_id": "00000000-0000-4000-8000-000000000002", "name": "Streaming Pro", "description": "Access to Pro features, billed monthly", "merchant_reference": "streaming-pro-monthly", "status": "ACTIVE", "base_amount": { "currency": "USD", "value": 20 }, "frequency": { "type": "MONTH", "value": 1 }, "country_prices": [ { "country": "US", "amount": { "currency": "USD", "value": 20 } }, { "country": "BR", "amount": { "currency": "BRL", "value": 99.9 } } ], "allowed_payment_methods": [ "CARD", "PIX" ], "metadata": [ { "key": "campaign", "value": "app_store" } ], "phases": [], "created_at": "2024-01-15T10:30:00.000000Z", "updated_at": "2024-01-15T10:30:00.000000Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "merchant_reference": { "type": "string" }, "status": { "type": "string", "example": "ACTIVE" }, "base_amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" } } }, "country_prices": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } } } } }, "allowed_payment_methods": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "array", "items": { "type": "object" } }, "phases": { "type": "array", "items": { "type": "object" } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n Refer to the HTTP Response Codes section for more details: 'https://docs.y.uno/reference/response-codes'\n}", "summary": "Result" } } } } } }, "deprecated": false, "tags": [ "Plans" ] } }, "/plans/{plan_id}": { "get": { "summary": "Retrieve Plan", "description": "", "operationId": "retrieve-plan", "parameters": [ { "name": "plan_id", "in": "path", "description": "The unique identifier of the plan.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "00000000-0000-4000-8000-000000000001", "account_id": "00000000-0000-4000-8000-000000000002", "name": "Streaming Pro", "description": "Access to Pro features, billed monthly", "merchant_reference": "streaming-pro-monthly", "status": "ACTIVE", "base_amount": { "currency": "USD", "value": 20 }, "frequency": { "type": "MONTH", "value": 1 }, "country_prices": [ { "country": "US", "amount": { "currency": "USD", "value": 20 } }, { "country": "BR", "amount": { "currency": "BRL", "value": 99.9 } } ], "allowed_payment_methods": [ "CARD", "PIX" ], "metadata": [ { "key": "campaign", "value": "app_store" } ], "phases": [ { "order": 1, "name": "Intro", "type": "TRIAL", "duration": { "type": "MONTH", "value": 3 }, "frequency": { "type": "MONTH", "value": 1 }, "amount": { "currency": "USD", "value": 9.99 }, "total_payments": 3, "country_prices": [] }, { "order": 2, "name": "Regular", "type": "REGULAR", "duration": null, "frequency": null, "amount": null, "total_payments": null, "country_prices": [] } ], "created_at": "2024-01-15T10:30:00.000000Z", "updated_at": "2024-01-15T10:30:00.000000Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "merchant_reference": { "type": "string" }, "status": { "type": "string" }, "base_amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" } } }, "country_prices": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } } } } }, "allowed_payment_methods": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "array", "items": { "type": "object" } }, "phases": { "type": "array", "items": { "type": "object" } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": { "code": "PLAN_NOT_FOUND", "messages": [ "Plan not found." ] }, "summary": "Result" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "PLAN_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } } }, "deprecated": false, "tags": [ "Plans" ] } }, "/plans/{plan_id}/status": { "post": { "summary": "Cancel Plan", "description": "The only supported status transition. Canceling a plan blocks new subscriptions AND synchronously cascade-cancels every subscription currently linked to it.", "operationId": "cancel-plan", "parameters": [ { "name": "plan_id", "in": "path", "description": "The unique identifier of the plan.", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "CANCELED" ] } } }, "examples": { "Result": { "value": { "status": "CANCELED" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "00000000-0000-4000-8000-000000000001", "status": "CANCELED", "affected_subscriptions": 3 } } }, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "affected_subscriptions": { "type": "integer", "description": "The number of subscriptions that were cascade-canceled along with the plan." } } } } } }, "400": { "description": "400. Reserved for a plan status outside ACTIVE/CANCELED — not currently reachable, since those are the plan's only two statuses today. Re-canceling an already-CANCELED plan does NOT hit this: it re-runs the cascade and returns 200.", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_STATE", "messages": [ "The subscription state does not support the action requested." ] }, "summary": "Result" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_STATE" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } } }, "deprecated": false, "tags": [ "Plans" ] } }, "/predebit-notify": { "get": { "summary": "Retrieve Pre-Debit Notification by Merchant Reference", "description": "Retrieves a pre-debit notification by the merchant reference used to create it.", "operationId": "retrieve-pre-debit-notification-by-merchant-reference", "parameters": [ { "name": "X-account-code", "in": "header", "required": true, "description": "UUID of the account the notification belongs to.", "schema": { "type": "string", "format": "uuid" } }, { "name": "merchant_reference", "in": "query", "required": true, "description": "The merchant_reference used on creation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The pre-debit notification.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the pre-debit notification. Reference it on the recurring debit as payment_method.detail.bank_transfer.pre_debit_notification_id." }, "account_id": { "type": "string", "format": "uuid", "description": "Your Yuno account ID." }, "status": { "type": "string", "enum": [ "SENT", "REJECTED", "ERROR" ], "description": "SENT: the provider accepted and delivered the notification. REJECTED: the provider refused it. ERROR: the notification could not be relayed." }, "merchant_reference": { "type": "string", "description": "Your unique reference for this notification (idempotent per account)." }, "description": { "type": "string", "description": "Text shown to the customer in the notification." }, "amount": { "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code of the upcoming debit (for UPI Autopay, INR).", "example": "INR" }, "value": { "type": "string", "description": "Amount of the upcoming debit.", "example": "499.00" } } }, "billing_date": { "type": "string", "format": "date", "description": "Date of the upcoming debit (YYYY-MM-DD)." }, "origin_payment_id": { "type": "string", "format": "uuid", "description": "The mandate-creation payment used to derive provider and connection, when provided." }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider that handled the notification (for example, EBANX)." }, "connection_id": { "type": "string", "format": "uuid", "description": "Connection used to send the notification." }, "provider_transaction_id": { "type": "string", "description": "Provider transaction reference, when available." }, "provider_notification_id": { "type": "string", "description": "Provider reference of the delivered notification. Yuno resolves and forwards it to the provider automatically when the recurring debit references this notification." }, "raw_request": { "type": "object", "description": "Obfuscated provider request. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "description": "Obfuscated provider response. Only returned for allowlisted organizations." } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "404": { "description": "No notification with this merchant reference exists for your account." } }, "tags": [ "Pre Debit Notifications" ] }, "post": { "summary": "Create Pre-Debit Notification", "description": "Sends the NPCI-required pre-debit notification to the customer before a UPI Autopay recurring debit. The provider delivers the notice and returns a reference; keep the returned id and send it on the recurring debit as payment_method.detail.bank_transfer.pre_debit_notification_id.", "operationId": "create-pre-debit-notification", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "required": true, "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "merchant_reference", "amount", "billing_date" ], "properties": { "account_id": { "type": "string", "format": "uuid", "description": "Your Yuno account ID." }, "merchant_reference": { "type": "string", "description": "Your unique reference for this notification. Reusing a reference returns the existing notification (idempotent per account)." }, "description": { "type": "string", "description": "Text shown to the customer in the notification (for example, the subscription name and renewal notice)." }, "amount": { "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code of the upcoming debit (for UPI Autopay, INR).", "example": "INR" }, "value": { "type": "string", "description": "Amount of the upcoming debit.", "example": "499.00" } } }, "billing_date": { "type": "string", "format": "date", "description": "Date of the upcoming debit (YYYY-MM-DD). Per NPCI, notify the customer at least 24 hours before the debit." }, "billing_sequence_number": { "type": "string", "description": "Sequence number of the debit within the mandate (for example, 2 for the second charge)." }, "origin_payment_id": { "type": "string", "format": "uuid", "description": "ID of the mandate-creation payment. When provided, Yuno derives the provider and connection from its successful charge. Either origin_payment_id or provider_data is required." }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Yuno customer ID." }, "merchant_customer_id": { "type": "string", "description": "Your identifier for the customer." } } }, "payment_method": { "type": "object", "properties": { "type": { "type": "string", "description": "Payment method type of the mandate.", "example": "UPI_AUTOPAY" }, "vaulted_token": { "type": "string", "format": "uuid", "description": "Vaulted token of the enrolled mandate. Yuno resolves the provider mandate credential from it." } } }, "provider_data": { "type": "object", "description": "Explicit provider routing. Either origin_payment_id or provider_data (id + connection_id) is required.", "properties": { "id": { "type": "string", "description": "Provider ID (for example, EBANX).", "example": "EBANX" }, "connection_id": { "type": "string", "format": "uuid", "description": "Connection to send the notification through." } } } } }, "examples": { "UPI Autopay": { "value": { "account_id": "00000000-0000-0000-0000-000000000000", "merchant_reference": "subscription-2026-08-INV-00187", "description": "Your subscription renews soon", "amount": { "currency": "INR", "value": "499.00" }, "billing_date": "2026-08-01", "billing_sequence_number": "2", "customer_payer": { "id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d" }, "payment_method": { "type": "UPI_AUTOPAY", "vaulted_token": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "provider_data": { "id": "EBANX", "connection_id": "6c1f6bfb-736b-439e-b568-32f671f65256" } } } } } } }, "responses": { "201": { "description": "Notification created. Check status: SENT means the provider delivered it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the pre-debit notification. Reference it on the recurring debit as payment_method.detail.bank_transfer.pre_debit_notification_id." }, "account_id": { "type": "string", "format": "uuid", "description": "Your Yuno account ID." }, "status": { "type": "string", "enum": [ "SENT", "REJECTED", "ERROR" ], "description": "SENT: the provider accepted and delivered the notification. REJECTED: the provider refused it. ERROR: the notification could not be relayed." }, "merchant_reference": { "type": "string", "description": "Your unique reference for this notification (idempotent per account)." }, "description": { "type": "string", "description": "Text shown to the customer in the notification." }, "amount": { "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code of the upcoming debit (for UPI Autopay, INR).", "example": "INR" }, "value": { "type": "string", "description": "Amount of the upcoming debit.", "example": "499.00" } } }, "billing_date": { "type": "string", "format": "date", "description": "Date of the upcoming debit (YYYY-MM-DD)." }, "origin_payment_id": { "type": "string", "format": "uuid", "description": "The mandate-creation payment used to derive provider and connection, when provided." }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider that handled the notification (for example, EBANX)." }, "connection_id": { "type": "string", "format": "uuid", "description": "Connection used to send the notification." }, "provider_transaction_id": { "type": "string", "description": "Provider transaction reference, when available." }, "provider_notification_id": { "type": "string", "description": "Provider reference of the delivered notification. Yuno resolves and forwards it to the provider automatically when the recurring debit references this notification." }, "raw_request": { "type": "object", "description": "Obfuscated provider request. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "description": "Obfuscated provider response. Only returned for allowlisted organizations." } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Invalid parameters (for example, missing provider routing or malformed billing_date)." }, "422": { "description": "The vaulted_token has no stored credential for the resolved provider (STORED_CREDENTIAL_NOT_FOUND), or the origin payment has no usable connection (PROVIDER_CONNECTION_REQUIRED)." } }, "tags": [ "Pre Debit Notifications" ] } }, "/predebit-notify/{pre_debit_notification_id}": { "get": { "summary": "Retrieve Pre-Debit Notification by ID", "description": "Retrieves a pre-debit notification by its Yuno ID.", "operationId": "retrieve-pre-debit-notification-by-id", "parameters": [ { "name": "X-account-code", "in": "header", "required": true, "description": "UUID of the account the notification belongs to.", "schema": { "type": "string", "format": "uuid" } }, { "name": "pre_debit_notification_id", "in": "path", "required": true, "description": "ID returned by the Create pre-debit notification endpoint.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The pre-debit notification.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the pre-debit notification. Reference it on the recurring debit as payment_method.detail.bank_transfer.pre_debit_notification_id." }, "account_id": { "type": "string", "format": "uuid", "description": "Your Yuno account ID." }, "status": { "type": "string", "enum": [ "SENT", "REJECTED", "ERROR" ], "description": "SENT: the provider accepted and delivered the notification. REJECTED: the provider refused it. ERROR: the notification could not be relayed." }, "merchant_reference": { "type": "string", "description": "Your unique reference for this notification (idempotent per account)." }, "description": { "type": "string", "description": "Text shown to the customer in the notification." }, "amount": { "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code of the upcoming debit (for UPI Autopay, INR).", "example": "INR" }, "value": { "type": "string", "description": "Amount of the upcoming debit.", "example": "499.00" } } }, "billing_date": { "type": "string", "format": "date", "description": "Date of the upcoming debit (YYYY-MM-DD)." }, "origin_payment_id": { "type": "string", "format": "uuid", "description": "The mandate-creation payment used to derive provider and connection, when provided." }, "provider_data": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider that handled the notification (for example, EBANX)." }, "connection_id": { "type": "string", "format": "uuid", "description": "Connection used to send the notification." }, "provider_transaction_id": { "type": "string", "description": "Provider transaction reference, when available." }, "provider_notification_id": { "type": "string", "description": "Provider reference of the delivered notification. Yuno resolves and forwards it to the provider automatically when the recurring debit references this notification." }, "raw_request": { "type": "object", "description": "Obfuscated provider request. Only returned for allowlisted organizations." }, "raw_response": { "type": "object", "description": "Obfuscated provider response. Only returned for allowlisted organizations." } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "404": { "description": "No notification with this ID exists for your account." } }, "tags": [ "Pre Debit Notifications" ] } }, "/recipients": { "get": { "summary": "List Recipients", "operationId": "list-recipients", "parameters": [ { "name": "limit", "in": "query", "description": "Maximum number of recipients to return", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "description": "Number of recipients to skip for pagination", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "national_entity", "in": "query", "description": "Filter recipients by national entity type", "required": false, "schema": { "type": "string", "enum": [ "INDIVIDUAL", "ENTITY" ] } }, { "name": "country", "in": "query", "description": "Filter recipients by country", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of recipients retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientResponse_3" } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of recipients" }, "limit": { "type": "integer", "description": "Number of recipients per page" }, "offset": { "type": "integer", "description": "Current offset" }, "has_more": { "type": "boolean", "description": "Whether there are more recipients to fetch" } } } } }, "examples": { "Success Response": { "value": { "data": [ { "id": "9104911d-5df9-429e-8488-ad41abea1a4b", "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "merchant_recipient_id": "AAAA01", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "country": "CO", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" } ], "pagination": { "total": 1, "limit": 20, "offset": 0, "has_more": false } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "tags": [ "Recipients For Marketplace" ] }, "post": { "summary": "Create Recipient", "operationId": "create-recipient", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Recipient" }, "examples": { "Individual Recipient": { "value": { "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "merchant_recipient_id": "AAAA01", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "country": "CO", "document": { "document_number": "1093333333", "document_type": "CC" }, "phone": { "country_code": "57", "number": "3132450765" }, "address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "city": "Bogota", "country": "CO", "state": "Cundinamarca", "zip_code": "111111" }, "withdrawal_methods": { "bank": { "code": "246", "branch": "XXXX", "account": "1093333333", "account_type": "SAVINGS" } }, "onboardings": [ { "type": "PREVIOUSLY_ONBOARDED", "workflow": "DIRECT", "description": "Onboarding Description", "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "VR", "connection_id": "d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4", "recipient_id": "adct_1SB05NPD2RTdZORd", "recipient_type": "FLEET" }, "documentation": [ { "file_name": "onboarding12.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA==" } ], "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54.786342Z", "ip": "129.21.111.11" } } ], "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" } }, "Create Recipient - US": { "value": { "account_id": "{{account_id}}", "merchant_recipient_id": "MERCHANT_usa_example_10", "national_entity": "INDIVIDUAL", "entity_type": "PRIVATE", "first_name": "NACHOSOS", "last_name": "UNCAPO", "legal_name": null, "email": "nach.dos@example.com", "date_of_birth": "1990-01-15", "country": "US", "website": "https://johndoe.com", "industry": "Software", "merchant_category_code": "5734", "document": { "document_number": "123-45-6789", "document_type": "SSN" }, "phone": { "country_code": "1", "number": "4151234567" }, "address": { "address_line_1": "1234 Market Street", "address_line_2": "Suite 100", "city": "San Francisco", "country": "US", "state": "California", "zip_code": "94103", "neighborhood": "SoMa" }, "legal_representatives": [ { "merchant_reference": "REP_US_001", "first_name": "Jane", "last_name": "Smith", "email": "jane.smith@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "SSN", "document_number": "987-65-4321" }, "phone": { "number": "6469876543", "country_code": "1" }, "address": { "address_line_1": "1600 Amphitheatre Parkway", "address_line_2": null, "country": "US", "state": "CA", "city": "Mountain View", "zip_code": "94043" } } ], "withdrawal_methods": { "bank": { "code": "001", "branch": "001", "branch_digit": "001", "account": "000123456789", "account_digit": "001", "account_type": "CHECKINGS", "routing": "021000021", "country": "US", "currency": "USD" } }, "documentation": [ { "file_name": "document", "content_type": "application/pdf", "content_category": "SELFIE", "content": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAIAAAACUFjqAAAAEklEQVR4nGP8z4APMOGVHbHSAEEsAROxCnMTAAAAAElFTkSuQmCC" } ], "onboardings": [ { "type": "TWO_STEP_ONBOARDING", "workflow": "DIRECT", "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "YUNO_TEST_PAYMENT_GW", "connection_id": "{{connection_id}}", "recipient_id": null }, "documentation": null, "withdrawal_methods": { "bank": { "code": "001", "branch": "001", "branch_digit": null, "account": "000123456789", "account_digit": null, "account_type": "CHECKINGS", "routing": "021000021", "country": "US", "currency": "USD" } }, "terms_of_service": { "acceptance": true, "date": "2025-06-18T00:00:00Z", "ip": "192.168.1.100" } } ] } }, "Entity Recipient": { "value": { "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "merchant_recipient_id": "AAAA02", "national_entity": "ENTITY", "first_name": "Business", "last_name": "Corp", "legal_name": "Arcos dorados S.A.", "email": "business@corp.com", "country": "CO", "document": { "document_number": "900123456", "document_type": "NIT" }, "phone": { "country_code": "57", "number": "1234567890" }, "address": { "address_line_1": "Calle 123 # 45 - 67", "city": "Medellin", "country": "CO", "state": "Antioquia", "zip_code": "050001" }, "onboardings": [ { "type": "TWO_STEP_ONBOARDING", "callback_url": "https://myapp.com/callback", "provider": { "id": "STRIPE", "connection_id": "02ea2568-d99e-4fb9-9bd3-7bb13a822d33" } } ] } } } } } }, "responses": { "201": { "description": "Recipient created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse_2" }, "examples": { "Success Response": { "value": { "id": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802", "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482", "merchant_recipient_id": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6", "national_entity": "INDIVIDUAL", "entity_type": "PRIVATE", "first_name": "Juan", "last_name": "Pérez", "legal_name": null, "email": "juan.perez@example.com", "date_of_birth": "1990-01-15", "country": "CO", "website": "https://juanperez.com", "industry": "Technology", "merchant_category_code": "5734", "document": { "document_number": "1234567890", "document_type": "CC" }, "phone": { "country_code": "57", "number": "3001234567" }, "address": { "address_line_1": "Carrera 7 # 32-16", "address_line_2": "Oficina 201", "city": "Bogotá", "country": "CO", "state": "Cundinamarca", "zip_code": "110311", "neighborhood": "Centro" }, "legal_representatives": [ { "merchant_reference": "REP_001", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "CO", "nationality": "CO", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "country_code": "57", "number": "3109876543" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": null, "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "110311" } } ], "withdrawal_methods": { "bank": { "code": "001", "branch": "004", "branch_digit": "123", "account": "1234567890", "account_digit": "123", "account_type": "SAVINGS", "routing": "021000021", "country": "CO", "currency": "COP" } }, "documentation": [ { "file_name": "cc-front.pdf", "content_type": "application/pdf", "content_category": "IDENTIFICATION", "content": "JVBERi0xLjQKJ..." } ], "onboardings": [ { "id": "84c42684-dbe5-4e0f-bd17-4d094e19762d", "type": "TWO_STEP_ONBOARDING", "workflow": "DIRECT", "status": "PENDING", "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "ALELO", "connection_id": "cc389b51-53a1-4a29-af40-c8cee26c3399", "recipient_id": null, "redirect_url": null, "onboarding_url": null, "legal_entity": null, "balance_account_id": null, "legal_entity_id": null }, "documentation": [ { "file_name": "utility-bill.pdf", "content_type": "application/pdf", "content_category": "ADDRESS_PROOF", "content": "JVBERi0xLjQKJ..." } ], "requirements": [ { "field": "document.cc", "message": "Provide CC document image", "status": "PENDING" }, { "field": "address.proof", "message": "Upload proof of address", "status": "PENDING" } ], "withdrawal_methods": { "bank": { "code": "002", "branch": "002", "branch_digit": null, "account": "9876543210", "account_digit": null, "account_type": "SAVINGS", "routing": "021000022", "country": "CO", "currency": "COP" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54Z", "ip": "129.21.111.11" }, "created_at": "2025-08-27T15:41:19.516982Z", "updated_at": "2025-08-27T15:41:19.516989Z" } ], "created_at": "2025-08-27T15:41:19.497413Z", "updated_at": "2025-08-27T15:41:19.497425Z" } }, "Create Recipient - US": { "value": { "id": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802", "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482", "merchant_recipient_id": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6", "national_entity": "INDIVIDUAL", "entity_type": "PRIVATE", "first_name": "John", "last_name": "Smith", "legal_name": null, "email": "john.smith@example.com", "date_of_birth": "1990-01-15", "country": "US", "website": "https://johnsmith.com", "industry": "Technology", "merchant_category_code": "5734", "document": { "document_number": "987654321", "document_type": "SSN" }, "phone": { "country_code": "1", "number": "6465551234" }, "address": { "address_line_1": "123 Main Street", "address_line_2": "Apt 4B", "city": "New York", "country": "US", "state": "New York", "zip_code": "10001", "neighborhood": null }, "legal_representatives": [ { "merchant_reference": "REP_001", "first_name": "Emily", "last_name": "Johnson", "email": "emily.johnson@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "SSN", "document_number": "123456789" }, "phone": { "number": "9175559876", "country_code": "1" }, "address": { "address_line_1": "456 Park Avenue", "address_line_2": null, "country": "US", "state": "New York", "city": "New York", "zip_code": "10022" } } ], "withdrawal_methods": { "bank": { "code": "001", "branch": "001", "branch_digit": "001", "account": "1234567890", "account_digit": "001", "account_type": "CHECKINGS", "routing": "021000021", "country": "US", "currency": "USD" } }, "documentation": [ { "file_name": "ssn-proof.pdf", "content_type": "application/pdf", "content_category": "IDENTIFICATION", "content": "JVBERi0xLjQKJ..." } ], "onboardings": [ { "id": "84c42684-dbe5-4e0f-bd17-4d094e19762d", "type": "TWO_STEP_ONBOARDING", "workflow": "DIRECT", "status": "PENDING", "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "ALELO", "connection_id": "cc389b51-53a1-4a29-af40-c8cee26c3399", "recipient_id": null, "redirect_url": null, "onboarding_url": null, "legal_entity": null, "balance_account_id": null, "legal_entity_id": null }, "documentation": [ { "file_name": "utility-bill.pdf", "content_type": "application/pdf", "content_category": "ADDRESS_PROOF", "content": "JVBERi0xLjQKJ..." } ], "requirements": [ { "field": "document.ssn", "message": "Provide SSN document image", "status": "PENDING" }, { "field": "address.proof", "message": "Upload proof of address", "status": "PENDING" } ], "withdrawal_methods": { "bank": { "code": "002", "branch": "002", "branch_digit": null, "account": "9876543210", "account_digit": null, "account_type": "CHECKINGS", "routing": "021000022", "country": "US", "currency": "USD" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54Z", "ip": "129.21.111.11" }, "created_at": "2025-08-27T15:41:19.516982Z", "updated_at": "2025-08-27T15:41:19.516989Z" } ], "created_at": "2025-08-27T15:41:19.497413Z", "updated_at": "2025-08-27T15:41:19.497425Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request format" ] } }, "Transfer Error": { "value": { "id": "9778f631-504d-448f-b2c1-f7b903781df7", "recipient_id": "82b12c8c-7d3d-4a21-a3c6-165cc04ca741", "amount": { "currency": "USD", "value": 50000 }, "status": "ERROR", "description": "test transfer", "merchant_reference": "cb18df20-21ae-4fed-8da9-fb81cfd56797", "metadata": [], "provider": null, "transactions": [ { "code": "9eee65d1-6c3a-4076-9ef9-fa4bff73d597", "type": "SPLIT_TRANSFER", "status": "ERROR", "provider_transfer_id": "tr_1T9PTLIiMnPsFcbbFKyh1Nds", "provider_response_message": "{\n \"id\": \"tr_1T9PTLIiMnPsFcbbFKyh1Nds\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9PTMIiMnPsFcbbxRKvaZ3G\",\n \"created\": 1773145996,\n \"currency\": \"usd\",\n \"description\": \"test transfer\"\n}", "provider_raw_response": "{.... }", "created_at": "2026-03-10T13:39:19.342902Z", "updated_at": "2026-03-10T13:39:19.342914Z" } ], "created_at": "2026-03-10T13:39:19.241990247Z", "updated_at": "2026-03-10T13:39:19.242012664Z" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "tags": [ "Recipients For Marketplace" ] } }, "/recipients/onboardings/reverse-transfer/{transfer_id}": { "post": { "description": "", "operationId": "post_recipients-id-onboardings-onboarding-reverse-transfer", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "ed206787-6203-45a6-b896-71249fff7ddb" }, "origin_onboarding": { "type": "object", "properties": { "id": { "type": "string", "example": "c2f96b59-ae5a-470d-a94a-16bf142b11df" }, "type": { "type": "string", "example": "ONE_STEP_ONBOARDING" }, "workflow": { "type": "string", "example": "DIRECT" }, "description": { "type": "string", "example": "Onboarding Description" }, "status": { "type": "string", "example": "INACTIVE" }, "response_message": {}, "callback_url": { "type": "string", "example": "https://merchant.example.com/webhook/onboarding" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "example": "b90fa936-92b6-4529-9c69-0ca474291af1" }, "recipient_id": { "type": "string", "example": "acct_1SpfTBRFM5RUW372" }, "redirect_url": {}, "onboarding_url": { "type": "string", "example": "" }, "legal_entity": {}, "recipient_additional_id": {}, "balance_account_id": { "type": "string", "example": "" }, "recipient_type": {}, "raw_notification": {}, "raw_response": {}, "response_code": {}, "response_message": {} } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "onboarding10.png" }, "content_type": { "type": "string", "example": "image/png" }, "content_category": { "type": "string", "example": "VAT_DOCUMENT" }, "content": { "type": "string", "example": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" } } } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "example": "ONB_010" }, "first_name": { "type": "string", "example": "Maria" }, "last_name": { "type": "string", "example": "Gonzalez" }, "email": { "type": "string", "example": "maria.gonzalez@example.com" }, "date_of_birth": { "type": "string", "example": "1985-05-20" }, "country": { "type": "string", "example": "US" }, "nationality": { "type": "string", "example": "US" }, "title": { "type": "string", "example": "CEO" }, "publicly_exposed_person": { "type": "boolean", "example": false, "default": true }, "ultimate_beneficial_owner": { "type": "boolean", "example": true, "default": true }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "0987654321" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "3109876543" }, "country_code": { "type": "string", "example": "+57" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 26 # 13-19" }, "address_line_2": { "type": "string", "example": "test calle" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogota" }, "zip_code": { "type": "string", "example": "03804" }, "neighborhood": { "type": "string", "example": "Centro" } } } } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "test" }, "value": { "type": "string", "example": "123" } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "004" }, "branch": { "type": "string", "example": "006" }, "branch_digit": { "type": "string", "example": "125" }, "account": { "type": "string", "example": "000123456789" }, "account_digit": { "type": "string", "example": "124" }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "110000000" }, "country": { "type": "string", "example": "US" }, "currency": { "type": "string", "example": "USD" }, "payout_schedule": { "type": "string", "example": "HOLD" } } } } }, "terms_of_service": { "type": "object", "properties": { "acceptance": { "type": "boolean", "example": true, "default": true }, "date": { "type": "string", "example": "2025-07-21T20:43:54.786342Z" }, "ip": { "type": "string", "example": "129.21.111.11" } } }, "created_at": { "type": "string", "example": "2026-01-15T21:33:17.374975Z" }, "updated_at": { "type": "string", "example": "2026-01-15T21:33:44.650123Z" } } }, "destination_onboarding": { "type": "object", "properties": { "id": { "type": "string", "example": "97254599-4f94-4aff-9777-733a8e0e95e1" }, "type": { "type": "string", "example": "ONE_STEP_ONBOARDING" }, "workflow": { "type": "string", "example": "DIRECT" }, "description": { "type": "string", "example": "Onboarding Description" }, "status": { "type": "string", "example": "SUCCEEDED" }, "response_message": {}, "callback_url": { "type": "string", "example": "https://merchant.example.com/webhook/onboarding" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "example": "b90fa936-92b6-4529-9c69-0ca474291af1" }, "recipient_id": { "type": "string", "example": "acct_1SpfStIPQ4THTT53" }, "redirect_url": {}, "onboarding_url": { "type": "string", "example": "" }, "legal_entity": {}, "recipient_additional_id": {}, "balance_account_id": { "type": "string", "example": "" }, "recipient_type": {}, "raw_notification": {}, "raw_response": {}, "response_code": {}, "response_message": {} } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "onboarding10.png" }, "content_type": { "type": "string", "example": "image/png" }, "content_category": { "type": "string", "example": "VAT_DOCUMENT" }, "content": { "type": "string", "example": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" } } } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "example": "ONB_010" }, "first_name": { "type": "string", "example": "Maria" }, "last_name": { "type": "string", "example": "Gonzalez" }, "email": { "type": "string", "example": "maria.gonzalez@example.com" }, "date_of_birth": { "type": "string", "example": "1985-05-20" }, "country": { "type": "string", "example": "US" }, "nationality": { "type": "string", "example": "US" }, "title": { "type": "string", "example": "CEO" }, "publicly_exposed_person": { "type": "boolean", "example": false, "default": true }, "ultimate_beneficial_owner": { "type": "boolean", "example": true, "default": true }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "0987654321" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "3109876543" }, "country_code": { "type": "string", "example": "+57" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 26 # 13-19" }, "address_line_2": { "type": "string", "example": "test calle" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogota" }, "zip_code": { "type": "string", "example": "03804" }, "neighborhood": { "type": "string", "example": "Centro" } } } } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "test" }, "value": { "type": "string", "example": "123" } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "004" }, "branch": { "type": "string", "example": "006" }, "branch_digit": { "type": "string", "example": "125" }, "account": { "type": "string", "example": "000123456789" }, "account_digit": { "type": "string", "example": "124" }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "110000000" }, "country": { "type": "string", "example": "US" }, "currency": { "type": "string", "example": "USD" }, "payout_schedule": { "type": "string", "example": "HOLD" } } } } }, "terms_of_service": { "type": "object", "properties": { "acceptance": { "type": "boolean", "example": true, "default": true }, "date": { "type": "string", "example": "2025-07-21T20:43:54.786342Z" }, "ip": { "type": "string", "example": "129.21.111.11" } } }, "created_at": { "type": "string", "example": "2026-01-15T01:35:10.646218Z" }, "updated_at": { "type": "string", "example": "2026-01-15T21:33:46.245564Z" } } }, "created_at": { "type": "string", "example": "2026-01-15T21:33:46.456587Z" }, "updated_at": { "type": "string", "example": "2026-01-15T21:33:46.456624Z" } } }, "examples": { "Success": { "value": { "id": "ed206787-6203-45a6-b896-71249fff7ddb", "origin_onboarding": { "id": "c2f96b59-ae5a-470d-a94a-16bf142b11df", "type": "ONE_STEP_ONBOARDING", "workflow": "DIRECT", "description": "Onboarding Description", "status": "INACTIVE", "response_message": null, "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "STRIPE", "connection_id": "b90fa936-92b6-4529-9c69-0ca474291af1", "recipient_id": "acct_1SpfTBRFM5RUW372", "redirect_url": null, "onboarding_url": "", "legal_entity": null, "recipient_additional_id": null, "balance_account_id": "", "recipient_type": null, "raw_notification": null, "raw_response": null, "response_code": null, "response_message": null }, "documentation": [ { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" }, { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" } ], "legal_representatives": [ { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } }, { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } } ], "metadata": [ { "key": "test", "value": "123" } ], "withdrawal_methods": { "bank": { "code": "004", "branch": "006", "branch_digit": "125", "account": "000123456789", "account_digit": "124", "account_type": "SAVINGS", "routing": "110000000", "country": "US", "currency": "USD", "payout_schedule": "HOLD" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54.786342Z", "ip": "129.21.111.11" }, "created_at": "2026-01-15T21:33:17.374975Z", "updated_at": "2026-01-15T21:33:44.650123Z" }, "destination_onboarding": { "id": "97254599-4f94-4aff-9777-733a8e0e95e1", "type": "ONE_STEP_ONBOARDING", "workflow": "DIRECT", "description": "Onboarding Description", "status": "SUCCEEDED", "response_message": null, "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "STRIPE", "connection_id": "b90fa936-92b6-4529-9c69-0ca474291af1", "recipient_id": "acct_1SpfStIPQ4THTT53", "redirect_url": null, "onboarding_url": "", "legal_entity": null, "recipient_additional_id": null, "balance_account_id": "", "recipient_type": null, "raw_notification": null, "raw_response": null, "response_code": null, "response_message": null }, "documentation": [ { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" }, { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" }, { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" }, { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" } ], "legal_representatives": [ { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } }, { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } }, { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } }, { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } } ], "metadata": [ { "key": "test", "value": "123" } ], "withdrawal_methods": { "bank": { "code": "004", "branch": "006", "branch_digit": "125", "account": "000123456789", "account_digit": "124", "account_type": "SAVINGS", "routing": "110000000", "country": "US", "currency": "USD", "payout_schedule": "HOLD" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54.786342Z", "ip": "129.21.111.11" }, "created_at": "2026-01-15T01:35:10.646218Z", "updated_at": "2026-01-15T21:33:46.245564Z" }, "created_at": "2026-01-15T21:33:46.456587Z", "updated_at": "2026-01-15T21:33:46.456624Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } }, "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request format" ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "parameters": [ { "in": "header", "name": "X-organization-code", "schema": { "type": "string" }, "required": true, "description": "Organization code associated to the request." }, { "in": "header", "name": "X-Idempotency-Key", "schema": { "type": "string" }, "required": true, "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts." }, { "in": "path", "name": "transfer_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}": { "get": { "summary": "Get Recipient", "operationId": "get-recipient", "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse_2" }, "examples": { "Success Response": { "value": { "id": "9104911d-5df9-429e-8488-ad41abea1a4b", "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "merchant_recipient_id": "AAAA01", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "legal_name": "Arcos dorados S.A.", "email": "john.doe@email.com", "country": "CO", "document": { "document_number": "1093333333", "document_type": "CC" }, "phone": { "country_code": "57", "number": "3132450765" }, "address": { "address_line_1": "Calle 34 # 56 - 78", "address_line_2": "Apartamento 502, Torre I", "city": "Bogota", "country": "CO", "state": "Cundinamarca", "zip_code": "111111" }, "withdrawal_methods": [ { "bank": { "code": "246", "branch": "XXXX", "account": "1093333333", "account_type": "SAVINGS" } } ], "onboardings": [ { "type": "PREVIOUSLY_ONBOARDED", "workflow": "HOSTED_BY_PROVIDER", "callback_url": "https://www.google.com", "provider": { "id": "PAGARME" } } ], "split_configuration": { "calculation_type": "PERCENTAGE", "percentage": 10.5, "rounding_mode": "STANDARD", "currency": "USD" }, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" } } } } } }, "400": { "description": "Invalid Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "string" } } }, "examples": { "Invalid Request": { "value": { "code": "INVALID_PARAMETERS", "messages": [ "The query parameter 'account_id' is required." ] }, "summary": "Invalid Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "summary": "Unauthorized", "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "summary": "Forbidden", "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "parameters": [ { "name": "recipient_id", "in": "path", "required": true, "description": "The unique identifier of the recipient", "schema": { "type": "string" } } ], "tags": [ "Recipients For Marketplace" ] }, "patch": { "summary": "Update Recipient", "operationId": "update-recipient", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "onboarding_id": { "type": "string", "format": "uuid", "description": "ID of an existing onboarding belonging to the recipient. When set, the identity fields sent in this request (e.g. first_name, email, phone, address) are stored as a per-onboarding override for that onboarding only, without modifying the shared recipient; when omitted, the update applies to the shared recipient and propagates to all non-terminal onboardings. Request-only, not returned in responses or webhooks.", "example": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed" }, "merchant_recipient_id": { "type": "string", "description": "Unique identifier of the recipient defined by the merchant (MAX 255; MIN 1)." }, "first_name": { "type": "string", "description": "Beneficiary's name. (MAX 80; MIN 1)." }, "last_name": { "type": "string", "description": "Beneficiary's last name. (MAX 80; MIN 1)." }, "date_of_birth": { "type": "string", "description": "The Beneficiary's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10)." }, "entity_type": { "type": "string", "enum": [ "GOVERNMENTAL", "PUBLIC", "NON_PROFIT", "PRIVATE" ], "description": "The Beneficiary's type of organization. GOVERNMENTAL, PUBLIC, NON_PROFIT, PRIVATE" }, "website": { "type": "string", "description": "The seller's website URL (MAX 255; MIN 3)." }, "industry": { "type": "string", "description": "The seller's industry (MAX 235; MIN 1). For more information access the Industry category reference page." }, "merchant_category_code": { "type": "string", "description": "MCC - The merchant category code (MAX 235; MIN 1)." }, "email": { "type": "string", "description": "The Beneficiary's email (MAX 255; MIN 3)." }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Beneficiary's cell phone area code. (MAX 3; MIN 2)." }, "number": { "type": "string", "description": "Beneficiary's cell phone number. (MAX 32; MIN 1)." } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line of the customer (MAX 255; MIN 3)." }, "address_line_2": { "type": "string", "description": "The secondary billing address line of the customer (MAX 255; MIN 3)." }, "city": { "type": "string", "description": "The city considered for the billing address (MAX 255; MIN 3)." }, "state": { "type": "string", "description": "The state / province considered for the billing address (MAX 255; MIN 3)." }, "zip_code": { "type": "string", "description": "The zipcode considered for the billing address (MAX 11; MIN 4)." } } }, "withdrawal_methods": { "type": "array", "items": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "description": "Bank's code (MAX 3; MIN 3)." }, "branch": { "type": "string", "description": "Bank's branch (MAX 3; MIN 3)." }, "branch_digit": { "type": "string", "description": "Bank's branch digit (MAX 3; MIN 3)." }, "account": { "type": "string", "description": "Beneficiary's bank account number (MAX 250; MIN 3)." }, "account_digit": { "type": "string", "description": "Beneficiary's bank account digit (MAX 250; MIN 3)." }, "account_type": { "type": "string", "enum": [ "CHECKINGS", "SAVINGS" ], "description": "Beneficiary's bank account type (MAX 3; MIN 1)." }, "routing": { "type": "string", "description": "Beneficiary's bank account routing number." }, "country": { "type": "string", "description": "The bank account's country (ISO 3166-1 MAX 2; MIN 2)." }, "currency": { "type": "string", "description": "The bank account's currency (ISO 4217 MAX 3; MIN 3)." } } } } } }, "documentation": { "type": "array", "description": "Array of documentation objects", "items": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the documentation sent (MAX 255; MIN 3)." }, "content_type": { "type": "string", "description": "The type of the documentation sent by the merchant." }, "content_category": { "type": "string", "description": "The category of the documentation sent by the merchant." }, "content": { "type": "string", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 1MB." } } } }, "onboardings": { "type": "array", "description": "Array of onboarding objects for different payment providers", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PREVIOUSLY_ONBOARDED", "ONBOARD_ONTO_THE_PROVIDER" ], "description": "Type of onboarding. If its done by Yuno." }, "workflow": { "type": "string", "enum": [ "HOSTED_BY_PROVIDER", "DIRECT" ], "description": "Workflow of the onboarding." }, "callback_url": { "type": "string", "description": "URL in case to redirect your customer after the onboarding process with the provider, if needed." }, "provider": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "PAGARME", "ALELO", "EDENRED", "PLUXEE", "VR", "STRIPE", "ADYEN" ], "description": "Provider id.", "example": "PAGARME" }, "recipient_id": { "type": "string", "description": "The unique identifier of the provider's recipient." } } }, "documentation": { "type": "array", "description": "Array of documentation objects for this onboarding", "items": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the documentation sent (MAX 255; MIN 3)." }, "content_type": { "type": "string", "description": "The type of the documentation sent by the merchant." }, "content_category": { "type": "string", "description": "The category of the documentation sent by the merchant." }, "content": { "type": "string", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 1MB." } } } }, "withdrawal_methods": { "type": "array", "description": "Withdrawal methods for this onboarding", "items": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "description": "Bank's code (MAX 3; MIN 3)." }, "branch": { "type": "string", "description": "Bank's branch (MAX 3; MIN 3)." }, "branch_digit": { "type": "string", "description": "Bank's branch digit (MAX 3; MIN 3)." }, "account": { "type": "string", "description": "Beneficiary's bank account number (MAX 250; MIN 3)." }, "account_digit": { "type": "string", "description": "Beneficiary's bank account digit (MAX 250; MIN 3)." }, "account_type": { "type": "string", "enum": [ "CHECKINGS", "SAVINGS" ], "description": "Beneficiary's bank account type (MAX 3; MIN 1)." }, "routing": { "type": "string", "description": "Beneficiary's bank account routing number." }, "country": { "type": "string", "description": "The bank account's country (ISO 3166-1 MAX 2; MIN 2)." }, "currency": { "type": "string", "description": "The bank account's currency (ISO 4217 MAX 3; MIN 3)." } } } } } } } } }, "split_configuration": { "type": "object", "description": "Rules for automatic split calculation at the recipient level.", "required": [ "calculation_type", "currency" ], "properties": { "calculation_type": { "type": "string", "description": "The method used to calculate the split amount.", "enum": [ "PERCENTAGE", "FIXED", "MIXED" ], "example": "PERCENTAGE" }, "percentage": { "type": "number", "description": "Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED.", "minimum": 0.01, "maximum": 100, "example": 10.5 }, "fixed_amount": { "type": "number", "description": "Fixed amount to be split. Required if calculation_type is FIXED or MIXED.", "minimum": 0.0001, "example": 5 }, "currency": { "type": "string", "description": "ISO 4217 currency code. Required for all calculation types.", "example": "USD" }, "rounding_mode": { "type": "string", "description": "The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED.", "enum": [ "STANDARD", "ROUND_UP", "ROUND_DOWN" ], "example": "STANDARD" } } } } }, "examples": { "Update Contact Info": { "value": { "email": "newemail@example.com", "phone": { "country_code": "57", "number": "9876543210" } } }, "Update Address": { "value": { "address": { "address_line_1": "New Street 123", "city": "New City", "state": "New State", "zip_code": "12345" } } }, "Update Banking Info": { "value": { "withdrawal_methods": { "bank": { "code": "123", "branch": "YYY", "account": "987654321", "account_type": "CHECKINGS" } } } }, "Update Onboarding": { "value": { "onboardings": [ { "type": "ONBOARD_ONTO_THE_PROVIDER", "workflow": "DIRECT", "callback_url": "https://myapp.com/new-callback", "provider": { "id": "ADYEN" } } ] } }, "Update Single Onboarding": { "value": { "onboarding_id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed", "email": "new.email@example.com", "phone": { "country_code": "1", "number": "5551234567" } } } } } } }, "responses": { "200": { "description": "Recipient updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse" }, "examples": { "Success Response": { "value": { "id": "9104911d-5df9-429e-8488-ad41abea1a4b", "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "merchant_recipient_id": "AAAA01", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "email": "newemail@example.com", "country": "CO", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T11:45:00Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request format" ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "parameters": [ { "name": "recipient_id", "in": "path", "required": true, "description": "The unique identifier of the recipient", "schema": { "type": "string" } } ], "tags": [ "Recipients For Marketplace" ] }, "delete": { "summary": "Delete Recipient", "operationId": "delete-recipient", "responses": { "204": { "description": "Recipient deleted successfully" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } }, "409": { "description": "Conflict - Recipient cannot be deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Conflict": { "value": { "code": "RECIPIENT_IN_USE", "messages": [ "Recipient cannot be deleted as it is currently being used in active payments" ] } } } } } } }, "parameters": [ { "name": "recipient_id", "in": "path", "required": true, "description": "The unique identifier of the recipient", "schema": { "type": "string" } } ], "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}/onboardings": { "post": { "summary": "Create Onboarding", "operationId": "post_-id-onboardings", "parameters": [ { "in": "path", "name": "recipient_id", "description": "ID of the new recipient to whom the onboarding will be transferred", "schema": { "type": "string" }, "required": true, "example": "9104911d-5df9-429e-8488-ad41abea1a4b" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "type", "workflow", "provider" ], "properties": { "account_id": { "type": "string", "description": "Unique id of the account in Yuno", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "type": { "type": "string", "enum": [ "PREVIOUSLY_ONBOARDED", "ONE_STEP_ONBOARDING", "TWO_STEP_ONBOARDING" ], "description": "Type of onboarding flow. PREVIOUSLY_ONBOARDED for pre-existing accounts, ONE_STEP_ONBOARDING for account creation + KYC in one step, TWO_STEP_ONBOARDING for account creation first then KYC later", "example": "PREVIOUSLY_ONBOARDED" }, "workflow": { "type": "string", "enum": [ "HOSTED_BY_PROVIDER", "DIRECT" ], "description": "Workflow of the onboarding", "example": "HOSTED_BY_PROVIDER" }, "description": { "type": "string", "minLength": 3, "maxLength": 255, "description": "Optional description of the onboarding (MAX 255; MIN 3)." }, "callback_url": { "type": "string", "format": "uri", "description": "URL in case to redirect your customer after the onboarding process with the provider, if needed.", "example": "https://www.google.com" }, "provider": { "type": "object", "required": [ "id", "connection_id" ], "properties": { "id": { "type": "string", "description": "Provider id", "example": "PAGARME" }, "connection_id": { "type": "string", "description": "Id of the connection in Yuno", "example": "104911d-5df9-429e-8488-ad41abea1a4b" }, "recipient_id": { "type": "string", "description": "The unique identifier of the provider's recipient.", "example": "AAAAA01" }, "recipient_type": { "type": "string", "description": "The type of recipient for the provider.", "enum": [ "MEAL", "FOOD", "MULTI_BENEFITS", "FLEET" ], "example": "MEAL" } } }, "documentation": { "type": "array", "description": "Specifies the documentation object.", "items": { "type": "object", "required": [ "file_name", "content_type", "content_category", "content" ], "properties": { "file_name": { "type": "string", "minLength": 3, "maxLength": 255, "description": "The name of the documentation sent (MAX 255; MIN 3).", "example": "PDF" }, "content_type": { "type": "string", "enum": [ "application/pdf", "image/jpeg", "image/png" ], "description": "The type of the documentation sent by the merchant", "example": "application/pdf" }, "content_category": { "type": "string", "enum": [ "ACCOUNT_REQUIREMENT", "BANK_STATEMENT", "BUSINESS_ICON", "BUSINESS_LOGO", "CANCEL_POLICY", "CUSTOMER_INTERACTION", "DRIVERS_LICENCE", "IDENTIFICATION_DOCUMENT", "IDENTIFICATION_DOCUMENT_BACK", "IDENTIFICATION_DOCUMENT_FRONT", "LEGAL_AGREEMENT", "OTHERS", "PASSPORT", "PAYMENT_DETAIL", "PROOF_OF_ADDRESS", "PROOF_OF_AUTHENTICITY", "PROOF_OF_DELIVERY", "PROOF_OF_DIRECTOR", "PROOF_OF_INDUSTRY", "PROOF_OF_NATIONAL_ID_NUMBER", "PROOF_OF_OWNERSHIP", "PROOF_OF_REGISTRATION", "PROOF_OF_RELATIONSHIP", "PROOF_OF_SERVICE", "PROOF_OF_SOURCE_OF_FUNDS", "PROOF_OF_SOURCE_OF_WEALTH", "PROOF_OF_TAX", "PROVIDER_IDENTITY_DOCUMENT", "RECEIPT", "REFUND_POLICY", "SELFIE", "SERVICE_AGREEMENT", "SIGNATURE", "TERMS_AND_CONDITIONS", "VAT_DOCUMENT" ], "description": "The category of the documentation sent by the merchant" }, "content": { "type": "string", "format": "byte", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 2MB.", "example": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg==" } } } }, "withdrawal_methods": { "type": "object", "description": "Specifies the withdrawal methods object.", "properties": { "bank": { "type": "object", "description": "struct", "properties": { "code": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s code (MAX 3; MIN 3)", "example": "246" }, "branch": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s branch (MAX 3; MIN 3)", "example": "XXXX" }, "branch_digit": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s branch digit (MAX 3; MIN 3)" }, "account": { "type": "string", "minLength": 3, "maxLength": 250, "description": "Beneficiary's bank account number (MAX 3; MIN 250)", "example": "1093333333" }, "account_digit": { "type": "string", "minLength": 3, "maxLength": 250, "description": "Beneficiary's bank account digit (MAX 3; MIN 250)" }, "account_type": { "type": "string", "enum": [ "CHECKINGS", "SAVINGS" ], "description": "Beneficiary's bank account type. Allowed values: CHECKINGS, SAVINGS.", "example": "SAVINGS" }, "routing": { "type": "string", "description": "Beneficiary's bank account routing number", "example": "XXXXYYYYC" }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The bank account's country (ISO 3166-1 MAX 2; MIN 2)", "example": "CO" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "description": "The bank account's currency (ISO 3166-1 MAX 3; MIN 3)", "example": "COP" } } } } }, "legal_representatives": { "type": "array", "description": "Object to indicate the owners of the organization. Adyen, Stripe and dlocal have fields related to that.", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "minLength": 3, "maxLength": 255, "description": "Legal representative's identification id (MAX 255; MIN 3)." }, "first_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Legal representative's name. (MAX 255; MIN 1).", "example": "John" }, "last_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Legal representative's last name. (MAX 255; MIN 1).", "example": "Doe" }, "email": { "type": "string", "format": "email", "minLength": 1, "maxLength": 255, "description": "The Legal representative's email (MAX 255; MIN 1).", "example": "john.doe@email.com" }, "date_of_birth": { "type": "string", "format": "date", "minLength": 10, "maxLength": 10, "description": "The Legal representative's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).", "example": "1990-02-28" }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The Legal representative's country (ISO 3166-1 MAX 2; MIN 2)", "example": "CO" }, "nationality": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The Legal representative's nationality (MAX 2; MIN 2; ISO 3166-1).", "example": "CO" }, "title": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The title of the legal representative (MAX 255; MIN 1).", "example": "CTO" }, "publicly_exposed_person": { "type": "boolean", "description": "Indicates if the legal representative is a publicly exposed person", "example": false }, "ultimate_beneficial_owner": { "type": "boolean", "description": "Indicates if the legal representative is an ultimate beneficiary owner of the company", "example": false } } } }, "terms_of_service": { "type": "object", "description": "Object describing terms of service.", "required": [ "acceptance", "date" ], "properties": { "acceptance": { "type": "boolean", "description": "If the terms of service were accepted by the recipient", "example": true }, "date": { "type": "string", "format": "date-time", "description": "Date of the terms of service acceptance", "example": "2022-07-09T20:43:54.786342Z" }, "ip": { "type": "string", "format": "ipv4", "description": "IP of the terms of service acceptance", "example": "192.168.1.100" } } } } }, "examples": { "Create Onboarding": { "value": { "account_id": "{{account-code}}", "type": "PREVIOUSLY_ONBOARDED", "workflow": "DIRECT", "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "VR", "connection_id": "d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4", "recipient_id": "test01", "recipient_type": "MULTI_BENEFITS" }, "documentation": [ { "file_name": "onboarding.pdf", "content_type": "application/pdf", "content_category": "IDENTIFICATION_DOCUMENT", "content": "VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA==" } ], "withdrawal_methods": { "bank": { "code": "002", "branch": "002", "account": "9876543210", "account_type": "CHECKINGS", "country": "US", "currency": "USD", "routing": "021000022" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54.786342Z", "ip": "129.21.111.11" } } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse" }, "examples": { "Successful": { "value": { "id": "61df26d9-3750-4206-baab-f2e20683f35b", "type": "PREVIOUSLY_ONBOARDED", "workflow": "DIRECT", "status": "SUCCEEDED", "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "STRIPE", "connection_id": "8fee3cc6-f3cb-455d-b139-973866111a03", "recipient_id": "acct_1RvpogA4Jk50vKRE", "redirect_url": null, "onboarding_url": null, "legal_entity": null }, "documentation": [ { "file_name": "recipient.pdf", "content_type": "application/pdf", "content_category": "IDENTIFICATION_DOCUMENT", "content": "recipient.pdf-20ac42c2-ef01-4a0c-80dd-0f9f71c9cde7" } ], "legal_representatives": [ { "merchant_reference": "ONB_001", "first_name": "Tatiana", "last_name": "González", "email": "tatiana.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "BR", "nationality": "BR", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": null, "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "110311" } } ], "requirements": [], "withdrawal_methods": { "bank": { "code": "003", "branch": "003", "branch_digit": null, "account": "9876543210", "account_digit": null, "account_type": "CHECKINGS", "routing": "021000022", "country": "US", "currency": "USD" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54.786342Z", "ip": "129.21.111.11" }, "recipient": { "id": "5a37f0c0-7689-4065-8348-4b5ff5bf9cc7", "account_id": "c24d6c92-99a7-40bb-bc7b-efc40337f9f4", "merchant_recipient_id": "MERCHANT_85ac5f5d-a169-46b3-bd87-80c0df2e6591", "national_entity": "INDIVIDUAL", "entity_type": "PRIVATE", "first_name": "Stebann", "last_name": "Castro", "legal_name": "Steban Castro", "email": "juan.perez@example.com", "date_of_birth": "1992-01-21", "country": "CO", "website": "https://juanperez.com", "industry": "Technology", "merchant_category_code": "5740", "document": { "document_number": "09082160000100", "document_type": "CNPJ" }, "phone": { "country_code": "57", "number": "3001234567" }, "address": { "address_line_1": "Carrera 7 # 32-16", "address_line_2": "Oficina 201", "city": "Bogotá", "country": "CO", "state": "Cundinamarca", "zip_code": "110311", "neighborhood": "Centro" }, "legal_representatives": [ { "merchant_reference": "REP_001", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "CO", "nationality": "CO", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": null, "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "110311" } } ], "withdrawal_methods": { "bank": { "code": "001", "branch": "004", "branch_digit": "123", "account": "1234567890", "account_digit": "123", "account_type": "SAVINGS", "routing": "021000021", "country": "CO", "currency": "COP" } }, "documentation": [ { "file_name": "recipient.pdf", "content_type": "application/pdf", "content_category": "IDENTIFICATION_DOCUMENT", "content": "recipient.pdf-2bf73b44-33e3-49c7-b777-34a5178cfb45" } ], "created_at": "2025-08-22T17:54:05.711545Z", "updated_at": "2025-08-22T17:54:05.711561Z" }, "history": { "id": "61df26d9-3750-4206-baab-f2e20683f35b", "type": "PREVIOUSLY_ONBOARDED", "workflow": "DIRECT", "status": "SUCCEEDED", "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "STRIPE", "connection_id": "8fee3cc6-f3cb-455d-b139-973866111a03", "recipient_id": "acct_1RvpogA4Jk50vKRE", "redirect_url": null }, "documentation": [ { "file_name": "recipient.pdf", "content_type": "application/pdf", "content_category": "IDENTIFICATION_DOCUMENT", "content": "recipient.pdf-20ac42c2-ef01-4a0c-80dd-0f9f71c9cde7" } ], "legal_representatives": [ { "merchant_reference": "ONB_001", "first_name": "Tatiana", "last_name": "González", "email": "tatiana.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "BR", "nationality": "BR", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": null, "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "110311" } } ], "requirements": [], "withdrawal_methods": { "bank": { "code": "003", "branch": "003", "branch_digit": null, "account": "9876543210", "account_digit": null, "account_type": "CHECKINGS", "routing": "021000022", "country": "US", "currency": "USD" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54.786342Z", "ip": "129.21.111.11" }, "recipient": { "id": "5a37f0c0-7689-4065-8348-4b5ff5bf9cc7", "account_id": "c24d6c92-99a7-40bb-bc7b-efc40337f9f4", "merchant_recipient_id": "MERCHANT_85ac5f5d-a169-46b3-bd87-80c0df2e6591", "national_entity": "INDIVIDUAL", "entity_type": "PRIVATE", "first_name": "Stebann", "last_name": "Castro", "legal_name": "Steban Castro", "email": "juan.perez@example.com", "date_of_birth": "1992-01-21", "country": "CO", "website": "https://juanperez.com", "industry": "Technology", "merchant_category_code": "5740", "document": { "document_number": "09082160000100", "document_type": "CNPJ" }, "phone": { "country_code": "57", "number": "3001234567" }, "address": { "address_line_1": "Carrera 7 # 32-16", "address_line_2": "Oficina 201", "city": "Bogotá", "country": "CO", "state": "Cundinamarca", "zip_code": "110311", "neighborhood": "Centro" }, "legal_representatives": [ { "merchant_reference": "REP_001", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "CO", "nationality": "CO", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": null, "country": "CO", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "110311" } } ], "withdrawal_methods": { "bank": { "code": "001", "branch": "004", "branch_digit": "123", "account": "1234567890", "account_digit": "123", "account_type": "SAVINGS", "routing": "021000021", "country": "CO", "currency": "COP" } }, "documentation": [ { "file_name": "recipient.pdf", "content_type": "application/pdf", "content_category": "IDENTIFICATION_DOCUMENT", "content": "recipient.pdf-2bf73b44-33e3-49c7-b777-34a5178cfb45" } ], "created_at": "2025-08-22T17:54:05.711545Z", "updated_at": "2025-08-22T17:54:05.711561Z" }, "created_at": "2025-08-22T17:57:58.460711Z", "updated_at": "2025-08-22T17:57:58.460724Z" }, "created_at": "2025-08-22T17:57:58.460711Z", "updated_at": "2025-08-22T17:57:58.460724Z" }, "summary": "Successful" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request format" ] } }, "Transfer Error": { "value": { "id": "9778f631-504d-448f-b2c1-f7b903781df7", "recipient_id": "82b12c8c-7d3d-4a21-a3c6-165cc04ca741", "amount": { "currency": "USD", "value": 50000 }, "status": "ERROR", "description": "test transfer", "merchant_reference": "cb18df20-21ae-4fed-8da9-fb81cfd56797", "metadata": [], "provider": null, "transactions": [ { "code": "9eee65d1-6c3a-4076-9ef9-fa4bff73d597", "type": "SPLIT_TRANSFER", "status": "ERROR", "provider_transfer_id": "tr_1T9PTLIiMnPsFcbbFKyh1Nds", "provider_response_message": "{\n \"id\": \"tr_1T9PTLIiMnPsFcbbFKyh1Nds\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9PTMIiMnPsFcbbxRKvaZ3G\",\n \"created\": 1773145996,\n \"currency\": \"usd\",\n \"description\": \"test transfer\"\n}", "provider_raw_response": "{.... }", "created_at": "2026-03-10T13:39:19.342902Z", "updated_at": "2026-03-10T13:39:19.342914Z" } ], "created_at": "2026-03-10T13:39:19.241990247Z", "updated_at": "2026-03-10T13:39:19.242012664Z" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}/onboardings/{onboarding_id}": { "get": { "summary": "Get Onboarding", "operationId": "get-onboarding", "parameters": [ { "in": "path", "name": "recipient_id", "description": "ID of the recipient", "schema": { "type": "string" }, "required": true, "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, { "in": "path", "name": "onboarding_id", "description": "ID of the onboarding to retrieve", "schema": { "type": "string" }, "required": true, "example": "104911d-5df9-429e-8488-ad41abea1a4b" } ], "responses": { "200": { "description": "Onboarding details retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the onboarding", "example": "104911d-5df9-429e-8488-ad41abea1a4b" }, "account_id": { "type": "string", "description": "Unique id of the account in Yuno", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "recipient_id": { "type": "string", "description": "The unique identifier of the recipient", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "type": { "type": "string", "enum": [ "PREVIOUSLY_ONBOARDED", "ONE_STEP_ONBOARDING", "TWO_STEP_ONBOARDING" ], "description": "Type of onboarding flow", "example": "PREVIOUSLY_ONBOARDED" }, "workflow": { "type": "string", "enum": [ "HOSTED_BY_PROVIDER", "HOSTED_BY_YUNO", "DIRECT" ], "description": "Workflow of the onboarding", "example": "HOSTED_BY_PROVIDER" }, "status": { "type": "string", "description": "Current status of the onboarding", "example": "ACTIVE" }, "callback_url": { "type": "string", "format": "uri", "description": "URL to redirect after the onboarding process", "example": "https://www.google.com" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider id", "example": "PAGARME" }, "connection_id": { "type": "string", "description": "Id of the connection in Yuno", "example": "104911d-5df9-429e-8488-ad41abea1a4b" }, "recipient_id": { "type": "string", "description": "The unique identifier of the provider's recipient", "example": "AAAAA01" } } }, "created_at": { "type": "string", "format": "date-time", "description": "Onboarding creation date", "example": "2024-01-15T10:30:00Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Onboarding last update date", "example": "2024-01-15T10:30:00Z" } } }, "examples": { "Success Response": { "value": { "id": "104911d-5df9-429e-8488-ad41abea1a4b", "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "recipient_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "type": "PREVIOUSLY_ONBOARDED", "workflow": "HOSTED_BY_PROVIDER", "status": "ACTIVE", "callback_url": "https://www.google.com", "provider": { "id": "PAGARME", "connection_id": "104911d-5df9-429e-8488-ad41abea1a4b", "recipient_id": "AAAAA01" }, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "tags": [ "Recipients For Marketplace" ] }, "patch": { "summary": "Update onboarding", "operationId": "update-onboarding", "parameters": [ { "in": "path", "name": "recipient_id", "description": "ID of the recipient whose onboarding will be updated", "schema": { "type": "string" }, "required": true, "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, { "in": "path", "name": "onboarding_id", "description": "ID of the onboarding to be updated", "schema": { "type": "string" }, "required": true, "example": "104911d-5df9-429e-8488-ad41abea1a4b" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Unique id of the account in Yuno", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "type": { "type": "string", "enum": [ "PREVIOUSLY_ONBOARDED", "ONE_STEP_ONBOARDING", "TWO_STEP_ONBOARDING" ], "description": "Type of onboarding flow. PREVIOUSLY_ONBOARDED for pre-existing accounts, ONE_STEP_ONBOARDING for account creation + KYC in one step, TWO_STEP_ONBOARDING for account creation first then KYC later", "example": "PREVIOUSLY_ONBOARDED" }, "workflow": { "type": "string", "enum": [ "HOSTED_BY_PROVIDER", "HOSTED_BY_YUNO", "DIRECT" ], "description": "Workflow of the onboarding", "example": "HOSTED_BY_PROVIDER" }, "callback_url": { "type": "string", "format": "uri", "description": "URL in case to redirect your customer after the onboarding process with the provider, if needed.", "example": "https://www.google.com" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider id", "example": "PAGARME" }, "connection_id": { "type": "string", "description": "Id of the connection in Yuno", "example": "104911d-5df9-429e-8488-ad41abea1a4b" }, "recipient_id": { "type": "string", "description": "The unique identifier of the provider's recipient.", "example": "AAAAA01" }, "recipient_type": { "type": "string", "description": "The type of recipient for the provider.", "enum": [ "MEAL", "FOOD", "MULTI_BENEFITS", "FLEET" ], "example": "MEAL" } } }, "documentation": { "type": "array", "description": "Specifies the documentation object.", "items": { "type": "object", "required": [ "file_name", "content_type", "content_category", "content" ], "properties": { "file_name": { "type": "string", "minLength": 3, "maxLength": 255, "description": "The name of the documentation sent (MAX 255; MIN 3).", "example": "PDF" }, "content_type": { "type": "string", "enum": [ "application/pdf", "image/jpeg", "image/png" ], "description": "The type of the documentation sent by the merchant", "example": "application/pdf" }, "content_category": { "type": "string", "enum": [ "ACCOUNT_REQUIREMENT", "BANK_STATEMENT", "BUSINESS_ICON", "BUSINESS_LOGO", "CANCEL_POLICY", "CUSTOMER_INTERACTION", "DRIVERS_LICENCE", "IDENTIFICATION_DOCUMENT", "IDENTIFICATION_DOCUMENT_BACK", "IDENTIFICATION_DOCUMENT_FRONT", "LEGAL_AGREEMENT", "OTHERS", "PASSPORT", "PAYMENT_DETAIL", "PROOF_OF_ADDRESS", "PROOF_OF_AUTHENTICITY", "PROOF_OF_DELIVERY", "PROOF_OF_DIRECTOR", "PROOF_OF_INDUSTRY", "PROOF_OF_NATIONAL_ID_NUMBER", "PROOF_OF_OWNERSHIP", "PROOF_OF_REGISTRATION", "PROOF_OF_RELATIONSHIP", "PROOF_OF_SERVICE", "PROOF_OF_SOURCE_OF_FUNDS", "PROOF_OF_SOURCE_OF_WEALTH", "PROOF_OF_TAX", "PROVIDER_IDENTITY_DOCUMENT", "RECEIPT", "REFUND_POLICY", "SELFIE", "SERVICE_AGREEMENT", "SIGNATURE", "TERMS_AND_CONDITIONS", "VAT_DOCUMENT" ], "description": "The category of the documentation sent by the merchant" }, "content": { "type": "string", "format": "byte", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 1MB.", "example": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg==" } } } }, "withdrawal_methods": { "type": "object", "description": "Specifies the withdrawal methods object.", "properties": { "bank": { "type": "object", "description": "struct", "properties": { "code": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s code (MAX 3; MIN 3)", "example": "246" }, "branch": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s branch (MAX 3; MIN 3)", "example": "XXXX" }, "branch_digit": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s branch digit (MAX 3; MIN 3)" }, "account": { "type": "string", "minLength": 3, "maxLength": 250, "description": "Beneficiary's bank account number (MAX 3; MIN 250)", "example": "1093333333" }, "account_digit": { "type": "string", "minLength": 3, "maxLength": 250, "description": "Beneficiary's bank account digit (MAX 3; MIN 250)" }, "account_type": { "type": "string", "enum": [ "CHECKINGS", "SAVINGS", "VISTA", "PIX_EMAIL", "PIX_PHONE", "PIX_DOCUMENT_ID", "PIX_BANK_ACCOUNT" ], "description": "Beneficiary's bank account type (MAX 1; MIN 3). Could be: CHECKINGS, SAVINGS, VISTA, PIX_EMAIL, PIX_PHONE, PIX_DOCUMENT_ID, PIX_BANK_ACCOUNT", "example": "SAVINGS" }, "routing": { "type": "string", "description": "Beneficiary's bank account routing number", "example": "XXXXYYYYC" }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The bank account's country (ISO 3166-1 MAX 2; MIN 2)", "example": "CO" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "description": "The bank account's currency (ISO 3166-1 MAX 3; MIN 3)", "example": "COP" } } } } }, "legal_representatives": { "type": "array", "description": "Object to indicate the owners of the organization. Adyen, Stripe and dlocal have fields related to that.", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "minLength": 3, "maxLength": 255, "description": "Legal representative's identification id (MAX 255; MIN 3)." }, "first_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Legal representative's name. (MAX 255; MIN 1).", "example": "John" }, "last_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Legal representative's last name. (MAX 255; MIN 1).", "example": "Doe" }, "email": { "type": "string", "format": "email", "minLength": 1, "maxLength": 255, "description": "The Legal representative's email (MAX 255; MIN 1).", "example": "john.doe@email.com" }, "date_of_birth": { "type": "string", "format": "date", "minLength": 10, "maxLength": 10, "description": "The Legal representative's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).", "example": "1990-02-28" }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The Legal representative's country (ISO 3166-1 MAX 2; MIN 2)", "example": "CO" }, "nationality": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The Legal representative's nationality (MAX 2; MIN 2; ISO 3166-1).", "example": "CO" }, "title": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The title of the legal representative (MAX 255; MIN 1).", "example": "CTO" }, "publicly_exposed_person": { "type": "boolean", "description": "Indicates if the legal representative is a publicly exposed person", "example": false }, "ultimate_beneficial_owner": { "type": "boolean", "description": "Indicates if the legal representative is an ultimate beneficiary owner of the company", "example": false } } } }, "terms_of_service": { "type": "object", "description": "Object describing terms of service.", "required": [ "acceptance", "date" ], "properties": { "acceptance": { "type": "boolean", "description": "If the terms of service were accepted by the recipient", "example": true }, "date": { "type": "string", "format": "date-time", "description": "Date of the terms of service acceptance", "example": "2022-07-09T20:43:54.786342Z" }, "ip": { "type": "string", "format": "ipv4", "description": "IP of the terms of service acceptance", "example": "192.168.1.100" } } } } }, "examples": { "Update Onboarding": { "value": { "account_id": "{{account_id}}", "provider": { "id": "YUNO_TEST_PAYMENT_GW", "connection_id": "{{connection_id}}", "recipient_type": "MULTI_BENEFITS" } } } } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request format" ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}/onboardings/{onboarding_id}/block": { "post": { "summary": "Block Recipient", "operationId": "block-recipient", "responses": { "200": { "description": "Recipient blocked successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse" }, "examples": { "Success Response": { "value": { "id": "9104911d-5df9-429e-8488-ad41abea1a4b", "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "merchant_recipient_id": "AAAA01", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "country": "CO", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T12:00:00Z" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } }, "409": { "description": "Conflict - Recipient cannot be blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Conflict": { "value": { "code": "RECIPIENT_ALREADY_BLOCKED", "messages": [ "Recipient is already blocked" ] } } } } } } }, "parameters": [ { "name": "recipient_id", "in": "path", "required": true, "description": "The unique identifier of the recipient", "schema": { "type": "string" } }, { "name": "onboarding_id", "in": "path", "required": true, "description": "The unique identifier of the onboarding associated with this action.", "schema": { "type": "string" } } ], "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel": { "post": { "summary": "Cancel Onboarding", "operationId": "cancel-recipient", "responses": { "200": { "description": "Recipient cancelled successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse" }, "examples": { "Success Response": { "value": { "id": "9104911d-5df9-429e-8488-ad41abea1a4b", "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "merchant_recipient_id": "AAAA01", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "country": "CO", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T12:00:00Z" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } }, "409": { "description": "Conflict - Recipient cannot be cancelled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Conflict": { "value": { "code": "RECIPIENT_ALREADY_CANCELLED", "messages": [ "Recipient is already cancelled" ] } } } } } } }, "parameters": [ { "name": "recipient_id", "in": "path", "required": true, "description": "The unique identifier of the recipient", "schema": { "type": "string" } }, { "name": "onboarding_id", "in": "path", "required": true, "description": "The unique identifier of the onboarding associated with this action.", "schema": { "type": "string" } } ], "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}/onboardings/{onboarding_id}/continue": { "post": { "summary": "Continue Onboarding", "operationId": "continue-onboarding", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "type", "workflow" ], "properties": { "account_id": { "type": "string", "description": "Unique id of the account in Yuno", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "type": { "type": "string", "enum": [ "TWO_STEP_ONBOARDING" ], "description": "Type of onboarding flow. Only TWO_STEP_ONBOARDING can be continued.", "example": "TWO_STEP_ONBOARDING" }, "workflow": { "type": "string", "enum": [ "HOSTED_BY_PROVIDER", "DIRECT" ], "description": "Workflow of the KYC process. HOSTED_BY_PROVIDER calls create KYC service and returns Yuno URL that redirects to provider. DIRECT calls create KYC service and processes KYC directly.", "example": "HOSTED_BY_PROVIDER" }, "callback_url": { "type": "string", "format": "uri", "description": "URL in case to redirect your customer after the onboarding process with the provider, if needed.", "example": "https://www.google.com" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider id", "example": "PAGARME" }, "connection_id": { "type": "string", "description": "Id of the connection in Yuno", "example": "104911d-5df9-429e-8488-ad41abea1a4b" }, "recipient_id": { "type": "string", "description": "The unique identifier of the provider's recipient.", "example": "AAAAA01" } } }, "documentation": { "type": "array", "description": "Specifies the documentation object.", "items": { "type": "object", "required": [ "file_name", "content_type", "content_category", "content" ], "properties": { "file_name": { "type": "string", "minLength": 3, "maxLength": 255, "description": "The name of the documentation sent (MAX 255; MIN 3).", "example": "PDF" }, "content_type": { "type": "string", "enum": [ "application/pdf", "image/jpeg", "image/png" ], "description": "The type of the documentation sent by the merchant", "example": "application/pdf" }, "content_category": { "type": "string", "enum": [ "ACCOUNT_REQUIREMENT", "BANK_STATEMENT", "BUSINESS_ICON", "BUSINESS_LOGO", "CANCEL_POLICY", "CUSTOMER_INTERACTION", "DRIVERS_LICENCE", "DRIVERS_LICENCE_BACK", "IDENTIFICATION_DOCUMENT", "IDENTIFICATION_DOCUMENT_BACK", "IDENTIFICATION_DOCUMENT_FRONT", "LEGAL_AGREEMENT", "OTHERS", "PASSPORT", "PAYMENT_DETAIL", "PROOF_OF_ADDRESS", "PROOF_OF_AUTHENTICITY", "PROOF_OF_DELIVERY", "PROOF_OF_DIRECTOR", "PROOF_OF_INDUSTRY", "PROOF_OF_NATIONAL_ID_NUMBER", "PROOF_OF_OWNERSHIP", "PROOF_OF_REGISTRATION", "PROOF_OF_RELATIONSHIP", "PROOF_OF_SERVICE", "PROOF_OF_SOURCE_OF_FUNDS", "PROOF_OF_SOURCE_OF_WEALTH", "PROOF_OF_TAX", "PROVIDER_IDENTITY_DOCUMENT", "RECEIPT", "REFUND_POLICY", "SELFIE", "SERVICE_AGREEMENT", "SIGNATURE", "TERMS_AND_CONDITIONS", "VAT_DOCUMENT" ], "description": "The category of the documentation sent by the merchant" }, "content": { "type": "string", "format": "byte", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 1MB.", "example": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg==" } } } }, "withdrawal_methods": { "type": "object", "description": "Specifies the withdrawal methods object.", "properties": { "bank": { "type": "object", "description": "struct", "properties": { "code": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s code (MAX 3; MIN 3)", "example": "246" }, "branch": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s branch (MAX 3; MIN 3)", "example": "XXXX" }, "branch_digit": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Bank´s branch digit (MAX 3; MIN 3)" }, "account": { "type": "string", "minLength": 3, "maxLength": 250, "description": "Beneficiary's bank account number (MAX 3; MIN 250)", "example": "1093333333" }, "account_digit": { "type": "string", "minLength": 3, "maxLength": 250, "description": "Beneficiary's bank account digit (MAX 3; MIN 250)" }, "account_type": { "type": "string", "enum": [ "CHECKINGS", "SAVINGS", "VISTA", "PIX_EMAIL", "PIX_PHONE", "PIX_DOCUMENT_ID", "PIX_BANK_ACCOUNT" ], "description": "Beneficiary's bank account type (MAX 1; MIN 3). Could be: CHECKINGS, SAVINGS, VISTA, PIX_EMAIL, PIX_PHONE, PIX_DOCUMENT_ID, PIX_BANK_ACCOUNT", "example": "SAVINGS" }, "routing": { "type": "string", "description": "Beneficiary's bank account routing number", "example": "XXXXYYYYC" }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The bank account's country (ISO 3166-1 MAX 2; MIN 2)", "example": "CO" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "description": "The bank account's currency (ISO 3166-1 MAX 3; MIN 3)", "example": "COP" } } } } }, "legal_representatives": { "type": "array", "description": "Object to indicate the owners of the organization. Adyen, Stripe and dlocal have fields related to that.", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "minLength": 3, "maxLength": 255, "description": "Legal representative's identification id (MAX 255; MIN 3)." }, "first_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Legal representative's name. (MAX 255; MIN 1).", "example": "John" }, "last_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Legal representative's last name. (MAX 255; MIN 1).", "example": "Doe" }, "email": { "type": "string", "format": "email", "minLength": 1, "maxLength": 255, "description": "The Legal representative's email (MAX 255; MIN 1).", "example": "john.doe@email.com" }, "date_of_birth": { "type": "string", "format": "date", "minLength": 10, "maxLength": 10, "description": "The Legal representative's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).", "example": "1990-02-28" }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The Legal representative's country (ISO 3166-1 MAX 2; MIN 2)", "example": "CO" }, "nationality": { "type": "string", "minLength": 2, "maxLength": 2, "description": "The Legal representative's nationality (MAX 2; MIN 2; ISO 3166-1).", "example": "CO" }, "title": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The title of the legal representative (MAX 255; MIN 1).", "example": "CTO" }, "publicly_exposed_person": { "type": "boolean", "description": "Indicates if the legal representative is a publicly exposed person", "example": false }, "ultimate_beneficial_owner": { "type": "boolean", "description": "Indicates if the legal representative is an ultimate beneficiary owner of the company", "example": false } } } }, "terms_of_service": { "type": "object", "description": "Object describing terms of service.", "required": [ "acceptance", "date" ], "properties": { "acceptance": { "type": "boolean", "description": "If the terms of service were accepted by the recipient", "example": true }, "date": { "type": "string", "format": "date-time", "description": "Date of the terms of service acceptance", "example": "2022-07-09T20:43:54.786342Z" }, "ip": { "type": "string", "format": "ipv4", "description": "IP of the terms of service acceptance", "example": "192.168.1.100" } } } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse" }, "examples": { "Successful": { "value": { "id": "61df26d9-3750-4206-baab-f2e20683f35b", "type": "TWO_STEP_ONBOARDING", "workflow": "HOSTED_BY_PROVIDER", "status": "PENDING", "provider": { "id": "STRIPE", "connection_id": "8fee3cc6-f3cb-455d-b139-973866111a03", "recipient_id": "acct_1RvpogA4Jk50vKRE", "redirect_url": "https://api.y.uno/redirect/kyc/stripe/session_12345" }, "created_at": "2025-08-22T17:57:58.460711Z", "updated_at": "2025-08-22T18:15:22.123456Z" }, "summary": "Successful" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request format" ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "parameters": [ { "in": "path", "name": "recipient_id", "description": "ID of the recipient", "schema": { "type": "string" }, "required": true, "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, { "in": "path", "name": "onboarding_id", "description": "ID of the onboarding to continue", "schema": { "type": "string" }, "required": true, "example": "104911d-5df9-429e-8488-ad41abea1a4b" } ], "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}/onboardings/{onboarding_id}/transfer": { "post": { "description": "", "operationId": "post_recipients-id-onboardings-id-transfer", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "ed206787-6203-45a6-b896-71249fff7ddb" }, "origin_onboarding": { "type": "object", "properties": { "id": { "type": "string", "example": "c2f96b59-ae5a-470d-a94a-16bf142b11df" }, "type": { "type": "string", "example": "ONE_STEP_ONBOARDING" }, "workflow": { "type": "string", "example": "DIRECT" }, "description": { "type": "string", "example": "Onboarding Description" }, "status": { "type": "string", "example": "INACTIVE" }, "response_message": {}, "callback_url": { "type": "string", "example": "https://merchant.example.com/webhook/onboarding" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "example": "b90fa936-92b6-4529-9c69-0ca474291af1" }, "recipient_id": { "type": "string", "example": "acct_1SpfTBRFM5RUW372" }, "redirect_url": {}, "onboarding_url": { "type": "string", "example": "" }, "legal_entity": {}, "recipient_additional_id": {}, "balance_account_id": { "type": "string", "example": "" }, "recipient_type": {}, "raw_notification": {}, "raw_response": {}, "response_code": {}, "response_message": {} } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "onboarding10.png" }, "content_type": { "type": "string", "example": "image/png" }, "content_category": { "type": "string", "example": "VAT_DOCUMENT" }, "content": { "type": "string", "example": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" } } } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "example": "ONB_010" }, "first_name": { "type": "string", "example": "Maria" }, "last_name": { "type": "string", "example": "Gonzalez" }, "email": { "type": "string", "example": "maria.gonzalez@example.com" }, "date_of_birth": { "type": "string", "example": "1985-05-20" }, "country": { "type": "string", "example": "US" }, "nationality": { "type": "string", "example": "US" }, "title": { "type": "string", "example": "CEO" }, "publicly_exposed_person": { "type": "boolean", "example": false, "default": true }, "ultimate_beneficial_owner": { "type": "boolean", "example": true, "default": true }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "0987654321" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "3109876543" }, "country_code": { "type": "string", "example": "+57" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 26 # 13-19" }, "address_line_2": { "type": "string", "example": "test calle" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogota" }, "zip_code": { "type": "string", "example": "03804" }, "neighborhood": { "type": "string", "example": "Centro" } } } } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "test" }, "value": { "type": "string", "example": "123" } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "004" }, "branch": { "type": "string", "example": "006" }, "branch_digit": { "type": "string", "example": "125" }, "account": { "type": "string", "example": "000123456789" }, "account_digit": { "type": "string", "example": "124" }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "110000000" }, "country": { "type": "string", "example": "US" }, "currency": { "type": "string", "example": "USD" }, "payout_schedule": { "type": "string", "example": "HOLD" } } } } }, "terms_of_service": { "type": "object", "properties": { "acceptance": { "type": "boolean", "example": true, "default": true }, "date": { "type": "string", "example": "2025-07-21T20:43:54.786342Z" }, "ip": { "type": "string", "example": "129.21.111.11" } } }, "created_at": { "type": "string", "example": "2026-01-15T21:33:17.374975Z" }, "updated_at": { "type": "string", "example": "2026-01-15T21:33:44.650123Z" } } }, "destination_onboarding": { "type": "object", "properties": { "id": { "type": "string", "example": "97254599-4f94-4aff-9777-733a8e0e95e1" }, "type": { "type": "string", "example": "ONE_STEP_ONBOARDING" }, "workflow": { "type": "string", "example": "DIRECT" }, "description": { "type": "string", "example": "Onboarding Description" }, "status": { "type": "string", "example": "SUCCEEDED" }, "response_message": {}, "callback_url": { "type": "string", "example": "https://merchant.example.com/webhook/onboarding" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "example": "b90fa936-92b6-4529-9c69-0ca474291af1" }, "recipient_id": { "type": "string", "example": "acct_1SpfStIPQ4THTT53" }, "redirect_url": {}, "onboarding_url": { "type": "string", "example": "" }, "legal_entity": {}, "recipient_additional_id": {}, "balance_account_id": { "type": "string", "example": "" }, "recipient_type": {}, "raw_notification": {}, "raw_response": {}, "response_code": {}, "response_message": {} } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "onboarding10.png" }, "content_type": { "type": "string", "example": "image/png" }, "content_category": { "type": "string", "example": "VAT_DOCUMENT" }, "content": { "type": "string", "example": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" } } } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "example": "ONB_010" }, "first_name": { "type": "string", "example": "Maria" }, "last_name": { "type": "string", "example": "Gonzalez" }, "email": { "type": "string", "example": "maria.gonzalez@example.com" }, "date_of_birth": { "type": "string", "example": "1985-05-20" }, "country": { "type": "string", "example": "US" }, "nationality": { "type": "string", "example": "US" }, "title": { "type": "string", "example": "CEO" }, "publicly_exposed_person": { "type": "boolean", "example": false, "default": true }, "ultimate_beneficial_owner": { "type": "boolean", "example": true, "default": true }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "0987654321" } } }, "phone": { "type": "object", "properties": { "number": { "type": "string", "example": "3109876543" }, "country_code": { "type": "string", "example": "+57" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 26 # 13-19" }, "address_line_2": { "type": "string", "example": "test calle" }, "country": { "type": "string", "example": "US" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogota" }, "zip_code": { "type": "string", "example": "03804" }, "neighborhood": { "type": "string", "example": "Centro" } } } } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "test" }, "value": { "type": "string", "example": "123" } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "004" }, "branch": { "type": "string", "example": "006" }, "branch_digit": { "type": "string", "example": "125" }, "account": { "type": "string", "example": "000123456789" }, "account_digit": { "type": "string", "example": "124" }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "110000000" }, "country": { "type": "string", "example": "US" }, "currency": { "type": "string", "example": "USD" }, "payout_schedule": { "type": "string", "example": "HOLD" } } } } }, "terms_of_service": { "type": "object", "properties": { "acceptance": { "type": "boolean", "example": true, "default": true }, "date": { "type": "string", "example": "2025-07-21T20:43:54.786342Z" }, "ip": { "type": "string", "example": "129.21.111.11" } } }, "created_at": { "type": "string", "example": "2026-01-15T01:35:10.646218Z" }, "updated_at": { "type": "string", "example": "2026-01-15T21:33:46.245564Z" } } }, "created_at": { "type": "string", "example": "2026-01-15T21:33:46.456587Z" }, "updated_at": { "type": "string", "example": "2026-01-15T21:33:46.456624Z" } } }, "examples": { "Success": { "value": { "id": "ed206787-6203-45a6-b896-71249fff7ddb", "origin_onboarding": { "id": "c2f96b59-ae5a-470d-a94a-16bf142b11df", "type": "ONE_STEP_ONBOARDING", "workflow": "DIRECT", "description": "Onboarding Description", "status": "INACTIVE", "response_message": null, "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "STRIPE", "connection_id": "b90fa936-92b6-4529-9c69-0ca474291af1", "recipient_id": "acct_1SpfTBRFM5RUW372", "redirect_url": null, "onboarding_url": "", "legal_entity": null, "recipient_additional_id": null, "balance_account_id": "", "recipient_type": null, "raw_notification": null, "raw_response": null, "response_code": null, "response_message": null }, "documentation": [ { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" }, { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" } ], "legal_representatives": [ { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } }, { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } } ], "metadata": [ { "key": "test", "value": "123" } ], "withdrawal_methods": { "bank": { "code": "004", "branch": "006", "branch_digit": "125", "account": "000123456789", "account_digit": "124", "account_type": "SAVINGS", "routing": "110000000", "country": "US", "currency": "USD", "payout_schedule": "HOLD" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54.786342Z", "ip": "129.21.111.11" }, "created_at": "2026-01-15T21:33:17.374975Z", "updated_at": "2026-01-15T21:33:44.650123Z" }, "destination_onboarding": { "id": "97254599-4f94-4aff-9777-733a8e0e95e1", "type": "ONE_STEP_ONBOARDING", "workflow": "DIRECT", "description": "Onboarding Description", "status": "SUCCEEDED", "response_message": null, "callback_url": "https://merchant.example.com/webhook/onboarding", "provider": { "id": "STRIPE", "connection_id": "b90fa936-92b6-4529-9c69-0ca474291af1", "recipient_id": "acct_1SpfStIPQ4THTT53", "redirect_url": null, "onboarding_url": "", "legal_entity": null, "recipient_additional_id": null, "balance_account_id": "", "recipient_type": null, "raw_notification": null, "raw_response": null, "response_code": null, "response_message": null }, "documentation": [ { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" }, { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" }, { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" }, { "file_name": "onboarding10.png", "content_type": "image/png", "content_category": "VAT_DOCUMENT", "content": "onboarding10.png-c86969b6-6ddc-4bc2-9bce-f190a05679bf" } ], "legal_representatives": [ { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } }, { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } }, { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } }, { "merchant_reference": "ONB_010", "first_name": "María", "last_name": "González", "email": "maria.gonzalez@example.com", "date_of_birth": "1985-05-20", "country": "US", "nationality": "US", "title": "CEO", "publicly_exposed_person": false, "ultimate_beneficial_owner": true, "document": { "document_type": "CC", "document_number": "0987654321" }, "phone": { "number": "3109876543", "country_code": "+57" }, "address": { "address_line_1": "Calle 26 # 13-19", "address_line_2": "test calle", "country": "US", "state": "Cundinamarca", "city": "Bogotá", "zip_code": "03804", "neighborhood": "Centro" } } ], "metadata": [ { "key": "test", "value": "123" } ], "withdrawal_methods": { "bank": { "code": "004", "branch": "006", "branch_digit": "125", "account": "000123456789", "account_digit": "124", "account_type": "SAVINGS", "routing": "110000000", "country": "US", "currency": "USD", "payout_schedule": "HOLD" } }, "terms_of_service": { "acceptance": true, "date": "2025-07-21T20:43:54.786342Z", "ip": "129.21.111.11" }, "created_at": "2026-01-15T01:35:10.646218Z", "updated_at": "2026-01-15T21:33:46.245564Z" }, "created_at": "2026-01-15T21:33:46.456587Z", "updated_at": "2026-01-15T21:33:46.456624Z" }, "summary": "Success" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } }, "examples": { "Invalid Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request format" ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } } }, "parameters": [ { "in": "path", "name": "recipient_id", "description": "ID of the new recipient to whom the onboarding will be transferred", "schema": { "type": "string" }, "required": true, "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, { "in": "path", "name": "onboarding_id", "description": "ID of the new onboarding to whom the onboarding will be transferred", "schema": { "type": "string" }, "required": true, "example": "104911d-5df9-429e-8488-ad41abea1a4b" }, { "in": "header", "name": "X-organization-code", "schema": { "type": "string" }, "required": true, "description": "Organization code associated to the request." }, { "in": "header", "name": "X-Idempotency-Key", "schema": { "type": "string" }, "required": true, "description": "Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts." } ], "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}/onboardings/{onboarding_id}/unblock": { "post": { "summary": "Unblock Recipient", "operationId": "unblock-recipient", "responses": { "200": { "description": "Recipient unblocked successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse" }, "examples": { "Success Response": { "value": { "id": "9104911d-5df9-429e-8488-ad41abea1a4b", "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b", "merchant_recipient_id": "AAAA01", "national_entity": "INDIVIDUAL", "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "country": "CO", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T12:00:00Z" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } } } } }, "409": { "description": "Conflict - Recipient cannot be unblocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Conflict": { "value": { "code": "RECIPIENT_NOT_BLOCKED", "messages": [ "Recipient is not blocked" ] } } } } } } }, "parameters": [ { "name": "recipient_id", "in": "path", "required": true, "description": "The unique identifier of the recipient", "schema": { "type": "string" } }, { "name": "onboarding_id", "in": "path", "required": true, "description": "The unique identifier of the onboarding associated with this action.", "schema": { "type": "string" } } ], "tags": [ "Recipients For Marketplace" ] } }, "/recipients/{recipient_id}/transfers": { "get": { "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "OK: Array of transfers (by most recent)": { "summary": "OK: Array of transfers (by most recent)", "value": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "origin_onboarding": { "id": "660e8400-e29b-41d4-a716-446655440001", "status": "TRANSFERRED", "type": "ONE_STEP_ONBOARDING", "workflow": "DIRECT", "provider": { "id": "STRIPE", "recipient_id": "acct_1234567890", "connection_id": "880e8400-e29b-41d4-a716-446655440003" }, "recipient": { "id": "770e8400-e29b-41d4-a716-446655440002", "merchant_recipient_id": "seller-123", "email": "seller@example.com" }, "created_at": "2026-01-15T10:00:00Z", "updated_at": "2026-01-15T16:59:22Z" }, "destination_onboarding": { "id": "990e8400-e29b-41d4-a716-446655440004", "status": "SUCCEEDED", "type": "ONE_STEP_ONBOARDING", "provider": { "id": "STRIPE", "recipient_id": "acct_0987654321", "connection_id": "880e8400-e29b-41d4-a716-446655440003" }, "recipient": { "id": "aa0e8400-e29b-41d4-a716-446655440005", "merchant_recipient_id": "seller-456", "email": "newseller@example.com" }, "created_at": "2026-01-15T16:59:22Z", "updated_at": "2026-01-15T16:59:23Z" }, "created_at": "2026-01-15T16:59:22.996009Z", "updated_at": "2026-01-15T16:59:23.734739Z" }, { "id": "bb0e8400-e29b-41d4-a716-446655440006", "origin_onboarding": { "id": "cc0e8400-e29b-41d4-a716-446655440007", "status": "TRANSFERRED", "recipient": { "id": "770e8400-e29b-41d4-a716-446655440002", "merchant_recipient_id": "seller-123" } }, "destination_onboarding": { "id": "dd0e8400-e29b-41d4-a716-446655440008", "status": "SUCCEEDED", "recipient": { "id": "ee0e8400-e29b-41d4-a716-446655440009", "merchant_recipient_id": "seller-789" } }, "created_at": "2026-01-10T08:30:00.000000Z", "updated_at": "2026-01-10T08:30:15.000000Z" } ] } } } } }, "403": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "FORBIDDEN" }, "messages": { "type": "array", "items": { "type": "string", "example": "You do not have permission to access this resource." } } } }, "examples": { "Forbidden: Recipient belongs to different organization": { "summary": "Forbidden: Recipient belongs to different organization", "value": { "code": "FORBIDDEN", "messages": [ "You do not have permission to access this resource." ] } } } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "RECIPIENT_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Recipient not found." } } } }, "examples": { "Not Found: Recipient does not exist": { "summary": "Not Found: Recipient does not exist", "value": { "code": "RECIPIENT_NOT_FOUND", "messages": [ "Recipient not found." ] } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "recipient_id", "schema": { "type": "string", "default": "{{recipient_id}}" }, "required": true, "description": "The recipient `id` returned from the [create recipient](/reference/create-recipient-1) endpoint (UUID)." }, { "in": "header", "name": "x-account-code", "schema": { "type": "string" }, "description": "The `account_id` found in your [Yuno Dashboard](https://dashboard.y.uno/developers) (UUID)." } ], "operationId": "get_recipients-recipient-id-transfers", "tags": [ "Recipients For Marketplace" ] } }, "/reporting/transactions": { "post": { "summary": "Report Off-Yuno Transactions", "description": "Reports transactions processed directly with a provider (outside Yuno). Each accepted event is persisted as a regular Yuno payment with `origin: REPORTED` — visible in the dashboard, listings and analytics, but never routed, retried or charged by Yuno.", "operationId": "report-transactions", "parameters": [ { "in": "header", "name": "PUBLIC-API-KEY", "schema": { "type": "string" }, "description": "Your public API key." }, { "in": "header", "name": "PRIVATE-SECRET-KEY", "schema": { "type": "string" }, "description": "Your private secret key. Never expose it client-side." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "events" ], "properties": { "account_id": { "type": "string", "format": "uuid", "description": "UUID of the Yuno account the reported payments belong to." }, "events": { "type": "array", "minItems": 1, "maxItems": 500, "description": "One event or a batch of up to 500. Events are processed per item: one invalid event never rejects the batch.", "items": { "type": "object", "additionalProperties": false, "required": [ "report_id", "merchant_order_id", "country", "payment_method_type", "result", "amount", "provider_id" ], "properties": { "report_id": { "type": "string", "maxLength": 255, "description": "Your unique identifier for this event — the deduplication key. An event with a `report_id` already ingested is counted as a duplicate and never ingested twice, which makes retries safe.", "examples": [ "merchant-rpt-000123" ] }, "merchant_order_id": { "type": "string", "maxLength": 255, "description": "Your order reference — how you find the payment in the dashboard.", "examples": [ "order_45678" ] }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Uppercase ISO 3166-1 alpha-2 country code of the transaction (e.g. `US`); lowercase or unknown codes are rejected.", "examples": [ "US" ] }, "payment_method_type": { "type": "string", "description": "Payment method type used at the provider — must be one of Yuno's payment-method types (e.g. `CARD`, `PIX`); unknown types are rejected.", "examples": [ "CARD" ] }, "result": { "type": "string", "enum": [ "SUCCEEDED", "DECLINED", "ERROR" ], "description": "The outcome the provider gave you. Maps to the payment status together with the event type: `PURCHASE`+`SUCCEEDED` → payment `SUCCEEDED`; `AUTHORIZE`+`SUCCEEDED` → `PENDING`/`AUTHORIZED` (an approved authorization is not captured money); `DECLINED` → `DECLINED`; `ERROR` → `ERROR`." }, "amount": { "type": "object", "required": [ "value", "currency" ], "description": "Transaction amount. Decimal value — a payment of $99 is `99.00`, not `9900`.", "properties": { "value": { "type": "number", "minimum": 0, "description": "Decimal amount, greater than or equal to zero. A `0` amount is typical of `VERIFY` events (zero-dollar verification).", "examples": [ 99 ] }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Uppercase ISO 4217 currency code (e.g. `USD`); lowercase or unknown codes are rejected.", "examples": [ "USD" ] } } }, "provider_id": { "type": "string", "description": "The provider you processed the transaction with — must be one of Yuno's catalog provider ids (e.g. `ADYEN`); unknown providers are rejected. Shown on the payment, enabling provider-level segmentation in the dashboard and analytics.", "examples": [ "ADYEN" ] }, "latency_ms": { "type": "integer", "minimum": 0, "description": "Optional. The provider's response time as observed by you, in milliseconds (round-trip of the authorization call). Feeds latency analytics per provider.", "examples": [ 180 ] }, "token_type_used": { "type": "string", "enum": [ "FPAN", "DPAN", "PROVIDER_TOKEN" ], "description": "Optional. The credential you sent to the provider for this transaction: `FPAN` — the real card number (funding PAN); `DPAN` — the card's network token; `PROVIDER_TOKEN` — a token issued by that provider for the stored card (e.g. a saved-card or stored-payment-method token on the provider's own vault). Powers approval-rate analysis per token type.", "examples": [ "DPAN" ] }, "event_type": { "type": "string", "enum": [ "PURCHASE", "AUTHORIZE", "VERIFY" ], "default": "PURCHASE", "description": "Optional. The operation you performed at the provider: `PURCHASE` — a direct charge (authorization and capture in one step; the default when omitted); `AUTHORIZE` — an authorization to be captured later (the payment lands `PENDING` with sub-status `AUTHORIZED`); `VERIFY` — a card verification / zero-dollar authorization (the payment lands `SUCCEEDED` with sub-status `VERIFIED`)." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Optional. When the transaction happened at the provider (RFC 3339, UTC). Defaults to the time Yuno receives the event.", "examples": [ "2026-08-14T10:41:07Z" ] }, "raw_provider_response": { "type": "object", "description": "Optional. The provider's response payload, verbatim (JSON, up to 64 KB). Stored with defensive card-data redaction applied; never returned by any API. Archiving it lets Yuno enrich the payment later without asking you for anything new." } } } } } }, "examples": { "minimal": { "summary": "Minimal event (required fields only)", "value": { "account_id": "3f2a1b6c-8d4e-4f5a-9b0c-1d2e3f4a5b6c", "events": [ { "report_id": "merchant-rpt-000123", "merchant_order_id": "order_45678", "country": "US", "payment_method_type": "CARD", "result": "SUCCEEDED", "amount": { "currency": "USD", "value": 99 }, "provider_id": "ADYEN" } ] } }, "full": { "summary": "Full event (all v1 fields)", "value": { "account_id": "3f2a1b6c-8d4e-4f5a-9b0c-1d2e3f4a5b6c", "events": [ { "report_id": "merchant-rpt-000125", "merchant_order_id": "order_45679", "country": "US", "payment_method_type": "CARD", "result": "SUCCEEDED", "amount": { "currency": "USD", "value": 99 }, "provider_id": "ADYEN", "latency_ms": 180, "token_type_used": "DPAN", "event_type": "PURCHASE", "occurred_at": "2026-08-14T10:41:07Z", "raw_provider_response": { "pspReference": "8815992887", "resultCode": "Authorised" } } ] } } } } } }, "responses": { "202": { "description": "Batch accepted and processed per event.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accepted": { "type": "integer", "description": "Events ingested as payments." }, "duplicates": { "type": "integer", "description": "Events skipped because their `report_id` was already ingested." }, "rejected": { "type": "array", "description": "Events that failed validation, each with its reason. The rest of the batch is unaffected.", "items": { "type": "object", "properties": { "report_id": { "type": "string" }, "code": { "type": "string", "examples": [ "INVALID_EVENT" ] }, "messages": { "type": "array", "items": { "type": "string" } } } } } } }, "examples": { "mixed": { "value": { "accepted": 2, "duplicates": 1, "rejected": [ { "report_id": "merchant-rpt-000124", "code": "INVALID_EVENT", "messages": [ "The field 'event_type' must be one of: PURCHASE, AUTHORIZE, VERIFY." ] } ] } } } } } }, "400": { "description": "Request-level validation failure — malformed body, missing required field, or a batch over 500 events. An `account_id` that does not exist or does not belong to your organization answers `INVALID_ACCOUNT_ID`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "invalid_request": { "value": { "code": "INVALID_REQUEST", "messages": [ "The field 'events' must contain between 1 and 500 events." ] } } } } } }, "403": { "description": "Forbidden — `PRODUCT_NOT_ENABLED` (the product is not enabled for your organization).", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "product_not_enabled": { "value": { "code": "PRODUCT_NOT_ENABLED", "messages": [ "The Transaction Reporting API is enabled per organization. Contact your Key Account Manager (KAM) to activate it." ] } } } } } } }, "tags": [ "Reporting" ] } }, "/reports": { "post": { "summary": "Create a Report", "description": "", "operationId": "create-a-report", "parameters": [ { "name": "X-Organization-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Organization code associated to the request." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "start_date", "end_date" ], "properties": { "type": { "type": "string", "description": "The type of the report to run (MAX 255; MIN 3).", "enum": [ "PAYOUTS", "PAYMENTS", "TRANSACTIONS", "SETTLEMENT_FEES", "RECONCILIATION_OVERVIEW", "COMMUNICATIONS" ] }, "user_code": { "type": "string", "description": "The user identifier to associate with the report request." }, "start_date": { "type": "string", "description": "Starting timestamp of data to be included in the report run (MAX 24; MIN 24; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).", "format": "date-time" }, "end_date": { "type": "string", "description": "Ending timestamp of data to be included in the report run (MAX 24; MIN 24; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).", "format": "date-time" }, "merchant_reference_id": { "type": "string", "description": "The unique identifier of the report at the merchant side (MAX 255; MIN 3)." }, "account_id": { "type": "string", "description": "Account identifier(s). Omit to include all accounts. For multiple accounts, send a comma-separated list.
Example: `19d28762-c714-4fb0-9ef6-4e1953ed33tf, 91d82267-c714-4fb0-9ef6-4e1953ed33tf`." }, "acquirer": { "type": "string", "description": "Filters the Settlements report by acquirer. Accepts a single value (case-insensitive; conventionally uppercase).
Example: `BAC_CREDOMATIC`" }, "payment_status": { "type": "string", "description": "The status of the payment (MAX 255; MIN 3; [Payment status](/reference/payment#payments-status)). Don't send this parameter to request the creation of a report for all payment status. Otherwise, indicate all the status you want to include.
Example: `CREATED,READY_TO_PAY,DECLINED`" }, "payment_sub_status": { "type": "string", "description": "The substatus of the payment (MAX 255; MIN 3; [Payment substatus](/reference/payment#payments-status)). Don't send this parameter to request the creation of a report for all payment sub status. Otherwise, indicate all the sub status you want to include.
Example: `READY_TO_PAY,PENDING_FRAUD_REVIEW,EXPIRED`" }, "payment_method": { "type": "string", "description": "The type of payment method selected by the customer (MAX 255; MIN 3; [Payment methods](/reference/payment-type-list)). Don't send this parameter to request the creation of a report for all payment methods. Otherwise, indicate all the methods you want to include.
Example: `ADDI,ACUOTAZ,PIX`" }, "currency": { "type": "string", "description": "The currency used to make the payment (MAX 3; MIN 3; [ISO 4217](/reference/country-reference)). Don't send this parameter to request the creation of a report for all currencies. Otherwise, indicate all currencies you want to include.
Example: `ARS,BRL,COP`" }, "country": { "type": "string", "description": "The country where the transaction must be processed (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference)). Don't send this parameter to request the creation of a report for all countries. Otherwise, indicate all countries you want to include.
Example: `AR,BR,CO`" }, "transaction_type": { "type": "string", "description": "The transaction type (MAX 255; MIN 3; [Transaction types](/reference/transaction#types-of-transactions)). Don't send this parameter to request the creation of a report for all transaction types. Otherwise, indicate all transaction types you want to include.
Example: `PURCHASE,REFUND,VERIFY`" }, "transaction_status": { "type": "string", "description": "The status of the transaction (MAX 255; MIN 3; [Transaction status](/reference/payment#payments-status)). Don't send this parameter to request the creation of a report for all transaction status. Otherwise, indicate all transaction status you want to include.
Example: `SUCCEEDED,CREATED,EXPIRED`" }, "updated_at_start": { "type": "string", "description": "Starting timestamp of data to be included in the report run by updated date of operation (MAX 27; MIN 27; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).", "format": "date-time" }, "updated_at_end": { "type": "string", "description": "Ending timestamp of data to be included in the report run by updated date of operation (MAX 27; MIN 27; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).", "format": "date-time" }, "columns": { "type": "string", "description": "Columns to include (only for Payment or Transaction reports). See available fields in [Report Fields](/reference/reports-fields).
Example: `account_code,amount_value,card_category`" }, "metadata_fields": { "type": "string", "description": "Columns to include (only if the merchant is exporting metadata fields). This option is exclusive to Transaction and Settlement reports." } } }, "examples": { "Create a report": { "value": { "type": "PAYMENTS", "start_date": "2023-07-28T21:09:03.327Z", "end_date": "2023-07-28T21:09:03.327Z", "merchant_reference_id": "test_id", "account_id": "19d28762-c714-4fb0-9ef6-4e1953ed33tf, 91d82267-c714-4fb0-9ef6-4e1953ed33tf", "payment_status": "CREATED,READY_TO_PAY,DECLINED", "payment_sub_status": "READY_TO_PAY,PENDING_FRAUD_REVIEW,EXPIRED", "payment_method": "ADDI,ACUOTAZ,PIX", "currency": "ARS,BRL,COP", "country": "AR,BR,CO", "transaction_type": "PURCHASE,REFUND,VERIFY", "transaction_status": "SUCCEEDED,CREATED,EXPIRED", "updated_at_start": "2023-07-28T21:09:03.327Z", "updated_at_end": "2023-07-28T21:09:03.327Z", "columns": "account_code,amount_value,card_category" } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": { "id": "6d905149-b388-4522-8c0a-759fed1f39da", "type": "PAYMENTS", "start_date": "2023-07-01 00:00:00 +0000 UTC", "end_date": "2023-07-12 00:00:00 +0000 UTC", "merchant_reference_id": "payments_1", "created_at": "2023-07-12 20:10:30.311048496 +0000 UTC", "updated_at": "2023-07-12 20:10:30.311048496 +0000 UTC", "expires_at": "", "status": "IN_PROCESS" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6d905149-b388-4522-8c0a-759fed1f39da" }, "type": { "type": "string", "example": "PAYMENTS" }, "start_date": { "type": "string", "example": "2023-07-01 00:00:00 +0000 UTC" }, "end_date": { "type": "string", "example": "2023-07-12 00:00:00 +0000 UTC" }, "merchant_reference_id": { "type": "string", "example": "payments_1" }, "created_at": { "type": "string", "example": "2023-07-12 20:10:30.311048496 +0000 UTC" }, "updated_at": { "type": "string", "example": "2023-07-12 20:10:30.311048496 +0000 UTC" }, "expires_at": { "type": "string", "example": "" }, "status": { "type": "string", "example": "IN_PROCESS" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Reports" ] } }, "/reports/list": { "get": { "summary": "List All Reports", "description": "", "operationId": "list-all-reports", "parameters": [ { "name": "X-Organization-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Organization code associated to the request." }, { "name": "account_id", "in": "query", "description": "The unique identifier of the account.To request the creation of a report for all accounts, don't send this parameter. Otherwise indicate all the account_id you want to include (MAX 64; MIN 36).", "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Limit of reports to retrieve. Default 1 and maximum 99 (MAX 2; MIN 1).", "schema": { "type": "integer", "format": "int32" } }, { "name": "page_number", "in": "query", "required": false, "description": "Reports start page. Default 1 and maximum 10 (MAX 2; MIN 1).", "schema": { "type": "integer", "format": "int32", "default": "" } }, { "name": "start_date", "in": "query", "description": "Reports created after and equal this date (ISO 8601 MAX 27; MIN 27).", "schema": { "type": "string", "format": "date-time" } }, { "name": "end_date", "in": "query", "description": "Reports created before and equal this date (ISO 8601 MAX 27; MIN 27).", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": [ { "id": "5104911d-5df9-229e-8468-bd41abea1", "type": "TRANSACTIONS", "start_date": "2022-05-09T20:46:54.786342Z", "end_date": "2022-05-09T20:46:54.786342Z", "merchant_reference_id": "Merchant_report_1234", "created_at": "2022-05-16T20:46:54.786342Z", "updated_at": "2022-05-16T20:46:54.786342Z", "expires_at": "2022-05-16T20:46:54.786342Z", "status": "SUCCEEDED" }, { "id": "5104911d-5df9-229e-8468-bd41abea1", "type": "SETTLEMENTS", "start_date": "2022-05-09T20:46:54.786342Z", "end_date": "2022-05-09T20:46:54.786342Z", "merchant_reference_id": "Merchant_report_1234", "created_at": "2022-05-16T20:46:54.786342Z", "updated_at": "2022-05-16T20:46:54.786342Z", "expires_at": "2022-05-16T20:46:54.786342Z", "status": "DOWNLOADED" } ] } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "5104911d-5df9-229e-8468-bd41abea1" }, "type": { "type": "string", "example": "TRANSACTIONS" }, "start_date": { "type": "string", "example": "2022-05-09T20:46:54.786342Z" }, "end_date": { "type": "string", "example": "2022-05-09T20:46:54.786342Z" }, "merchant_reference_id": { "type": "string", "example": "Merchant_report_1234" }, "created_at": { "type": "string", "example": "2022-05-16T20:46:54.786342Z" }, "updated_at": { "type": "string", "example": "2022-05-16T20:46:54.786342Z" }, "expires_at": { "type": "string", "example": "2022-05-16T20:46:54.786342Z" }, "status": { "type": "string", "example": "SUCCEEDED" } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Reports" ] } }, "/reports/{report_id}": { "get": { "summary": "Retrieve a Report", "description": "", "operationId": "retrieve-a-report", "parameters": [ { "name": "X-Organization-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Organization code associated to the request." }, { "name": "report_id", "in": "path", "description": "The unique identifier of the report.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "5104911d-5df9-229e-8468-bd41abea1", "type": "TRANSACTIONS", "start_date": "2022-05-09T20:46:54.786342Z", "end_date": "2022-05-09T20:46:54.786342Z", "merchant_reference_id": "Merchant_report_1234", "created_at": "2022-05-16T20:46:54.786342Z", "updated_at": "2022-05-16T20:46:54.786342Z", "expires_at": "2022-05-16T20:46:54.786342Z", "status": "SUCCEEDED" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "5104911d-5df9-229e-8468-bd41abea1" }, "type": { "type": "string", "example": "TRANSACTIONS" }, "start_date": { "type": "string", "example": "2022-05-09T20:46:54.786342Z" }, "end_date": { "type": "string", "example": "2022-05-09T20:46:54.786342Z" }, "merchant_reference_id": { "type": "string", "example": "Merchant_report_1234" }, "created_at": { "type": "string", "example": "2022-05-16T20:46:54.786342Z" }, "updated_at": { "type": "string", "example": "2022-05-16T20:46:54.786342Z" }, "expires_at": { "type": "string", "example": "2022-05-16T20:46:54.786342Z" }, "status": { "type": "string", "example": "SUCCEEDED" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": "" } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Reports" ] } }, "/reports/{report_id}/download": { "get": { "summary": "Download a Report", "description": "", "operationId": "download-a-report", "parameters": [ { "name": "X-Organization-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Organization code associated to the request." }, { "name": "report_id", "in": "path", "required": true, "description": "The report unique identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "type": "TRANSACTIONS", "download_link": "https://s3.amazonaws.com/.../report.csv", "status": "AVAILABLE" } } }, "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "TRANSACTIONS" }, "download_link": { "type": "string", "example": "https://s3.amazonaws.com/.../report.csv" }, "status": { "type": "string", "example": "AVAILABLE" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Bad Request": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid credentials" ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid credentials" } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "AUTHORIZATION_REQUIRED", "messages": [ "The merchant has no authorization to use this API." ] } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "AUTHORIZATION_REQUIRED" }, "messages": { "type": "array", "items": { "type": "string", "example": "The merchant has no authorization to use this API." } } } } } } } }, "deprecated": false, "tags": [ "Reports" ], "servers": [ { "url": "https://api-sandbox.y.uno/v2" }, { "url": "https://api.eu.y.uno/v2" } ] } }, "/routing": { "get": { "summary": "List Routings", "operationId": "list-routings", "description": "Lists all routings of an account, optionally filtered by payment method. Each item has the same shape as Retrieve a Routing.", "parameters": [ { "name": "account_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Account to list routings for. Must belong to the organization of your API credentials." }, { "name": "payment_method", "in": "query", "required": false, "schema": { "type": "string", "example": "CARD" }, "description": "Filter by payment method (e.g., CARD, PIX)." } ], "responses": { "200": { "description": "The routings configured on the account, or an empty array if it has none.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "r_8f2c1d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f" }, "account_id": { "type": "string", "example": "acc-uuid" }, "payment_method": { "type": "string", "example": "CARD" }, "name": { "type": "string", "example": "Card routing — Stripe primary, Adyen fallback" }, "default_route": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "example": 1 }, "provider_id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "example": "f1a3c4d5-..." } } } } } }, "condition_sets": { "type": "array", "items": { "type": "object", "properties": { "sort_number": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "High Value US" }, "conditions": { "type": "array", "items": { "type": "object" } }, "route": { "type": "object" } } } }, "created_at": { "type": "string", "format": "date-time", "example": "2026-05-12T14:30:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-05-12T14:30:00Z" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "invalid_request" }, "code": { "type": "string", "example": "ROUTING_VALIDATION_FAILED" }, "message": { "type": "string", "example": "account_id is required." } } } } } } }, "tags": [ "Organizations" ] }, "post": { "summary": "Create a Routing", "operationId": "create-routing", "description": "Creates a routing for one (account_id, payment_method) pair.", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "payment_method", "name", "default_route" ], "properties": { "account_id": { "type": "string", "format": "uuid", "example": "7825fc5e-e50a-4248-9ae8-5d3786afb0be" }, "payment_method": { "type": "string", "example": "CARD" }, "name": { "type": "string", "example": "Card routing" }, "default_route": { "type": "object", "required": [ "steps" ], "properties": { "steps": { "type": "array", "items": { "type": "object", "required": [ "index", "provider_id", "connection_id" ], "properties": { "index": { "type": "integer", "example": 1 }, "provider_id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "format": "uuid", "example": "f1a3c4d5-7b8e-4a2c-9d1e-3f4a5b6c7d8e" } } } } } } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "r_8f2c1d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f" }, "account_id": { "type": "string", "example": "acc-uuid" }, "payment_method": { "type": "string", "example": "CARD" }, "name": { "type": "string", "example": "Card routing" }, "default_route": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "example": 1 }, "provider_id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "example": "f1a3c4d5-..." } } } } } }, "condition_sets": { "type": "array", "items": { "type": "object", "properties": { "sort_number": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "High Value US" }, "conditions": { "type": "array", "items": { "type": "object" } }, "route": { "type": "object" } } } }, "created_at": { "type": "string", "format": "date-time", "example": "2026-05-12T14:30:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-05-12T14:30:00Z" }, "warnings": { "type": "array", "items": { "type": "string" }, "example": [ "MONITOR_REDISTRIBUTION_DEFERRED" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation_error" }, "code": { "type": "string", "example": "ROUTING_VALIDATION_FAILED" }, "message": { "type": "string", "example": "Steps must be contiguous" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "conflict" }, "code": { "type": "string", "example": "ROUTING_ALREADY_EXISTS" }, "message": { "type": "string", "example": "A routing already exists for this payment method" } } } } } } }, "tags": [ "Organizations" ] } }, "/routing/recommendations": { "post": { "summary": "Get a Routing Recommendation", "operationId": "get-routing-recommendations", "description": "Ranks the candidate providers using the account's own reported off-Yuno payment history and returns the recommended candidate plus the full ranking. Enabled per organization.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "payment", "candidates" ], "properties": { "account_id": { "type": "string", "format": "uuid", "example": "7825fc5e-e50a-4248-9ae8-5d3786afb0be" }, "merchant_order_id": { "type": "string", "maxLength": 255, "example": "order_45678" }, "payment": { "type": "object", "required": [ "amount", "country", "payment_method" ], "properties": { "amount": { "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "example": "USD", "description": "ISO 4217 currency code." }, "value": { "type": "number", "minimum": 0, "example": 99 } } }, "country": { "type": "string", "example": "US", "description": "ISO 3166-1 alpha-2 country code." }, "payment_method": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "example": "CARD" }, "details": { "type": "object", "properties": { "card": { "type": "object", "properties": { "bin": { "type": "string", "example": "457173" } } } } } } }, "initiation": { "type": "string", "enum": [ "CIT", "MIT" ], "example": "CIT" } } }, "candidates": { "type": "array", "minItems": 2, "maxItems": 20, "items": { "type": "object", "required": [ "provider_id" ], "properties": { "provider_id": { "type": "string", "example": "ADYEN" }, "merchant_connection_id": { "type": "string", "example": "acct-adyen-us-1" } } } }, "optimize_for": { "type": "string", "enum": [ "APPROVAL_RATE", "LATENCY", "BALANCED" ], "default": "APPROVAL_RATE", "example": "APPROVAL_RATE" } } }, "example": { "account_id": "7825fc5e-e50a-4248-9ae8-5d3786afb0be", "merchant_order_id": "order_45678", "payment": { "amount": { "currency": "USD", "value": 99 }, "country": "US", "payment_method": { "type": "CARD" } }, "candidates": [ { "provider_id": "ADYEN", "merchant_connection_id": "acct-adyen-us-1" }, { "provider_id": "STRIPE" }, { "provider_id": "DLOCAL" } ], "optimize_for": "APPROVAL_RATE" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "recommendation_id": { "type": "string", "format": "uuid", "example": "3e37f0c9-e9cd-4d85-9e1a-ec5f09af296d" }, "merchant_order_id": { "type": [ "string", "null" ], "example": "order_45678" }, "optimized_for": { "type": "string", "enum": [ "APPROVAL_RATE", "LATENCY", "BALANCED" ], "example": "APPROVAL_RATE" }, "decision_source": { "type": "string", "enum": [ "MERCHANT_HISTORY", "INSUFFICIENT_DATA" ], "example": "MERCHANT_HISTORY" }, "recommended": { "type": "object", "properties": { "provider_id": { "type": "string", "example": "ADYEN" }, "merchant_connection_id": { "type": [ "string", "null" ], "example": "acct-adyen-us-1" } } }, "ranking": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "example": "ADYEN" }, "merchant_connection_id": { "type": [ "string", "null" ], "example": "acct-adyen-us-1" }, "approval_rate": { "type": [ "number", "null" ], "example": 0.9987 }, "avg_latency_ms": { "type": [ "integer", "null" ], "example": 180 }, "sample_size": { "type": "integer", "example": 767 } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_PARAMETERS" }, "messages": { "type": "array", "items": { "type": "string" }, "example": [ "The field 'candidates' has a value less than allowed." ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_CREDENTIALS" }, "messages": { "type": "array", "items": { "type": "string" }, "example": [ "Invalid Credentials" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "PRODUCT_NOT_ENABLED" }, "messages": { "type": "array", "items": { "type": "string" }, "example": [ "The Routing Recommendations API is enabled per organization. Contact your Key Account Manager (KAM) to activate it." ] } } } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "ROUTING_UPSTREAM_ERROR" }, "messages": { "type": "array", "items": { "type": "string" }, "example": [ "routing service unavailable." ] } } } } } } }, "tags": [ "Organizations" ] } }, "/routing/{routing_id}": { "get": { "summary": "Retrieve a Routing", "operationId": "retrieve-routing", "description": "Returns the routing's current live configuration.", "parameters": [ { "name": "routing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "r_8f2c1d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f" }, "account_id": { "type": "string", "example": "acc-uuid" }, "payment_method": { "type": "string", "example": "CARD" }, "name": { "type": "string", "example": "Card routing — Stripe primary, Adyen fallback" }, "default_route": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "example": 1 }, "provider_id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "example": "f1a3c4d5-..." } } } } } }, "condition_sets": { "type": "array", "items": { "type": "object", "properties": { "sort_number": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "High Value US" }, "conditions": { "type": "array", "items": { "type": "object" } }, "route": { "type": "object" } } } }, "created_at": { "type": "string", "format": "date-time", "example": "2026-05-12T14:30:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-05-12T14:30:00Z" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "code": { "type": "string", "example": "ROUTING_NOT_FOUND" }, "message": { "type": "string", "example": "Routing '...' was not found" } } } } } } }, "tags": [ "Organizations" ] }, "patch": { "summary": "Update a Routing", "operationId": "update-routing", "description": "Replaces the routing's full configuration.", "parameters": [ { "name": "routing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "r_8f2c1d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f" }, "account_id": { "type": "string", "example": "acc-uuid" }, "payment_method": { "type": "string", "example": "CARD" }, "name": { "type": "string", "example": "Updated Card routing v2" }, "default_route": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "example": 1 }, "provider_id": { "type": "string", "example": "STRIPE" }, "connection_id": { "type": "string", "example": "f1a3c4d5-..." } } } } } }, "condition_sets": { "type": "array", "items": { "type": "object", "properties": { "sort_number": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Updated Card routing" }, "conditions": { "type": "array", "items": { "type": "object" } }, "route": { "type": "object" } } } }, "created_at": { "type": "string", "format": "date-time", "example": "2026-05-12T14:30:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-05-12T14:30:00Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation_error" }, "code": { "type": "string", "example": "ROUTING_VALIDATION_FAILED" }, "message": { "type": "string", "example": "Validation failed for update" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "code": { "type": "string", "example": "ROUTING_NOT_FOUND" }, "message": { "type": "string", "example": "Routing '...' was not found" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "conflict" }, "code": { "type": "string", "example": "ROUTING_VERSION_CONFLICT" }, "message": { "type": "string", "example": "Another concurrent PATCH won the publish race" } } } } } } }, "tags": [ "Organizations" ] } }, "/sellers": { "post": { "summary": "Create Seller", "operationId": "create-seller", "tags": [ "Sellers" ], "description": "Creates a new franchise seller mapping.", "parameters": [ { "name": "public-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "private-secret-key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellerCreate" }, "examples": { "CardProvider": { "summary": "Seller with card provider", "value": { "account_id": "8a1c0e7f-4f2d-4bc7-9e1a-2c4d6f8a1b22", "merchant_seller_id": "FRANCHISE_STORE_001", "name": "Franchise Store New York", "email": "store001@franchise.com", "phone": { "code": "+1", "number": "2125550100" }, "document": { "type": "EIN", "number": "12-3456789" }, "address": { "line_1": "350 Fifth Avenue", "line_2": "Suite 101", "city": "New York", "state": "NY", "country": "US", "zip_code": "10118" }, "country": "US", "merchant_category_code": "5812", "payment_methods": [ { "provider_id": "STRIPE", "payment_method_type": "CARD", "merchant_id": "acct_1A2B3C4D5E" } ] } }, "MultipleProviders": { "summary": "Seller with multiple providers (card + wallet)", "value": { "account_id": "8a1c0e7f-4f2d-4bc7-9e1a-2c4d6f8a1b22", "merchant_seller_id": "FRANCHISE_STORE_001", "name": "Franchise Store Los Angeles", "country": "US", "merchant_category_code": "5812", "payment_methods": [ { "provider_id": "STRIPE", "payment_method_type": "CARD", "merchant_id": "acct_1A2B3C4D5E" }, { "provider_id": "APPLE_PAY", "payment_method_type": "APPLE_PAY", "wallet_details": { "payment_processing_key": "", "payment_processing_certificate": "", "merchant_identity_key": "", "merchant_identity_certificate": "", "merchant_identity_password": "password123" } } ] } }, "MinimalSeller": { "summary": "Minimal seller (no payment methods yet)", "value": { "account_id": "8a1c0e7f-4f2d-4bc7-9e1a-2c4d6f8a1b22", "merchant_seller_id": "FRANCHISE_STORE_002", "name": "Franchise Store Chicago" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "examples": { "CardProvider": { "summary": "Seller created with card provider", "value": { "seller_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "merchant_seller_id": "FRANCHISE_STORE_001", "name": "Franchise Store New York", "email": "store001@franchise.com", "phone": { "code": "+1", "number": "2125550100" }, "document": { "type": "EIN", "number": "12-3456789" }, "address": { "line_1": "350 Fifth Avenue", "line_2": "Suite 101", "city": "New York", "state": "NY", "country": "US", "zip_code": "10118" }, "country": "US", "website": null, "industry": null, "merchant_category_code": "5812", "payment_methods": [ { "provider_id": "STRIPE", "payment_method_type": "CARD", "merchant_id": "acct_1A2B3C4D5E", "wallet_details": null } ], "created_at": "2026-05-07T10:00:00Z", "updated_at": "2026-05-07T10:00:00Z" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized_2" }, "409": { "$ref": "#/components/responses/Conflict" } } } }, "/sellers/{merchant_seller_id}": { "get": { "summary": "Get Seller", "operationId": "get-seller", "tags": [ "Sellers" ], "description": "Retrieves a franchise seller mapping by the merchant's own identifier.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "examples": { "CardProvider": { "summary": "Seller with card provider", "value": { "seller_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "merchant_seller_id": "FRANCHISE_STORE_001", "name": "Franchise Store New York", "email": "store001@franchise.com", "phone": { "code": "+1", "number": "2125550100" }, "document": { "type": "EIN", "number": "12-3456789" }, "address": { "line_1": "350 Fifth Avenue", "line_2": "Suite 101", "city": "New York", "state": "NY", "country": "US", "zip_code": "10118" }, "country": "US", "website": null, "industry": null, "merchant_category_code": "5812", "payment_methods": [ { "provider_id": "STRIPE", "payment_method_type": "CARD", "merchant_id": "acct_1A2B3C4D5E", "wallet_details": null } ], "created_at": "2026-05-07T10:00:00Z", "updated_at": "2026-05-07T10:00:00Z" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized_2" }, "404": { "$ref": "#/components/responses/NotFound" } }, "parameters": [ { "name": "merchant_seller_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "public-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "private-secret-key", "in": "header", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "Update Seller", "operationId": "update-seller", "tags": [ "Sellers" ], "description": "Fully replaces the seller details and payment method configurations. `merchant_seller_id` is taken from the URL path; `account_id` must be provided in the request body.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellerUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "examples": { "MultipleProviders": { "summary": "Updated seller with multiple providers", "value": { "seller_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "merchant_seller_id": "FRANCHISE_STORE_001", "name": "Franchise Store Los Angeles", "email": null, "phone": { "code": null, "number": null }, "document": { "type": null, "number": null }, "address": { "line_1": null, "line_2": null, "city": null, "state": null, "country": null, "zip_code": null }, "country": "US", "website": null, "industry": null, "merchant_category_code": "5812", "payment_methods": [ { "provider_id": "STRIPE", "payment_method_type": "CARD", "merchant_id": "acct_1A2B3C4D5E", "wallet_details": null }, { "provider_id": "APPLE_PAY", "payment_method_type": "APPLE_PAY", "merchant_id": null, "wallet_details": { "payment_processing_key": "", "payment_processing_certificate": "", "merchant_identity_key": "", "merchant_identity_certificate": "", "merchant_identity_password": "password123" } } ], "created_at": "2026-05-07T10:00:00Z", "updated_at": "2026-05-07T14:30:00Z" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized_2" }, "404": { "$ref": "#/components/responses/NotFound" } }, "parameters": [ { "name": "merchant_seller_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "public-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "private-secret-key", "in": "header", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "Delete Seller", "operationId": "delete-seller", "tags": [ "Sellers" ], "description": "Soft-deletes a franchise seller mapping.", "responses": { "204": { "description": "No Content" }, "401": { "$ref": "#/components/responses/Unauthorized_2" }, "404": { "$ref": "#/components/responses/NotFound" } }, "parameters": [ { "name": "merchant_seller_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "public-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "private-secret-key", "in": "header", "required": true, "schema": { "type": "string" } } ] } }, "/smart-support/external/payments": { "post": { "summary": "Initiate Recovery Outreach for Abandoned User Flows", "operationId": "initiate-recovery-outreach-for-abandoned-user-flows", "tags": [ "AI Caller" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoveryOutreachRequest" }, "examples": { "recoveryOutreachExample": { "summary": "Example Recovery Outreach Request (USA)", "value": { "customer": { "full_name": "Robert Johnson", "phone_number": "+12125550103", "email": "robert.johnson@example.com", "country_code": "US", "language": "en" }, "session": { "abandonment_timestamp": "2025-05-13T22:45:00Z", "flow_stage": "cart_review", "platform": "ios", "session_id": "sess_def456uvw" }, "cart": { "total_value": 29.99, "currency": "USD", "items": [ { "name": "Bluetooth Speaker", "sku": "BSPEAKER-PRO", "quantity": 1, "price": 29.99 } ] }, "engagement": { "preferred_channel": "whatsapp", "reason": "user_abandoned_cart", "metadata": { "utm_campaign": "summer_promo", "last_clicked_button": "Continue Shopping" } } } } } } } }, "responses": { "200": { "description": "Successfully initiated recovery outreach." }, "400": { "description": "Invalid request payload or validation error." }, "401": { "description": "Unauthorized - missing or invalid API key." }, "500": { "description": "Internal server error." } } } }, "/smart-support/external/payments/recover": { "post": { "summary": "Copy of Declined Payment Calls", "tags": [ "AI Caller" ], "operationId": "declined-payment-calls-1", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "settings" ], "properties": { "settings": { "type": "object", "description": "AI agent configuration", "required": [ "contact_details" ], "properties": { "contact_details": { "type": "object", "description": "Object with the contact details", "required": [ "channel" ], "properties": { "channel": { "type": "string", "enum": [ "PHONE_CALL", "WHATSAPP_MESSAGE" ], "description": "The list of possible contact channels.\n\n", "example": "WHATSAPP_MESSAGE" }, "initial_template_message": { "type": "object", "description": "Required if `channel = WHATSAPP_MESSAGE`. Initial template message configuration for `WHATSAPP_MESSAGE`.", "properties": { "id": { "type": "string", "description": "Yuno template ID", "example": "HX8e7ac569f40a064c71a37e5d672bb9123" }, "variables": { "type": "object", "description": "Object with template's variables", "example": { "name": "Maria", "amount": "$10.0000" } } } }, "pdf_template": { "type": "object", "properties": { "id": { "type": "string", "description": "Yuno PDF template ID" }, "variables": { "type": "object", "description": "Object with pdf template's variables", "example": { "seller_name": "RAPPI", "merchant_order_id": "MX_Verification_50708779" } } }, "description": "PDF template configuration for WHATSAPP_MESSAGE." }, "payment_methods": { "type": "object", "description": "Available payment methods to offer the customer payer", "properties": { "available": { "type": "array", "description": "The list of available payment methods to be offered to the user as alternatives to complete the payment.", "items": { "type": "string" }, "example": [ "MERCADO_PAGO", "NEQUI", "CREDIT_CARD" ] } }, "required": [ "available" ] } } } } }, "additional_information": { "type": "object", "description": "All relevant information to feed to the AI to improve context.", "properties": { "seller_details": { "type": "object", "description": "Object containing the merchant's contact information to be used if the agent is unable to answer the inquiry.", "properties": { "name": { "type": "string", "description": "The merchant's name, used by the AI to introduce itself.", "minLength": 3, "maxLength": 255, "example": "RAPPI" }, "fallback_instructions": { "type": "string", "description": "Instruction to be provided to the user on how to contact customer support in case the AI cannot solve the issue.", "minLength": 3, "maxLength": 255, "example": "Go to the application and click on the top right corner to contact a customer support agent." }, "redirection_url": { "type": "string", "description": "URL to redirect the customer for additional support.", "example": "www.test.com/purchase" } } }, "payment": { "type": "object", "description": "Declined payment information", "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account.", "minLength": 36, "maxLength": 64, "example": "e4c03f29-b0f6-403a-8814-9aee1a88d60e" }, "id": { "type": "string", "description": "The unique identifier of the payment.", "minLength": 3, "maxLength": 64, "example": "f1fbad16-93c1-4335-b735-2b01ec94ea9e" }, "merchant_order_id": { "type": "string", "description": "Identification of the Order.", "minLength": 3, "maxLength": 255, "example": "ORDER-12345" }, "country": { "type": "string", "description": "Country where the payment was processed (ISO 3166-1).", "minLength": 2, "maxLength": 2, "example": "US" }, "description": { "type": "string", "description": "The description of product or service the user tried to purchase.", "minLength": 3, "maxLength": 1000, "example": "Online store purchase" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp of when the payment was made (ISO 8601).", "minLength": 27, "maxLength": 27, "example": "2022-05-09T20:46:54.786342Z" }, "declined_reason": { "type": "string", "description": "The declined reason for the payment provided by the payment provider.", "minLength": 3, "maxLength": 255, "example": "insufficient funds" }, "payment_method": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of payment method selected by the customer.", "minLength": 3, "maxLength": 255, "example": "Credit Card" }, "detail": { "type": "object", "properties": { "card_data": { "type": "object", "properties": { "expiration_month": { "type": "number", "description": "Card's expiration month - MM", "minimum": 1, "maximum": 12, "example": 12 }, "expiration_year": { "type": "number", "description": "Card's expiration year - YYYY", "minimum": 2024, "maximum": 9999, "example": 2030 }, "iin": { "type": "string", "description": "The Institution identification number (IIN) refers to the first few digits of a payment card number issued by a financial institution.", "minLength": 6, "maxLength": 8, "example": "411111" }, "lfd": { "type": "string", "description": "Last four digits of the card.", "minLength": 4, "maxLength": 4, "example": "1234" }, "issuer": { "type": "string", "description": "Card issuer.", "minLength": 3, "maxLength": 255, "example": "CHASE" }, "type": { "type": "string", "description": "Card's issuer type.", "enum": [ "CREDIT", "DEBIT", "PREPAID" ], "minLength": 3, "maxLength": 255, "example": "CREDIT" } } } } } } }, "amount": { "type": "object", "properties": { "value": { "type": "number", "description": "The amount of the payment that was declined.", "example": 149.99 }, "currency": { "type": "string", "description": "The currency of the payment that was declined (ISO 4217).", "minLength": 3, "maxLength": 3, "example": "USD" } } }, "customer_payer": { "type": "object", "properties": { "first_name": { "type": "string", "description": "The customer's first name.", "minLength": 3, "maxLength": 255, "example": "John" }, "last_name": { "type": "string", "description": "The customer's last name.", "minLength": 3, "maxLength": 255, "example": "Doe" }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Customer payer cell phone area code.", "minLength": 2, "maxLength": 3, "example": "1" }, "number": { "type": "string", "description": "Customer payer cell phone number.", "minLength": 1, "maxLength": 32, "example": "5551234567" } } } } } } } } } } }, "examples": { "Request Example": { "summary": "Request Example", "value": { "settings": { "contact_details": { "channel": "PHONE_CALL", "initial_template_message": { "id": "HX8e7ac569f40a064c71a37e5d672bb9123", "variables": { "name": "Maria", "amount": "$10.0000" } }, "pdf_template": { "id": "ede0d2da-138d-441b-8101-85e2d21af8b9", "variables": { "seller_name": "RAPPI", "merchant_order_id": "MX_Verification_50708779" } }, "payment_methods": { "available": [ "MERCADO_PAGO", "NEQUI" ] } } }, "additional_information": { "seller_details": { "name": "RAPPI", "fallback_instructions": "Go to the application and click on the top right corner to contact a customer support agent.", "redirection_url": "www.test.com/purchase" }, "payment": { "account_id": "e4c03f29-b0f6-403a-8814-9aee1a88d60e", "id": "f1fbad16-93c1-4335-b735-2b01ec94ea9e", "merchant_order_id": "MX_Verification_50708779", "country": "CO", "description": "Purchase in McDonalds", "created_at": "2022-05-09T20:46:54.786342Z", "declined_reason": "insufficient funds", "payment_method": { "type": "Credit Card", "detail": { "card_data": { "iin": "636318", "lfd": "2671", "type": "CREDIT", "issuer": "SCOTIABANK", "expiration_year": 2030, "expiration_month": 12 } } }, "amount": { "currency": "COP", "value": 27000 }, "customer_payer": { "first_name": "Pepito", "last_name": "Perez", "phone": { "country_code": "57", "number": "3132450765" } } } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "7c3a9c6e-9bf0-4c2c-9f67-752b16ba5dd5" }, "message": { "type": "string", "example": "Communication processed successfully" } } }, "examples": { "Success": { "value": { "id": "7c3a9c6e-9bf0-4c2c-9f67-752b16ba5dd5", "message": "Communication processed successfully" }, "summary": "Success" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Missing customer_payer.first_name required field" } } }, "examples": { "Bad Request": { "value": { "message": "Missing customer_payer.first_name required field" }, "summary": "Bad Request" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Internal error" } } }, "examples": { "Internal Error": { "value": { "message": "Internal error" }, "summary": "Internal Error" } } } } } } } }, "/split-marketplace/transfers": { "post": { "summary": "Create Standalone Transfer", "operationId": "create-standalone-transfer", "tags": [ "Transfers" ], "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Unique key for request idempotency." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "recipient_id", "provider_id", "amount" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account." }, "recipient_id": { "type": "string", "format": "uuid", "description": "The target recipient identifier." }, "provider_id": { "type": "string", "description": "The payment provider code to use (e.g., adyen, stripe)." }, "amount": { "$ref": "#/components/schemas/Amount" }, "description": { "type": "string", "description": "A human-readable description for the transfer (3-255 chars). This is sent to the provider." }, "merchant_reference": { "type": "string", "description": "Merchant's unique identifier for idempotency and tracking." }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfer" }, "examples": { "Success": { "value": { "id": "94036ceb-5cca-4384-b144-e2a5a908af77", "recipient_id": "e56c3329-f3d9-48e5-a677-284b147abf95", "amount": { "currency": "USD", "value": 100 }, "status": "SUCCEEDED", "description": "test transfer", "merchant_reference": "c19e858a-ffd6-4635-8a31-4f60c5becf4d", "metadata": [], "provider": null, "transactions": [ { "code": "7ac2c5f3-7c79-4e99-b45e-aa5952620188", "type": "SPLIT_TRANSFER", "status": "SUCCEEDED", "provider_transfer_id": "tr_1T9eKVIiMnPsFcbbRTb8ObsZ", "provider_response_message": null, "provider_raw_response": "{\n \"id\": \"tr_1T9eKVIiMnPsFcbbRTb8ObsZ\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9eKVIiMnPsFcbbOPnvz3xM\",\n \"created\": 1773203107,\n \"currency\": \"usd\",\n \"description\": \"test transfer\",\n \"destination\": \"acct_1T9PSQIZEg1WWTvj\",\n \"destination_payment\": \"py_1T9eKVIZEg1WWTvjbVjmnzFK\",\n \"livemode\": false,\n \"metadata\": {},\n \"reversals\": {\n \"object\": \"list\",\n \"data\": [],\n \"has_more\": false,\n \"total_count\": 0,\n \"url\": \"/v1/transfers/tr_1T9eKVIiMnPsFcbbRTb8ObsZ/reversals\"\n },\n \"reversed\": false,\n \"source_transaction\": null,\n \"source_type\": \"card\",\n \"transfer_group\": null\n}", "created_at": "2026-03-11T04:25:06.229027Z", "updated_at": "2026-03-11T04:25:07.917364Z" } ], "created_at": "2026-03-11T04:25:06.208761Z", "updated_at": "2026-03-11T04:25:07.928000342Z", "completed_at": "2026-03-11T04:25:07.927971142Z" } }, "Error": { "value": { "id": "9778f631-504d-448f-b2c1-f7b903781df7", "recipient_id": "82b12c8c-7d3d-4a21-a3c6-165cc04ca741", "amount": { "currency": "USD", "value": 50000 }, "status": "ERROR", "description": "test transfer", "merchant_reference": "cb18df20-21ae-4fed-8da9-fb81cfd56797", "metadata": [], "provider": null, "transactions": [ { "code": "9eee65d1-6c3a-4076-9ef9-fa4bff73d597", "type": "SPLIT_TRANSFER", "status": "ERROR", "provider_transfer_id": "tr_1T9PTLIiMnPsFcbbFKyh1Nds", "provider_response_message": "{\n \"id\": \"tr_1T9PTLIiMnPsFcbbFKyh1Nds\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9PTMIiMnPsFcbbxRKvaZ3G\",\n \"created\": 1773145996,\n \"currency\": \"usd\",\n \"description\": \"test transfer\"\n}", "provider_raw_response": "{.... }", "created_at": "2026-03-10T13:39:19.342902Z", "updated_at": "2026-03-10T13:39:19.342914Z" } ], "created_at": "2026-03-10T13:39:19.241990247Z", "updated_at": "2026-03-10T13:39:19.242012664Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "PROVIDER_NOT_FOUND": { "summary": "Provider not found", "value": { "code": "PROVIDER_NOT_FOUND", "messages": [ "The specified provider was not found." ] } }, "ONBOARDING_NOT_VALID": { "summary": "Onboarding not valid", "value": { "code": "ONBOARDING_NOT_VALID", "messages": [ "The recipient onboarding is not valid for this operation." ] } }, "CURRENCY_NOT_SUPPORTED": { "summary": "Currency not supported", "value": { "code": "CURRENCY_NOT_SUPPORTED", "messages": [ "The specified currency is not supported." ] } }, "INVALID_AMOUNT": { "summary": "Invalid amount", "value": { "code": "INVALID_AMOUNT", "messages": [ "The transfer amount is invalid." ] } }, "INSUFFICIENT_BALANCE": { "summary": "Insufficient balance", "value": { "code": "INSUFFICIENT_BALANCE", "messages": [ "Insufficient balance to complete the transfer." ] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "RECIPIENT_NOT_FOUND": { "summary": "Recipient not found", "value": { "code": "RECIPIENT_NOT_FOUND", "messages": [ "The specified recipient was not found." ] } } } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "PROVIDER_INTERNAL_ERROR": { "summary": "Provider internal error", "value": { "code": "PROVIDER_INTERNAL_ERROR", "messages": [ "The payment provider encountered an internal error." ] } } } } } } } } }, "/split-marketplace/transfers/{transfer_id}": { "get": { "summary": "Get Standalone Transfer", "operationId": "get-standalone-transfer", "tags": [ "Transfers" ], "parameters": [ { "name": "transfer_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique ID of the transfer (e.g., TRF_7kB2mQ9xPnL4vR)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfer" }, "examples": { "Success": { "value": { "id": "94036ceb-5cca-4384-b144-e2a5a908af77", "recipient_id": "e56c3329-f3d9-48e5-a677-284b147abf95", "amount": { "currency": "USD", "value": 100 }, "status": "SUCCEEDED", "description": "test transfer", "merchant_reference": "c19e858a-ffd6-4635-8a31-4f60c5becf4d", "metadata": [], "provider": null, "transactions": [ { "code": "7ac2c5f3-7c79-4e99-b45e-aa5952620188", "type": "SPLIT_TRANSFER", "status": "SUCCEEDED", "provider_transfer_id": "tr_1T9eKVIiMnPsFcbbRTb8ObsZ", "provider_response_message": null, "provider_raw_response": "{\n \"id\": \"tr_1T9eKVIiMnPsFcbbRTb8ObsZ\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9eKVIiMnPsFcbbOPnvz3xM\",\n \"created\": 1773203107,\n \"currency\": \"usd\",\n \"description\": \"test transfer\",\n \"destination\": \"acct_1T9PSQIZEg1WWTvj\",\n \"destination_payment\": \"py_1T9eKVIZEg1WWTvjbVjmnzFK\",\n \"livemode\": false,\n \"metadata\": {},\n \"reversals\": {\n \"object\": \"list\",\n \"data\": [],\n \"has_more\": false,\n \"total_count\": 0,\n \"url\": \"/v1/transfers/tr_1T9eKVIiMnPsFcbbRTb8ObsZ/reversals\"\n },\n \"reversed\": false,\n \"source_transaction\": null,\n \"source_type\": \"card\",\n \"transfer_group\": null\n}", "created_at": "2026-03-11T04:25:06.229027Z", "updated_at": "2026-03-11T04:25:07.917364Z" } ], "created_at": "2026-03-11T04:25:06.208761Z", "updated_at": "2026-03-11T04:25:07.928000342Z", "completed_at": "2026-03-11T04:25:07.927971142Z" } }, "Error": { "value": { "id": "9778f631-504d-448f-b2c1-f7b903781df7", "recipient_id": "82b12c8c-7d3d-4a21-a3c6-165cc04ca741", "amount": { "currency": "USD", "value": 50000 }, "status": "ERROR", "description": "test transfer", "merchant_reference": "cb18df20-21ae-4fed-8da9-fb81cfd56797", "metadata": [], "provider": null, "transactions": [ { "code": "9eee65d1-6c3a-4076-9ef9-fa4bff73d597", "type": "SPLIT_TRANSFER", "status": "ERROR", "provider_transfer_id": "tr_1T9PTLIiMnPsFcbbFKyh1Nds", "provider_response_message": "{\n \"id\": \"tr_1T9PTLIiMnPsFcbbFKyh1Nds\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9PTMIiMnPsFcbbxRKvaZ3G\",\n \"created\": 1773145996,\n \"currency\": \"usd\",\n \"description\": \"test transfer\"\n}", "provider_raw_response": "{.... }", "created_at": "2026-03-10T13:39:19.342902Z", "updated_at": "2026-03-10T13:39:19.342914Z" } ], "created_at": "2026-03-10T13:39:19.241990247Z", "updated_at": "2026-03-10T13:39:19.242012664Z" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "TRANSFER_NOT_FOUND": { "summary": "Transfer not found", "value": { "code": "TRANSFER_NOT_FOUND", "messages": [ "The specified transfer was not found." ] } } } } } } } } }, "/split-marketplace/transfers/{transfer_id}/reverse": { "post": { "summary": "Reverse Standalone Transfer", "operationId": "reverse-standalone-transfer", "tags": [ "Transfers" ], "parameters": [ { "name": "transfer_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique ID of the transfer flow to reverse." }, { "name": "X-Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Unique key for request idempotency." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id" ], "properties": { "account_id": { "type": "string", "description": "The unique identifier of the account." }, "amount": { "$ref": "#/components/schemas/Amount" }, "reason": { "type": "string", "description": "The reason for the reversal." }, "description": { "type": "string", "description": "A human-readable description for the reversal." }, "merchant_reference": { "type": "string", "description": "Merchant's unique identifier for tracking this reversal." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfer" }, "examples": { "Success": { "value": { "id": "94036ceb-5cca-4384-b144-e2a5a908af77", "recipient_id": "e56c3329-f3d9-48e5-a677-284b147abf95", "amount": { "currency": "USD", "value": 100 }, "status": "SUCCEEDED", "description": "test transfer", "merchant_reference": "c19e858a-ffd6-4635-8a31-4f60c5becf4d", "metadata": [], "provider": null, "transactions": [ { "code": "7ac2c5f3-7c79-4e99-b45e-aa5952620188", "type": "SPLIT_TRANSFER", "status": "SUCCEEDED", "provider_transfer_id": "tr_1T9eKVIiMnPsFcbbRTb8ObsZ", "provider_response_message": null, "provider_raw_response": "{\n \"id\": \"tr_1T9eKVIiMnPsFcbbRTb8ObsZ\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9eKVIiMnPsFcbbOPnvz3xM\",\n \"created\": 1773203107,\n \"currency\": \"usd\",\n \"description\": \"test transfer\",\n \"destination\": \"acct_1T9PSQIZEg1WWTvj\",\n \"destination_payment\": \"py_1T9eKVIZEg1WWTvjbVjmnzFK\",\n \"livemode\": false,\n \"metadata\": {},\n \"reversals\": {\n \"object\": \"list\",\n \"data\": [],\n \"has_more\": false,\n \"total_count\": 0,\n \"url\": \"/v1/transfers/tr_1T9eKVIiMnPsFcbbRTb8ObsZ/reversals\"\n },\n \"reversed\": false,\n \"source_transaction\": null,\n \"source_type\": \"card\",\n \"transfer_group\": null\n}", "created_at": "2026-03-11T04:25:06.229027Z", "updated_at": "2026-03-11T04:25:07.917364Z" } ], "created_at": "2026-03-11T04:25:06.208761Z", "updated_at": "2026-03-11T04:25:07.928000342Z", "completed_at": "2026-03-11T04:25:07.927971142Z" } }, "Error": { "value": { "id": "9778f631-504d-448f-b2c1-f7b903781df7", "recipient_id": "82b12c8c-7d3d-4a21-a3c6-165cc04ca741", "amount": { "currency": "USD", "value": 50000 }, "status": "ERROR", "description": "test transfer", "merchant_reference": "cb18df20-21ae-4fed-8da9-fb81cfd56797", "metadata": [], "provider": null, "transactions": [ { "code": "9eee65d1-6c3a-4076-9ef9-fa4bff73d597", "type": "SPLIT_TRANSFER", "status": "ERROR", "provider_transfer_id": "tr_1T9PTLIiMnPsFcbbFKyh1Nds", "provider_response_message": "{\n \"id\": \"tr_1T9PTLIiMnPsFcbbFKyh1Nds\",\n \"object\": \"transfer\",\n \"amount\": 10000,\n \"amount_reversed\": 0,\n \"balance_transaction\": \"txn_1T9PTMIiMnPsFcbbxRKvaZ3G\",\n \"created\": 1773145996,\n \"currency\": \"usd\",\n \"description\": \"test transfer\"\n}", "provider_raw_response": "{.... }", "created_at": "2026-03-10T13:39:19.342902Z", "updated_at": "2026-03-10T13:39:19.342914Z" } ], "created_at": "2026-03-10T13:39:19.241990247Z", "updated_at": "2026-03-10T13:39:19.242012664Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "TRANSFER_NOT_REVERSIBLE": { "summary": "Transfer not reversible", "value": { "code": "TRANSFER_NOT_REVERSIBLE", "messages": [ "The transfer is not in a reversible state." ] } }, "TRANSFER_ALREADY_REVERSED": { "summary": "Transfer already reversed", "value": { "code": "TRANSFER_ALREADY_REVERSED", "messages": [ "The transfer has already been reversed." ] } }, "REVERSAL_AMOUNT_EXCEEDS": { "summary": "Reversal amount exceeds original", "value": { "code": "REVERSAL_AMOUNT_EXCEEDS", "messages": [ "The reversal amount exceeds the original transfer amount." ] } }, "INVALID_CURRENCY": { "summary": "Invalid currency", "value": { "code": "INVALID_CURRENCY", "messages": [ "The specified currency is invalid or does not match the original transfer." ] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "TRANSFER_NOT_FOUND": { "summary": "Transfer not found", "value": { "code": "TRANSFER_NOT_FOUND", "messages": [ "The specified transfer was not found." ] } } } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } }, "examples": { "PROVIDER_INTERNAL_ERROR": { "summary": "Provider internal error", "value": { "code": "PROVIDER_INTERNAL_ERROR", "messages": [ "The payment provider encountered an internal error." ] } } } } } } } } }, "/subscriptions": { "get": { "summary": "List Subscriptions", "description": "Returns a paginated list of the account's subscriptions, newest first (`created_at` descending). Filters are combinable and every one of them is optional; with none set, subscriptions in every status are returned. 1-indexed pagination.", "operationId": "list-subscriptions", "parameters": [ { "in": "header", "name": "x-account-code", "required": true, "schema": { "type": "string" }, "description": "The `account_id` found in your [Yuno Dashboard](https://dashboard.y.uno/developers) (UUID). Required — the list is always scoped to a single account. Omitting it returns `400 INVALID_PARAMETERS` (\"x-account-code header is required.\")." }, { "name": "customer_id", "in": "query", "description": "Filter by the customer that owns the subscription (`customer_payer.id`, UUID). A value that isn't a UUID returns `400 BAD_REQUEST` (\"Invalid customer_id.\").", "schema": { "type": "string", "example": "3t04911d-5df9-429e-8488-ad41abea1a2c" } }, { "name": "status", "in": "query", "description": "Filter by status. Accepts several values separated by commas, matching any of them — `ACTIVE,PAUSED`. Values must be spelled exactly as in [Subscription statuses](/reference/subscriptions/status-subscriptions); an unknown one returns `400 BAD_REQUEST` (\"Invalid status: FOO.\").", "schema": { "type": "string", "example": "ACTIVE,PAUSED" } }, { "name": "plan_id", "in": "query", "description": "Filter by the [plan](/reference/plans/the-plan-object) the subscription is linked to (UUID). A plan with no subscribers — or one that doesn't exist — returns an empty list, not an error. A value that isn't a UUID returns `400 BAD_REQUEST` (\"Invalid plan_id.\").", "schema": { "type": "string", "example": "00000000-0000-4000-8000-000000000001" } }, { "name": "created_at_from", "in": "query", "description": "Only return subscriptions created at or after this instant (ISO 8601 with offset, inclusive). A value that doesn't parse returns `400 BAD_REQUEST` (\"Invalid created_at_from.\").", "schema": { "type": "string", "example": "2024-01-01T00:00:00Z" } }, { "name": "created_at_to", "in": "query", "description": "Only return subscriptions created at or before this instant (ISO 8601 with offset, inclusive). A value that doesn't parse returns `400 BAD_REQUEST` (\"Invalid created_at_to.\").", "schema": { "type": "string", "example": "2024-12-31T23:59:59Z" } }, { "name": "payment_method_type", "in": "query", "description": "Filter by the subscription's payment method type, for example `CARD`.", "schema": { "type": "string", "example": "CARD" } }, { "name": "page", "in": "query", "description": "1-indexed page number. Must be >= 1, else `400 BAD_REQUEST` (\"The page must be greater than or equal to 1.\").", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "size", "in": "query", "description": "Page size. Must be between 1 and 100 inclusive, else `400 BAD_REQUEST` (\"The size must be greater than or equal to 1.\" if too low, \"The size must be at most 100.\" if too high).", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "items": [ { "id": "7304911d-5df9-429e-8488-ad41abea1a4c", "name": "sub_001", "status": "ACTIVE", "merchant_reference": "001_marzo_23", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "customer_payer": { "id": "3t04911d-5df9-429e-8488-ad41abea1a2c" }, "amount": { "currency": "USD", "value": 12100 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 10, "current": 2, "next_at": "2023-02-16T20:00:00.786342Z" }, "payment_method": { "type": "CARD" }, "plan_id": "00000000-0000-4000-8000-000000000001", "created_at": "2023-12-16T20:46:54.786342Z" } ], "pagination": { "page": 1, "size": 20, "total": 1, "total_pages": 1 } }, "summary": "Result" } }, "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the subscription." }, "name": { "type": "string" }, "status": { "type": "string", "description": "See [Subscription statuses](/reference/subscriptions/status-subscriptions)." }, "merchant_reference": { "type": "string" }, "account_id": { "type": "string" }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the customer." } } }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } }, "frequency": { "type": [ "object", "null" ], "description": "`null` on subscriptions billed with `billing_date` instead of a frequency.", "properties": { "type": { "type": "string" }, "value": { "type": "integer" } } }, "billing_cycles": { "type": "object", "description": "Same semantics as on [The Subscription Object](/reference/subscriptions/the-subscription-object) — `current` is the next cycle to be charged, not the one in progress.", "properties": { "total": { "type": [ "integer", "null" ] }, "current": { "type": "integer" }, "next_at": { "type": "string" } } }, "payment_method": { "type": "object", "properties": { "type": { "type": "string", "description": "The payment method type, for example `CARD`." } } }, "plan_id": { "type": [ "string", "null" ], "description": "The plan the subscription is linked to, or `null` for subscriptions created with a raw `amount`/`frequency`." }, "created_at": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer", "description": "The page returned — echoes the request." }, "size": { "type": "integer", "description": "The page size returned — echoes the request." }, "total": { "type": "integer", "description": "Total subscriptions matching the filters, across every page." }, "total_pages": { "type": "integer" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "BAD_REQUEST", "messages": [ "The page must be greater than or equal to 1." ] }, "summary": "Result" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "BAD_REQUEST" }, "messages": { "type": "array", "items": { "type": "string" } } } } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] }, "post": { "summary": "Create Subscription", "description": "", "operationId": "create-subscription", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "account_id", "country", "amount", "payment_method" ], "properties": { "name": { "type": "string", "description": "The subscription plan name (MAX 255; MIN 3)." }, "description": { "type": "string", "description": "The subscription plan description (MAX 255; MIN 3)." }, "account_id": { "type": "string", "description": "The unique identifier of the account that will have the subscription plan available to use (UUID, 36 chars)." }, "merchant_reference": { "type": "string", "description": "Identification of the subscription plan (MAX 255; MIN 3)." }, "soft_descriptor": { "type": "string", "maxLength": 255, "description": "Statement descriptor shown on the cardholder's bank statement. When set, it is persisted on the subscription and propagated to every rebill payment generated by the subscription engine. Length and formatting limits vary by provider (for example, Unlimit truncates to 22 characters and Airwallex to 30). Worldpay does not read this field; it builds the statement narrative from `payment_description` instead." }, "country": { "type": "string", "description": "The subscription's country (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference))." }, "amount": { "type": "object", "description": "Specifies the `amount` object, with the value of each subscription payment and the used currency. Mutually exclusive with `plan_id` — send exactly one of the two.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment (MAX 3; MIN 3; [ISO 4217](/reference/country-reference))." }, "value": { "type": "number", "description": "The value of each payment of the subscription (multiple of 0.0001).", "format": "float" } } }, "plan_id": { "type": "string", "description": "The unique identifier of a [plan](/reference/plans/the-plan-object) to subscribe this customer to. Mutually exclusive with `amount` — send exactly one of the two. Omit `trial_period` and `billing_date` when set: both are inherited from the plan and the request is rejected with `400 BAD_REQUEST` if you send them. Also omit `frequency` — it's inherited from the plan too, but sending it anyway is not rejected: it's silently ignored and overridden by the plan's frequency." }, "additional_data": { "type": "object", "description": "Specifies the additional_data object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.", "properties": { "order": { "type": "object", "description": "Specifies the order object.", "properties": { "items": { "type": "array", "description": "Specifies the item's object.", "items": { "properties": { "id": { "type": "string", "description": "The unique identifier of the item (MAX 255; MIN 3)." }, "name": { "type": "string", "description": "The name of the item (MAX 255; MIN 3)." }, "quantity": { "type": "integer", "description": "The quantity of the item.", "format": "int32" }, "unit_amount": { "type": "number", "description": "The unit amount of the item (multiple of 0.0001)." }, "category": { "type": "string", "description": "The category of the item. Check the Item category reference.", "enum": [ "art", "baby", "coupons", "beauty_&_personal_care", "donations", "computing", "books", "grocery_&_gourmet_food", "cameras", "video_games", "television", "car_electronics", "electronics", "automotive", "toys_&_games", "musical_instruments", "handmade", "garden_&_outdoor", "entertainment", "industrial_&_scientific", "fashion", "games", "pet_supplies", "home", "musical", "phones", "services", "learnings", "tickets", "travels", "virtual_goods", "others" ] }, "brand": { "type": "string", "description": "The brand of the item (MAX 255; MIN 3)." }, "sku_code": { "type": "string", "description": "The stock keeping unit (SKU) of the item (MAX 255; MIN 3)." }, "manufacture_part_number": { "type": "string", "description": "The manufacture part number of the item." } }, "type": "object" } } } } } }, "frequency": { "type": "object", "description": "Specifies the `frequency` object. Defines the billing frequency for the subscription. Including type and value.", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The type of interval the subscription will have in time (DAY, WEEK, MONTH, YEAR). If not set, defaults to MONTH.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] }, "value": { "type": "integer", "description": "The value between each interval. Min 1. Defaults to 1 if not set.", "format": "int32" } } }, "billing_cycles": { "type": "object", "description": "Specifies the `billing_cycles` object. Defines the number of charges associated to the subscription.", "properties": { "total": { "type": "integer", "description": "The total number of billing cycles for the subscription (MIN 1).", "format": "int32" } } }, "customer_payer": { "type": "object", "description": "Specifies the `customer_payer` object to identify the customer.", "properties": { "id": { "type": "string", "description": "The unique identifier of the customer (UUID, 36 chars)." } } }, "payment_method": { "type": "object", "description": "Specifies the `payment_method` object. Supported types are `CARD` and `PAYPAL_ENROLLMENT`, both using previously enrolled payment methods (`vaulted_token`)", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Payment method type.", "enum": [ "CARD", "PAYPAL_ENROLLMENT" ] }, "vaulted_token": { "type": "string", "description": "The vaulted token (UUID, 36 chars)." }, "card": { "type": "object", "properties": { "installments": { "type": "integer", "description": "The number of installments (MAX 50; MIN 1)." }, "network_transaction_id": { "type": "string", "description": "The ID provided by Visa/Mastercard in the response of the initial payment (MAX 256; MIN 1)." }, "usage": { "type": "string", "description": "Indicates whether this stored credential is being used for the first time (FIRST) or has been used before (USED). Required if a CIT payment was created before the subscription — without it, rebills are treated as CITs and may be declined.", "enum": [ "FIRST", "USED" ] } } } } }, "trial_period": { "type": "object", "description": "Specifies the trial period object", "properties": { "billing_cycles": { "type": "integer", "description": "The amount of cycles the trial period will have in time. If not set, defaults to 1 (MIN 1).", "format": "int32" }, "amount": { "type": "object", "description": "Amount to be discounted for the trial period", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment (MAX 3; MIN 3; [ISO 4217](/reference/country-reference))." }, "value": { "type": "number", "description": "The value of each payment of the subscription (multiple of 0.0001).", "format": "float" } } } } }, "availability": { "type": "object", "description": "Specifies the `availability` object. Defines a date interval based on starting and ending dates when the subscription is available to use.", "properties": { "start_at": { "type": "string", "description": "The start date that the subscription plan will be available to use. If not set, the subscription is available from the moment it is created.", "format": "date-time" }, "finish_at": { "type": "string", "description": "The end date until the subscription plan will be available to use. If not defined, the subscription does not have an expiration date.", "format": "date-time" } } }, "metadata": { "type": "array", "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Keys can be unset by posting an empty value to metadata. You can add up to 50 metadata objects.", "items": { "properties": { "key": { "type": "string", "description": "The metadata key (MAX 48)." }, "value": { "type": "string", "description": "The metadata key value (MAX 512)." } }, "type": "object" } }, "retries": { "type": "object", "description": "Specified the 'retries' object. If we need to retry declined transactions in Yuno and the amount if necessary", "properties": { "retry_on_decline": { "type": "boolean", "description": "If we should retry a payment or not after a first decline. False by default." }, "amount": { "type": "integer", "description": "The number of retries that the subscription plan will have to complete. 6 will be defined as default if this value is not set or higher than 6. (MAX 6).", "format": "int32" }, "strategy": { "type": "string", "description": "The retry strategy. Allowed values: DEFAULT (the fixed retry schedule), SMART (machine-learning-based retry timing, applied from the second retry onward) or CUSTOM_SCHEDULE (uses the per-attempt schedule array you provide).", "enum": [ "DEFAULT", "SMART", "CUSTOM_SCHEDULE" ] }, "schedule": { "type": "array", "description": "Object that define the schedule strategy for each retry event, the amounts of objects should match the amount of retries defined.", "items": { "properties": { "attempt": { "type": "number", "description": "Number of the retry attempt" }, "delay_seconds": { "type": "number", "description": "Specifies the amount of seconds between each retry." } }, "type": "object" } }, "stop_on_hard_decline": { "type": "boolean", "description": "When true, the retry schedule stops for the current billing cycle after a hard decline. On its own, the subscription remains ACTIVE and billing advances to the next cycle; no subscription is canceled or paused and no subscription webhook is emitted. If cancel_on_exhausted_retries is also true, the subscription is canceled instead." }, "cancel_on_exhausted_retries": { "type": "boolean", "description": "When true, the subscription is canceled once retries for a billing cycle end without a successful payment, instead of remaining ACTIVE and advancing to the next cycle. The subscription status becomes CANCELED, cancellation_source is set to RETRIES_EXHAUSTED, future billing stops, and a single SUBSCRIPTION.CANCEL webhook is emitted. Applies both when the retry schedule runs out and when stop_on_hard_decline ends the cycle early. Defaults to false, which preserves the existing behavior. Can be set at creation or changed later via Update Subscription. The cancellation itself is final, so Retry Subscription is rejected afterwards." } } }, "initial_payment_validation": { "type": "boolean", "description": "Flag to identify if the subscription should wait for the first payment in order to continue. False by default." }, "billing_date": { "type": "object", "description": "Specifies the `billing_date` object. Defines the type of date use for the subscription logic. Mutually exclusive with the frequency object.", "properties": { "type": { "type": "string", "description": "The type of billing_date the subscription will have in time. PREPAID, POSTDATE, DAY. If not set, the creation date for the plan will be set by default." }, "day": { "type": "integer", "description": "[Conditional] The day of the month to charge the subscription if type is DAY. Default is 1. Range 1 - 31." } } }, "subscription_agreement_id": { "type": "string", "description": "Links this subscription to the initial payment created with the same agreement ID. Used for tracking, reconciliation, and chargeback handling. Must exactly match the `subscription_agreement_id` sent in `payment_method.detail.card.stored_credentials.subscription_agreement_id` on the originating payment (MAX 255)." } } }, "examples": { "Subscription": { "value": { "name": "Test Subscription", "description": "Subscription Test", "merchant_reference": "subscription-ref-merchant-AA01", "soft_descriptor": "ACME SUBSCRIPTION", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "country": "CL", "amount": { "currency": "CLP", "value": 15000 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 12 }, "customer_payer": { "id": "a1d3b664-e32a-4508-9da1-9ede3e62a60c" }, "payment_method": { "type": "CARD", "vaulted_token": "d4aa3586-def2-4705-b7cd-fe064bb764e6", "card": { "installments": 3 } }, "availability": { "start_at": "2024-11-01T00:00:00Z" }, "trial_period": { "billing_cycles": 1, "amount": { "currency": "CLP", "value": 0 } }, "metadata": [ { "key": "plan", "value": "gold" } ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "CREATE SUBSCRIPTION": { "value": { "id": "0c7fed3e-ee0d-4d34-9547-778be4ec0798", "name": "Test Subscription", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "country": "US", "description": "Subscription Test", "merchant_reference": "subscription-ref-merchant-AA01", "soft_descriptor": "ACME SUBSCRIPTION", "status": "ACTIVE", "amount": { "currency": "USD", "value": 15000 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 12, "current": 1, "next_at": "2024-09-30T12:04:23.265393Z" }, "customer_payer": { "id": "a1d3b664-e32a-4508-9da1-9ede3e62a60c" }, "payment_method": { "type": "CARD", "vaulted_token": "d4aa3586-def2-4705-b7cd-fe064bb764e6" }, "availability": { "start_at": "2024-09-30T12:04:23.265393Z", "finish_at": null }, "trial_period": { "billing_cycles": 1, "amount": { "value": 0, "currency": "" } }, "metadata": null, "created_at": "2024-09-30T12:04:23.265372Z", "updated_at": "2024-09-30T12:04:23.265372Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "0c7fed3e-ee0d-4d34-9547-778be4ec0798" }, "name": { "type": "string", "example": "Test Subscription" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "country": { "type": "string", "example": "US" }, "description": { "type": "string", "example": "Subscription Test" }, "merchant_reference": { "type": "string", "example": "subscription-ref-merchant-AA01" }, "soft_descriptor": { "type": "string", "example": "ACME SUBSCRIPTION" }, "status": { "type": "string", "example": "ACTIVE" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 15000, "default": 0 } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "example": "MONTH" }, "value": { "type": "integer", "example": 1, "default": 0 } } }, "billing_cycles": { "type": "object", "properties": { "total": { "type": "integer", "example": 12, "default": 0 }, "current": { "type": "integer", "example": 1, "default": 0 }, "next_at": { "type": "string", "example": "2024-09-30T12:04:23.265393Z" } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "a1d3b664-e32a-4508-9da1-9ede3e62a60c" } } }, "payment_method": { "type": "object", "properties": { "type": { "type": "string", "example": "CARD" }, "vaulted_token": { "type": "string", "example": "d4aa3586-def2-4705-b7cd-fe064bb764e6" } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2024-09-30T12:04:23.265393Z" }, "finish_at": {} } }, "trial_period": { "type": "object", "properties": { "billing_cycles": { "type": "integer", "example": 1, "default": 0 }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "" } } } } }, "metadata": {}, "plan_id": { "type": "string", "description": "Only present when the subscription is linked to a plan." }, "plan_assigned_at": { "type": "string", "description": "Only present on plan-linked subscriptions. The moment the plan was attached — at creation from a plan, migration onto a plan, or a plan change." }, "previous_subscription_id": { "type": "string", "description": "Only present when this subscription was created by a plan change (switching an existing subscription to a different plan)." }, "current_phase": { "type": "string", "description": "Only present on plan-linked subscriptions." }, "billing_phases": { "type": "array", "description": "Only present on plan-linked subscriptions whose plan has phases. Contains the leading TRIAL phases only, snapshotted at creation — the terminal REGULAR phase is never included, since its price isn't pinned and instead resolves from the plan at every billing.", "items": { "type": "object", "properties": { "order": { "type": "integer" }, "type": { "type": "string", "description": "Always TRIAL — the terminal REGULAR phase is never in this array." }, "name": { "type": "string" }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" } } }, "start_cycle": { "type": "integer" }, "end_cycle": { "type": "integer" } } } }, "subscription_agreement_id": { "type": "string", "example": "sa_6af2dfcd-44c0-4f16-a331-8bed3ed9c9fa" }, "created_at": { "type": "string", "example": "2024-09-30T12:04:23.265372Z" }, "updated_at": { "type": "string", "example": "2024-09-30T12:04:23.265372Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request." ] }, "summary": "Result" } } } } } }, "deprecated": false, "parameters": [ { "in": "header", "name": "x-idempotency-key", "schema": { "type": "string", "default": "{$randomUUID}" }, "description": "A unique identifier for the request. Must be different each time (UUID). See [authentication](/reference/authentication#idempotency)." } ], "tags": [ "Subscriptions" ] } }, "/subscriptions/{subscription_id}": { "get": { "summary": "Retrieve Subscription", "description": "", "operationId": "retrieve-subscription", "parameters": [ { "name": "subscription_id", "in": "path", "description": "The unique identifier of the subscription.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "7304911d-5df9-429e-8488-ad41abea1a4c", "name": "sub_001", "description": "streaming service", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "country": "US", "merchant_reference": "001_marzo_23", "soft_descriptor": "ACME SUBSCRIPTION", "status": "ACTIVE", "amount": { "currency": "USD", "value": 12100 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 10, "current": 2, "next_at": "2023-02-16T20:00:00.786342Z" }, "current_period_start": "2023-01-16T20:00:00.912480Z", "current_period_end": "2023-02-16T20:00:00.786342Z", "billing_date": null, "customer_payer": { "id": "3t04911d-5df9-429e-8488-ad41abea1a2c" }, "payment_method": { "type": "CARD", "vaulted_token": "6104911d-5df9-429e-8488-ad41abea1a4b", "card": { "installments": null, "network_transaction_id": null, "usage": "FIRST" } }, "availability": { "start_at": "2024-01-16T00:00:00.786342Z", "finish_at": "2024-05-26T20:00:00.786342Z" }, "retries": { "retry_on_decline": true, "amount": 4, "strategy": "DEFAULT", "schedule": null, "stop_on_hard_decline": null, "cancel_on_exhausted_retries": null }, "trial_period": { "billing_cycles": 1, "amount": { "value": 0, "currency": "" } }, "initial_payment_validation": false, "metadata": [ { "key": "sub_ext_id", "value": "AA001" } ], "additional_data": null, "reason": null, "renewal_notification_days": 3, "payments": [ "5104911d-5df9-229e-8468-bd41abea1a4s" ], "subscription_agreement_id": null, "cancellation_time": null, "cancellation_source": null, "ending_time": null, "plan_id": "00000000-0000-4000-8000-000000000001", "plan_assigned_at": "2023-12-16T20:46:54.786342Z", "previous_subscription_id": null, "phases": [ { "order": 1, "name": "Intro", "type": "TRIAL", "duration": { "type": "MONTH", "value": 3 }, "frequency": { "type": "MONTH", "value": 1 }, "amount": { "currency": "USD", "value": 9.99 }, "total_payments": 3, "country_prices": [] }, { "order": 2, "name": "Regular", "type": "REGULAR", "duration": null, "frequency": null, "amount": null, "total_payments": null, "country_prices": [] } ], "current_phase": "REGULAR", "billing_phases": [ { "order": 1, "type": "TRIAL", "name": "Intro", "amount": { "currency": "USD", "value": 9.99 }, "frequency": { "type": "MONTH", "value": 1 }, "start_cycle": 0, "end_cycle": 2 } ], "pending_plan_change": null, "created_at": "2023-12-16T20:46:54.786342Z", "updated_at": "2023-12-16T21:00:54.786342Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "7304911d-5df9-429e-8488-ad41abea1a4c" }, "name": { "type": "string", "example": "sub_001" }, "description": { "type": "string", "example": "streaming service" }, "account_id": { "type": "string", "example": "2404911d-5df9-429e-8488-ad41abea1a4b" }, "country": { "type": "string", "description": "The subscription's country (ISO 3166-1 alpha-2).", "example": "US" }, "merchant_reference": { "type": "string", "example": "001_marzo_23" }, "soft_descriptor": { "type": "string", "example": "ACME SUBSCRIPTION" }, "status": { "type": "string", "example": "ACTIVE" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 12100, "default": 0 } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "example": "MONTH" }, "value": { "type": "integer", "example": 1, "default": 0 } } }, "billing_cycles": { "type": "object", "properties": { "total": { "type": "integer", "example": 10, "default": 0 }, "current": { "type": "integer", "example": 2, "default": 0 }, "next_at": { "type": "string", "example": "2023-02-16T20:00:00.786342Z" } } }, "current_period_start": { "type": "string", "description": "Only returned by this endpoint, and only once the first billing cycle has been charged. Always returned together with current_period_end.", "example": "2023-01-16T20:00:00.912480Z" }, "current_period_end": { "type": "string", "description": "Only returned by this endpoint, and only once the first billing cycle has been charged. Equal to billing_cycles.next_at. Always returned together with current_period_start.", "example": "2023-02-16T20:00:00.786342Z" }, "billing_date": { "type": [ "object", "null" ], "description": "Only present on subscriptions billed on a fixed date instead of a frequency; mutually exclusive with `frequency`.", "properties": { "type": { "type": "string", "example": "DAY" }, "day": { "type": "integer", "example": 2 } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "3t04911d-5df9-429e-8488-ad41abea1a2c" } } }, "payment_method": { "type": "object", "properties": { "type": { "type": "string", "example": "CARD" }, "vaulted_token": { "type": "string", "example": "6104911d-5df9-429e-8488-ad41abea1a4b" }, "card": { "type": "object", "properties": { "installments": { "type": [ "integer", "null" ] }, "network_transaction_id": { "type": [ "string", "null" ] }, "usage": { "type": "string", "example": "FIRST" } } } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2024-01-16T00:00:00.786342Z" }, "finish_at": { "type": "string", "example": "2024-05-26T20:00:00.786342Z" } } }, "retries": { "type": [ "object", "null" ], "description": "The retry policy applied when a recurring charge is declined. See [Retries](/docs/payment-features/subscriptions/retries).", "properties": { "retry_on_decline": { "type": "boolean", "description": "Whether declined charges are retried at all.", "example": true }, "amount": { "type": "integer", "description": "How many retries a billing cycle gets. Capped by your environment's retry schedule length (6 in production).", "example": 4 }, "strategy": { "type": "string", "description": "How the timing of each retry is decided: `DEFAULT`, `SMART` or `CUSTOM_SCHEDULE`. Treat as open-ended — handle unrecognized values gracefully.", "example": "DEFAULT" }, "schedule": { "type": [ "array", "null" ], "description": "The per-attempt schedule, only set when `strategy` is `CUSTOM_SCHEDULE`; `null` otherwise.", "items": { "type": "object" } }, "stop_on_hard_decline": { "type": [ "boolean", "null" ], "description": "When true, a hard decline stops the retries for the current billing cycle." }, "cancel_on_exhausted_retries": { "type": [ "boolean", "null" ], "description": "When true, the subscription is canceled once a cycle's retries end without a successful payment, with `cancellation_source` set to `RETRIES_EXHAUSTED`." } } }, "trial_period": { "type": "object", "properties": { "billing_cycles": { "type": "integer", "example": 1, "default": 0 }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "" } } } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "sub_ext_id" }, "value": { "type": "string", "example": "AA001" } } } }, "additional_data": { "type": [ "object", "null" ], "description": "The optional order enrichment sent at creation, echoed back. See [The Subscription Object](/reference/subscriptions/the-subscription-object) for its full shape." }, "initial_payment_validation": { "type": "boolean", "description": "Whether the subscription waited for its first payment to succeed before activating. `false` by default.", "example": false }, "reason": { "type": [ "string", "null" ], "description": "Free-form reason for the subscription's current status, when one was recorded; `null` otherwise.", "example": "merchant request" }, "renewal_notification_days": { "type": [ "integer", "null" ], "description": "How many days before the next billing date the `subscription.close_to_renewal` webhook is sent. `null` means no renewal notification is sent.", "example": 3 }, "payments": { "type": "array", "items": { "type": "string", "example": "5104911d-5df9-229e-8468-bd41abea1a4s" } }, "subscription_agreement_id": { "type": "string", "example": "sa_6af2dfcd-44c0-4f16-a331-8bed3ed9c9fa" }, "cancellation_time": { "type": [ "string", "null" ], "description": "When the subscription was canceled. Only set once it reaches `CANCELED`; `null` otherwise.", "example": "2023-12-16T20:46:54.786342Z" }, "cancellation_source": { "type": [ "string", "null" ], "description": "What triggered the cancellation: `MERCHANT`, `SYSTEM`, `PLAN_CHANGE` or `RETRIES_EXHAUSTED`. Only set once the subscription reaches `CANCELED`; `null` otherwise. Treat as open-ended — handle unrecognized values gracefully.", "example": "MERCHANT" }, "ending_time": { "type": [ "string", "null" ], "description": "When the subscription completed or expired. Only set once it reaches `COMPLETED`; `null` otherwise.", "example": "2024-12-16T20:46:54.786342Z" }, "plan_id": { "type": "string", "description": "Only present when the subscription is linked to a plan.", "example": "00000000-0000-4000-8000-000000000001" }, "plan_assigned_at": { "type": "string", "description": "Only present on plan-linked subscriptions. The moment the plan was attached — at creation from a plan, migration onto a plan, or a plan change.", "example": "2023-12-16T20:46:54.786342Z" }, "previous_subscription_id": { "type": "string", "description": "Only present when this subscription was created by a plan change (switching an existing subscription to a different plan)." }, "phases": { "type": "array", "description": "The linked plan's phase definitions, as the plan declares them — including the terminal `REGULAR` phase. Only present on plan-linked subscriptions whose plan has phases. This is the plan's own ladder, not this subscriber's snapshot: for what was pinned for this subscription at creation, use `billing_phases`.", "items": { "type": "object", "properties": { "order": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string", "description": "`TRIAL` or `REGULAR`." }, "duration": { "type": [ "object", "null" ], "description": "How long the phase lasts. `null` on the terminal `REGULAR` phase, which runs until the subscription ends.", "properties": { "type": { "type": "string" }, "value": { "type": "integer" } } }, "frequency": { "type": [ "object", "null" ], "description": "How often the phase bills. `null` on the terminal `REGULAR` phase, which bills at the plan's own frequency.", "properties": { "type": { "type": "string" }, "value": { "type": "integer" } } }, "amount": { "type": [ "object", "null" ], "description": "The phase price. `null` on the terminal `REGULAR` phase, whose price resolves from the plan at every billing.", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } }, "total_payments": { "type": [ "integer", "null" ] }, "country_prices": { "type": "array", "description": "Per-country overrides of the phase price, empty when the phase has none.", "items": { "type": "object", "properties": { "country": { "type": "string" }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } } } } } } } }, "current_phase": { "type": "string", "description": "Only present on plan-linked subscriptions.", "example": "REGULAR" }, "billing_phases": { "type": "array", "description": "Only present on plan-linked subscriptions whose plan has phases. Contains the leading TRIAL phases only, snapshotted at creation — the terminal REGULAR phase is never included, since its price isn't pinned and instead resolves from the plan at every billing. `current_phase: \"REGULAR\"` is how you know the ladder is exhausted.", "items": { "type": "object", "properties": { "order": { "type": "integer" }, "type": { "type": "string", "description": "Always TRIAL — the terminal REGULAR phase is never in this array." }, "name": { "type": "string" }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" } } }, "start_cycle": { "type": "integer" }, "end_cycle": { "type": "integer" } } } }, "pending_plan_change": { "type": [ "object", "null" ], "description": "The plan change scheduled for the next billing cycle, or null when none is pending. Schedule one with the `plan_change` block on Update Subscription.", "properties": { "plan_id": { "type": "string", "description": "The identifier of the target plan.", "example": "1904911d-5df9-429e-8488-ad41abea1a4d" }, "plan_name": { "type": "string", "description": "The name of the target plan.", "example": "Pro" }, "direction": { "type": "string", "enum": [ "UPGRADE", "DOWNGRADE" ], "description": "Whether the target plan is an upgrade or a downgrade. Informational only.", "example": "UPGRADE" }, "effective": { "type": "string", "enum": [ "NEXT_BILLING_CYCLE" ], "description": "When the change applies.", "example": "NEXT_BILLING_CYCLE" }, "phases_behavior": { "type": "string", "enum": [ "START_FROM_REGULAR", "HONOR_PHASES" ], "description": "What happens when the target plan has phases.", "example": "START_FROM_REGULAR" }, "applies_at": { "type": "string", "description": "The billing event the change will take effect on — the subscription's next billing date.", "example": "2023-02-16T20:00:00.786342Z" }, "requested_at": { "type": "string", "description": "When the change was scheduled.", "example": "2023-01-20T10:12:31.786342Z" } } }, "created_at": { "type": "string", "example": "2023-12-16T20:46:54.786342Z" }, "updated_at": { "type": "string", "example": "2023-12-16T21:00:54.786342Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "SUBSCRIPTION_NOT_FOUND", "messages": [ "Subscription not found." ] }, "summary": "Result" } } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] }, "patch": { "summary": "Update Subscription", "description": "", "operationId": "update-subscription", "parameters": [ { "name": "subscription_id", "in": "path", "description": "The unique identifier of the subscription.", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The subscription plan name (MAX 255; MIN 3)." }, "description": { "type": "string", "description": "The subscription plan description (MAX 255; MIN 3)." }, "account_id": { "type": "string", "description": "The unique identifier of the account that will have the subscription plan available to use (MAX 64 ; MIN 36)." }, "merchant_reference": { "type": "string", "description": "Identification of the subscription plan (MAX 255; MIN 3)." }, "soft_descriptor": { "type": "string", "maxLength": 255, "description": "Statement descriptor shown on the cardholder's bank statement. Updating it changes the descriptor applied to subsequent rebills generated by the subscription engine. Length and formatting limits vary by provider (for example, Unlimit truncates to 22 characters and Airwallex to 30). Worldpay does not read this field; it builds the statement narrative from `payment_description` instead." }, "country": { "type": "string", "description": "The subscription's country." }, "amount": { "type": "object", "description": "Specifies the `amount` object, with the value of each subscription payment and the used currency.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "The currency used to make the payment (MAX 3; MIN 3; [ISO 4217](/reference/country-reference))." }, "value": { "type": "number", "description": "The value of each payment of the subscription (multiple of 0.0001).", "format": "float" } } }, "frequency": { "type": "object", "description": "Specifies the `frequency` object. Defines the billing frequency for the subscription. Including type and value.", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The type of interval the subscription will have in time (DAY, WEEK, MONTH). If not set, always MONTH by default.", "enum": [ "DAY", "WEEK", "MONTH" ] }, "value": { "type": "integer", "description": "The value between each interval the subscription will have in time. The system will use the default value of 1 if not set.", "format": "int32" }, "monthly_billing_day": { "type": "integer", "description": "The day of the month when billing is processed. (MAX 31; MIN 1). Only valid for MONTH frequency. If the subscription has not started yet (availability.start_at is in the future), the first billing still occurs at availability.start_at and the billing day applies from the second cycle onward; the resulting first billing period may be shorter than a full cycle and is charged in full." } } }, "billing_cycles": { "type": "object", "description": "Specifies the `billing_cycles` object. Defines the number of charges associated to the subscription.", "properties": { "total": { "type": "integer", "description": "The total number of billing cycles for the subscription. On update, must be greater than or equal to the current `billing_cycles.current`; a lower value is rejected with 400.", "format": "int32" } } }, "customer_payer": { "type": "object", "description": "Specifies the `customer_payer` object to identify the customer.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the customer (MAX 255; MIN 3)." } } }, "payment_method": { "type": "object", "description": "Specifies the `payment_method` object. Supported types are `CARD` and `PAYPAL_ENROLLMENT`. You can use the `token`, the `vaulted_token`, or the card information through the card object.", "properties": { "type": { "type": "string", "description": "Payment method type.", "enum": [ "CARD" ] }, "vaulted_token": { "type": "string", "description": "The vaulted token (MAX: 64; MIN: 36)." }, "card": { "type": "object", "description": "Specifies the card object.", "properties": { "verify": { "type": "boolean", "description": "Using `amount` = 0 and `verify` = true, you can verify the user´s card without authorizing a real amount." }, "card_data": { "type": "object", "description": "Specifies the card data object.", "properties": { "number": { "type": "string", "description": "Card’s number without any separators. (MAX 19; MIN 8) - only available for PCI certified merchants." }, "expiration_month": { "type": "integer", "description": "Card’s expiration month - MM (MAX 2; MIN 2) - only available for PCI certified merchants", "format": "int32" }, "expiration_year": { "type": "integer", "description": "Card’s expiration year in the YYYY format (MAX 4; MIN 4) - only available for PCI certified merchants", "format": "int32" }, "security_code": { "type": "integer", "description": "Card’s security code (MAX 4; MIN 3) - only available for PCI certified merchants.", "format": "int32" }, "holder_name": { "type": "string", "description": "Cardholder’s full name as it appears on the card (MAX 26; MIN 3) - only available for PCI certified merchants" } } }, "usage": { "type": "string", "description": "Indicates whether this stored credential is being used for the first time (FIRST) or has been used before (USED). Required if a CIT payment was created before the subscription — without it, rebills are treated as CITs and may be declined.", "enum": [ "FIRST", "USED" ] } } }, "": { "type": "string" } } }, "availability": { "type": "object", "description": "Specifies the `availability` object. Defines a date interval based on starting and ending dates when the subscription is available to use. If this object is omitted from the request, the availability dates are left unchanged. When it is included, omitting `finish_at` (or sending it as `null`) removes any previously set end date; omitting `start_at` leaves the current start date unchanged.", "properties": { "start_at": { "type": "string", "description": "The start date that the subscription plan will be available to use. If not set, the subscription is available from the moment it is created. On update, omitting this field leaves the current start date unchanged, and the start date can only be moved earlier: sending a later date returns a 400 error.", "format": "date-time" }, "finish_at": { "type": [ "string", "null" ], "description": "The end date until the subscription will be available to use. When the `availability` object is included in the request, omit this field or send `null` to clear a previously set end date: the subscription becomes open-ended and keeps renewing until it is canceled. Send a date-time to set or update the end date. Note that `availability.finish_at` and `billing_cycles.total` are independent end conditions: whichever is reached first completes the subscription.", "format": "date-time" } } }, "retries": { "type": "object", "description": "Specified the 'retries' object. If we need to retry declined transactions in Yuno and the amount if necessary. If modified, the retries will apply to the next payment intent.", "properties": { "retry_on_decline": { "type": "boolean", "description": "If we should retry a payment or not after a first decline. False by default." }, "amount": { "type": "integer", "description": "The number of retries that the subscription plan will have to completion. If not set, or higher than 7, 7 will be defined as default. Max: 7", "format": "int32" }, "cancel_on_exhausted_retries": { "type": "boolean", "description": "When true, the subscription is canceled once retries for a billing cycle end without a successful payment, instead of remaining ACTIVE and advancing to the next cycle. cancellation_source is set to RETRIES_EXHAUSTED and a single SUBSCRIPTION.CANCEL webhook is emitted. Defaults to false. The cancellation itself is final, so Retry Subscription is rejected afterwards." } } }, "plan_change": { "type": [ "object", "null" ], "description": "Schedules a move to another plan, effective at the next billing cycle. The subscription must be ACTIVE or TRIALING and already on a plan; the target plan must be ACTIVE. Only one change can be pending at a time. Send `\"plan_change\": null` to undo a pending change before it applies. `amount`, `frequency`, `billing_date` and `country` are managed by the plan and cannot be sent for a plan-linked subscription — combining any of them with `plan_change` returns 400.", "required": [ "plan_id" ], "properties": { "plan_id": { "type": "string", "description": "The identifier of the target plan. Required. The target plan must be ACTIVE and priced in the subscription's currency." }, "effective": { "type": "string", "enum": [ "NEXT_BILLING_CYCLE" ], "description": "When the change applies. NEXT_BILLING_CYCLE is the default and only supported value: the current cycle bills the current plan's price, the next one bills the new plan's." }, "phases_behavior": { "type": "string", "enum": [ "START_FROM_REGULAR", "HONOR_PHASES" ], "description": "What happens when the target plan has phases. START_FROM_REGULAR (default) enters the regular phase directly — no re-lived trials. HONOR_PHASES enters through the target plan's phase schedule." } } }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.", "properties": { "key": { "type": "string", "description": "Object title that represents the key-value pair inside the metadata (MAX 48 ; MIN 1)." }, "value": { "type": "string", "description": "Object value for the key defined (MAX 512 ; MIN 1)." } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "UPDATE SUBSCRIPTION": { "value": { "id": "0c7fed3e-ee0d-4d34-9547-778be4ec0798", "name": "Test Subscription", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "country": "US", "description": "Subscription Test", "merchant_reference": "subscription-ref-merchant-AA01", "soft_descriptor": "ACME SUBSCRIPTION", "status": "ACTIVE", "amount": { "currency": "USD", "value": 15000 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 12, "current": 1, "next_at": "2024-09-30T12:04:23.265393Z" }, "customer_payer": { "id": "a1d3b664-e32a-4508-9da1-9ede3e62a60c" }, "payment_method": { "type": "CARD", "vaulted_token": "d4aa3586-def2-4705-b7cd-fe064bb764e6" }, "availability": { "start_at": "2024-09-30T12:04:23.265393Z", "finish_at": null }, "metadata": null, "pending_plan_change": { "plan_id": "1904911d-5df9-429e-8488-ad41abea1a4d", "plan_name": "Pro", "direction": "UPGRADE", "effective": "NEXT_BILLING_CYCLE", "phases_behavior": "START_FROM_REGULAR", "applies_at": "2024-10-30T12:04:23.265372Z", "requested_at": "2024-09-30T12:04:23.265372Z" }, "created_at": "2024-09-30T12:04:23.265372Z", "updated_at": "2024-09-30T12:04:23.265372Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "0c7fed3e-ee0d-4d34-9547-778be4ec0798" }, "name": { "type": "string", "example": "Test Subscription" }, "account_id": { "type": "string", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "country": { "type": "string", "example": "US" }, "description": { "type": "string", "example": "Subscription Test" }, "merchant_reference": { "type": "string", "example": "subscription-ref-merchant-AA01" }, "soft_descriptor": { "type": "string", "example": "ACME SUBSCRIPTION" }, "status": { "type": "string", "example": "ACTIVE" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 15000, "default": 0 } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "example": "MONTH" }, "value": { "type": "integer", "example": 1, "default": 0 } } }, "billing_cycles": { "type": "object", "properties": { "total": { "type": "integer", "example": 12, "default": 0 }, "current": { "type": "integer", "example": 1, "default": 0 }, "next_at": { "type": "string", "example": "2024-09-30T12:04:23.265393Z" } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "a1d3b664-e32a-4508-9da1-9ede3e62a60c" } } }, "payment_method": { "type": "object", "properties": { "type": { "type": "string", "example": "CARD" }, "vaulted_token": { "type": "string", "example": "d4aa3586-def2-4705-b7cd-fe064bb764e6" } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2024-09-30T12:04:23.265393Z" }, "finish_at": {} } }, "metadata": {}, "pending_plan_change": { "type": [ "object", "null" ], "description": "The plan change scheduled for the next billing cycle, or null when none is pending.", "properties": { "plan_id": { "type": "string", "description": "The identifier of the target plan.", "example": "1904911d-5df9-429e-8488-ad41abea1a4d" }, "plan_name": { "type": "string", "description": "The name of the target plan.", "example": "Pro" }, "direction": { "type": "string", "enum": [ "UPGRADE", "DOWNGRADE" ], "description": "Whether the target plan is an upgrade or a downgrade. Informational only.", "example": "UPGRADE" }, "effective": { "type": "string", "enum": [ "NEXT_BILLING_CYCLE" ], "description": "When the change applies.", "example": "NEXT_BILLING_CYCLE" }, "phases_behavior": { "type": "string", "enum": [ "START_FROM_REGULAR", "HONOR_PHASES" ], "description": "What happens when the target plan has phases.", "example": "START_FROM_REGULAR" }, "applies_at": { "type": "string", "description": "The billing event the change will take effect on — the subscription's next billing date.", "example": "2024-10-30T12:04:23.265372Z" }, "requested_at": { "type": "string", "description": "When the change was scheduled.", "example": "2024-09-30T12:04:23.265372Z" } } }, "created_at": { "type": "string", "example": "2024-09-30T12:04:23.265372Z" }, "updated_at": { "type": "string", "example": "2024-09-30T12:04:23.265372Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_REQUEST", "messages": [ "Invalid request." ] } } } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] } }, "/subscriptions/{subscription_id}/cancel": { "post": { "summary": "Cancel Subscription", "description": "", "operationId": "cancel-subscription", "parameters": [ { "name": "subscription_id", "in": "path", "description": "The unique identifier of a subscription.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "CANCEL SUBSCRIPTION": { "value": { "id": "7304911d-5df9-429e-8488-ad41abea1a4c", "name": "sub_001", "description": "streaming service", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "merchant_reference": "001_marzo_23", "status": "CANCELED", "subscription_plan_id": "1904911d-5df9-429e-8488-ad41abea1a4d", "amount": { "currency": "USD", "value": 12100 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 10, "current": 2, "next_at": "2023-02-16T20:00:00.786342Z" }, "customer_payer": { "id": "3t04911d-5df9-429e-8488-ad41abea1a2c" }, "payment_method": [ { "type": "CARD", "token": "9104911d-5df9-429e-8488-ad41abea1a4b", "vaulted_token": "6104911d-5df9-429e-8488-ad41abea1a4b", "card": { "verify": false, "card_data": { "number": "4507990000000010", "expiration_month": 10, "expiration_year": 2025, "security_code": 123, "holder_name": "JOHN DOE" } } } ], "availability": { "start_at": "2024-01-16T00:00:00.786342Z", "finish_at": "2024-05-26T20:00:00.786342Z" }, "metadata": { "key": "sub_ext_id", "value": "AA001" }, "payments": [ "5104911d-5df9-229e-8468-bd41abea1a4s" ], "created_at": "2023-12-16T20:46:54.786342Z", "updated_at": "2023-12-16T21:00:54.786342Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "7304911d-5df9-429e-8488-ad41abea1a4c" }, "name": { "type": "string", "example": "sub_001" }, "description": { "type": "string", "example": "streaming service" }, "account_id": { "type": "string", "example": "2404911d-5df9-429e-8488-ad41abea1a4b" }, "merchant_reference": { "type": "string", "example": "001_marzo_23" }, "status": { "type": "string", "example": "CANCELED" }, "subscription_plan_id": { "type": "string", "example": "1904911d-5df9-429e-8488-ad41abea1a4d" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 12100, "default": 0 } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "example": "MONTH" }, "value": { "type": "integer", "example": 1, "default": 0 } } }, "billing_cycles": { "type": "object", "properties": { "total": { "type": "integer", "example": 10, "default": 0 }, "current": { "type": "integer", "example": 2, "default": 0 }, "next_at": { "type": "string", "example": "2023-02-16T20:00:00.786342Z" } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "3t04911d-5df9-429e-8488-ad41abea1a2c" } } }, "payment_method": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "CARD" }, "token": { "type": "string", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "vaulted_token": { "type": "string", "example": "6104911d-5df9-429e-8488-ad41abea1a4b" }, "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "card_data": { "type": "object", "properties": { "number": { "type": "string", "example": "4507990000000010" }, "expiration_month": { "type": "integer", "example": 10, "default": 0 }, "expiration_year": { "type": "integer", "example": 2025, "default": 0 }, "security_code": { "type": "integer", "example": 123, "default": 0 }, "holder_name": { "type": "string", "example": "JOHN DOE" } } } } } } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2024-01-16T00:00:00.786342Z" }, "finish_at": { "type": "string", "example": "2024-05-26T20:00:00.786342Z" } } }, "metadata": { "type": "object", "properties": { "key": { "type": "string", "example": "sub_ext_id" }, "value": { "type": "string", "example": "AA001" } } }, "payments": { "type": "array", "items": { "type": "string", "example": "5104911d-5df9-229e-8468-bd41abea1a4s" } }, "created_at": { "type": "string", "example": "2023-12-16T20:46:54.786342Z" }, "updated_at": { "type": "string", "example": "2023-12-16T21:00:54.786342Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_STATE", "messages": [ "The subscription state does not support the action requested." ] } } } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] } }, "/subscriptions/{subscription_id}/pause": { "post": { "summary": "Pause Subscription", "description": "", "operationId": "pause-subscription", "parameters": [ { "name": "subscription_id", "in": "path", "description": "The unique identifier of a subscription.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "PAUSE SUBSCRIPTION": { "value": { "id": "7304911d-5df9-429e-8488-ad41abea1a4c", "name": "sub_001", "description": "streaming service", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "merchant_reference": "001_marzo_23", "status": "PAUSED", "subscription_plan_id": "1904911d-5df9-429e-8488-ad41abea1a4d", "amount": { "currency": "USD", "value": 12100 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 10, "current": 2, "next_at": "2023-02-16T20:00:00.786342Z" }, "customer_payer": { "id": "3t04911d-5df9-429e-8488-ad41abea1a2c" }, "payment_method": [ { "type": "CARD", "token": "9104911d-5df9-429e-8488-ad41abea1a4b", "vaulted_token": "6104911d-5df9-429e-8488-ad41abea1a4b", "card": { "verify": false, "card_data": { "number": "4507990000000010", "expiration_month": 10, "expiration_year": 2025, "security_code": 123, "holder_name": "JOHN DOE" } } } ], "availability": { "start_at": "2024-01-16T00:00:00.786342Z", "finish_at": "2024-05-26T20:00:00.786342Z" }, "metadata": { "key": "sub_ext_id", "value": "AA001" }, "payments": [ "5104911d-5df9-229e-8468-bd41abea1a4s" ], "created_at": "2023-12-16T20:46:54.786342Z", "updated_at": "2023-12-16T21:00:54.786342Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "7304911d-5df9-429e-8488-ad41abea1a4c" }, "name": { "type": "string", "example": "sub_001" }, "description": { "type": "string", "example": "streaming service" }, "account_id": { "type": "string", "example": "2404911d-5df9-429e-8488-ad41abea1a4b" }, "merchant_reference": { "type": "string", "example": "001_marzo_23" }, "status": { "type": "string", "example": "PAUSED" }, "subscription_plan_id": { "type": "string", "example": "1904911d-5df9-429e-8488-ad41abea1a4d" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 12100, "default": 0 } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "example": "MONTH" }, "value": { "type": "integer", "example": 1, "default": 0 } } }, "billing_cycles": { "type": "object", "properties": { "total": { "type": "integer", "example": 10, "default": 0 }, "current": { "type": "integer", "example": 2, "default": 0 }, "next_at": { "type": "string", "example": "2023-02-16T20:00:00.786342Z" } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "3t04911d-5df9-429e-8488-ad41abea1a2c" } } }, "payment_method": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "CARD" }, "token": { "type": "string", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "vaulted_token": { "type": "string", "example": "6104911d-5df9-429e-8488-ad41abea1a4b" }, "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "card_data": { "type": "object", "properties": { "number": { "type": "string", "example": "4507990000000010" }, "expiration_month": { "type": "integer", "example": 10, "default": 0 }, "expiration_year": { "type": "integer", "example": 2025, "default": 0 }, "security_code": { "type": "integer", "example": 123, "default": 0 }, "holder_name": { "type": "string", "example": "JOHN DOE" } } } } } } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2024-01-16T00:00:00.786342Z" }, "finish_at": { "type": "string", "example": "2024-05-26T20:00:00.786342Z" } } }, "metadata": { "type": "object", "properties": { "key": { "type": "string", "example": "sub_ext_id" }, "value": { "type": "string", "example": "AA001" } } }, "payments": { "type": "array", "items": { "type": "string", "example": "5104911d-5df9-229e-8468-bd41abea1a4s" } }, "created_at": { "type": "string", "example": "2023-12-16T20:46:54.786342Z" }, "updated_at": { "type": "string", "example": "2023-12-16T21:00:54.786342Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_STATE", "messages": [ "The subscription state does not support the action requested." ] } } } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] } }, "/subscriptions/{subscription_id}/payments": { "get": { "summary": "List Subscription Payments", "description": "Returns the charge history for a subscription — one row per billing attempt, including plan/phase context when the subscription is linked to a plan. This is a net-new endpoint (there was no payments subresource before Plans), so it ships as a single, clean shape with no legacy fields to carry.", "operationId": "list-subscription-payments", "parameters": [ { "name": "subscription_id", "in": "path", "description": "The unique identifier of the subscription.", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "description": "Max items to return. 1-100, defaults to 20.", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "description": "Number of items to skip. Must be a non-negative multiple of `limit`, else `400 BAD_REQUEST` — a non-aligned offset would re-serve rows you already saw and corrupt `has_more`. Defaults to 0.", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": [ { "id": "00000000-0000-4000-8000-000000000010", "payment_id": "00000000-0000-4000-8000-000000000011", "idempotency_key": null, "status": "SUCCEEDED", "sub_status": null, "provider": "PROVIDER_TEST", "payment_method": { "id": "00000000-0000-4000-8000-000000000012", "type": "CARD" }, "amount": { "currency": "USD", "value": 9.99 }, "currency": "USD", "subtotal": 9.99, "total": 9.99, "plan_id": "00000000-0000-4000-8000-000000000001", "line_items": [ { "type": "PLAN", "label": "Intro", "service_period": { "start": "2024-04-01T09:00:00Z", "end": "2024-05-01T09:00:00Z" }, "amount": { "currency": "USD", "value": 9.99 } } ], "phase": { "index": 1, "name": "Intro", "type": "TRIAL" }, "phase_payment": 1, "billing_cycle": null, "retry": { "count": 0, "forced": false }, "trace_id": null, "created_at": "2024-04-01T09:00:00.000000Z", "updated_at": "2024-04-01T09:00:00.000000Z" } ], "pagination": { "total": 1, "limit": 20, "offset": 0, "has_more": false } } } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "Every payment attempt for this subscription, most recent first.", "items": { "type": "object", "properties": { "id": { "type": "string" }, "payment_id": { "type": "string" }, "idempotency_key": { "type": "string" }, "status": { "type": "string", "description": "Platform vocabulary: SUCCEEDED, DECLINED, REJECTED, ERROR, PENDING, CREATED, CANCELED — not the engine's internal EXECUTED." }, "sub_status": { "type": "string" }, "provider": { "type": "string", "description": "null for $0 cycles, the starter row, and rows charged before the provider-capture field existed." }, "payment_method": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } }, "currency": { "type": "string" }, "subtotal": { "type": "number" }, "total": { "type": "number" }, "plan_id": { "type": "string", "description": "null for raw (non-plan) subscriptions." }, "line_items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "string" }, "service_period": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } } }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number" } } } } } }, "phase": { "type": "object", "description": "null for the starter row and for legacy (non-plan) rows.", "properties": { "index": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "phase_payment": { "type": "integer", "description": "1..N within the current phase. null on the starter row." }, "billing_cycle": { "type": "integer", "description": "0 = starter row, null = TRIAL-phase rows, 1.. from the first REGULAR-phase payment." }, "retry": { "type": "object", "properties": { "count": { "type": "integer" }, "forced": { "type": "boolean" } } }, "trace_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" } } } } } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] } }, "/subscriptions/{subscription_id}/plan": { "post": { "summary": "Change Subscription Plan", "description": "Moves a subscription onto a subscription plan.\n\nIf the subscription is not on a plan yet, it is attached in place and keeps its `id`. If it is already on a plan, it is canceled and replaced by a **new** subscription on the target plan; the response is the replacement, and its `previous_subscription_id` points at the subscription it replaced.\n\nIn both cases the change takes effect at the subscription's **next renewal** — no charge is made now and nothing is prorated or refunded.", "operationId": "change-subscription-plan", "parameters": [ { "name": "subscription_id", "in": "path", "description": "The unique identifier of a subscription.", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "plan_id" ], "properties": { "plan_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the plan to move the subscription onto.", "examples": [ "1904911d-5df9-429e-8488-ad41abea1a4d" ] }, "skip_trial": { "type": "boolean", "default": false, "description": "Plan-to-plan changes only. When `true`, the replacement subscription does not adopt the target plan's trial or intro phases: it bills that plan's regular price from its first charge and its status stays `ACTIVE` instead of becoming `TRIALING`. Use it to stop subscribers from earning a fresh trial by switching plans. Sending `true` on a subscription that is not on a plan returns `400`; `false` and an omitted flag are equivalent and always accepted.", "examples": [ true ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Default (adopts the target plan's trial)": { "value": { "id": "8f11a2b0-6c1d-4a77-9f3e-2b5c8d0e91aa", "name": "sub_001", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "country": "US", "description": "streaming service", "merchant_reference": "001_marzo_23", "status": "TRIALING", "amount": { "currency": "USD", "value": 12100 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 8, "current": 1, "next_at": "2024-01-16T20:46:54.786342Z" }, "customer_payer": { "id": "3t04911d-5df9-429e-8488-ad41abea1a2c" }, "payment_method": { "type": "CARD", "vaulted_token": "6104911d-5df9-429e-8488-ad41abea1a4b", "card": { "installments": null, "network_transaction_id": null, "usage": "FIRST" } }, "availability": { "start_at": "2024-01-16T20:46:54.786342Z", "finish_at": null }, "retries": { "retry_on_decline": false, "amount": 6, "strategy": "DEFAULT", "schedule": null, "stop_on_hard_decline": null, "cancel_on_exhausted_retries": null }, "metadata": [ { "key": "sub_ext_id", "value": "AA001" } ], "additional_data": null, "trial_period": null, "initial_payment_validation": false, "reason": null, "subscription_agreement_id": null, "soft_descriptor": null, "renewal_notification_days": null, "cancellation_time": null, "cancellation_source": null, "ending_time": null, "created_at": "2023-12-16T20:46:54.786342Z", "updated_at": "2023-12-16T20:46:54.786342Z", "plan_id": "1904911d-5df9-429e-8488-ad41abea1a4d", "plan_assigned_at": "2023-12-16T20:46:54.786342Z", "previous_subscription_id": "7304911d-5df9-429e-8488-ad41abea1a4c", "phases": [ { "order": 1, "name": "Intro", "type": "TRIAL", "duration": { "type": "MONTH", "value": 2 }, "frequency": { "type": "MONTH", "value": 1 }, "amount": { "value": 5000, "currency": "USD" }, "total_payments": 2, "country_prices": [] }, { "order": 2, "name": "Regular", "type": "REGULAR", "duration": null, "frequency": null, "amount": null, "total_payments": null, "country_prices": [] } ], "current_phase": "TRIAL", "billing_phases": [ { "order": 1, "type": "TRIAL", "name": "Intro", "amount": { "value": 5000, "currency": "USD" }, "frequency": { "type": "MONTH", "value": 1 }, "start_cycle": 1, "end_cycle": 2 } ], "pending_plan_change": null } }, "skip_trial: true": { "value": { "id": "9c2d4e6f-1a3b-4c5d-8e7f-0a1b2c3d4e5f", "name": "sub_001", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "country": "US", "description": "streaming service", "merchant_reference": "001_marzo_23", "status": "ACTIVE", "amount": { "currency": "USD", "value": 12100 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 8, "current": 1, "next_at": "2024-01-16T20:46:54.786342Z" }, "customer_payer": { "id": "3t04911d-5df9-429e-8488-ad41abea1a2c" }, "payment_method": { "type": "CARD", "vaulted_token": "6104911d-5df9-429e-8488-ad41abea1a4b", "card": { "installments": null, "network_transaction_id": null, "usage": "FIRST" } }, "availability": { "start_at": "2024-01-16T20:46:54.786342Z", "finish_at": null }, "retries": { "retry_on_decline": false, "amount": 6, "strategy": "DEFAULT", "schedule": null, "stop_on_hard_decline": null, "cancel_on_exhausted_retries": null }, "metadata": [ { "key": "sub_ext_id", "value": "AA001" } ], "additional_data": null, "trial_period": null, "initial_payment_validation": false, "reason": null, "subscription_agreement_id": null, "soft_descriptor": null, "renewal_notification_days": null, "cancellation_time": null, "cancellation_source": null, "ending_time": null, "created_at": "2023-12-16T20:46:54.786342Z", "updated_at": "2023-12-16T20:46:54.786342Z", "plan_id": "1904911d-5df9-429e-8488-ad41abea1a4d", "plan_assigned_at": "2023-12-16T20:46:54.786342Z", "previous_subscription_id": "7304911d-5df9-429e-8488-ad41abea1a4c", "phases": [ { "order": 1, "name": "Intro", "type": "TRIAL", "duration": { "type": "MONTH", "value": 2 }, "frequency": { "type": "MONTH", "value": 1 }, "amount": { "value": 5000, "currency": "USD" }, "total_payments": 2, "country_prices": [] }, { "order": 2, "name": "Regular", "type": "REGULAR", "duration": null, "frequency": null, "amount": null, "total_payments": null, "country_prices": [] } ], "pending_plan_change": null } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_STATE", "messages": [ "The subscription status does not support plan changes." ] } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": { "code": "PLAN_NOT_FOUND", "messages": [ "The target plan does not exist or is not linked to this account." ] } } } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] } }, "/subscriptions/{subscription_id}/resume": { "post": { "summary": "Resume Subscription", "description": "", "operationId": "resume-subscription", "parameters": [ { "name": "subscription_id", "in": "path", "description": "The unique identifier of a subscription.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "RESUME SUBSCRIPTION": { "value": { "id": "7304911d-5df9-429e-8488-ad41abea1a4c", "name": "sub_001", "description": "streaming service", "account_id": "2404911d-5df9-429e-8488-ad41abea1a4b", "merchant_reference": "001_marzo_23", "status": "ACTIVE", "subscription_plan_id": "1904911d-5df9-429e-8488-ad41abea1a4d", "amount": { "currency": "USD", "value": 12100 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 10, "current": 2, "next_at": "2023-02-16T20:00:00.786342Z" }, "customer_payer": { "id": "3t04911d-5df9-429e-8488-ad41abea1a2c" }, "payment_method": [ { "type": "CARD", "token": "9104911d-5df9-429e-8488-ad41abea1a4b", "vaulted_token": "6104911d-5df9-429e-8488-ad41abea1a4b", "card": { "verify": false, "card_data": { "number": "4507990000000010", "expiration_month": 10, "expiration_year": 2025, "security_code": 123, "holder_name": "JOHN DOE" } } } ], "availability": { "start_at": "2024-01-16T00:00:00.786342Z", "finish_at": "2024-05-26T20:00:00.786342Z" }, "metadata": { "key": "sub_ext_id", "value": "AA001" }, "payments": [ "5104911d-5df9-229e-8468-bd41abea1a4s" ], "created_at": "2023-12-16T20:46:54.786342Z", "updated_at": "2023-12-16T21:00:54.786342Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "7304911d-5df9-429e-8488-ad41abea1a4c" }, "name": { "type": "string", "example": "sub_001" }, "description": { "type": "string", "example": "streaming service" }, "account_id": { "type": "string", "example": "2404911d-5df9-429e-8488-ad41abea1a4b" }, "merchant_reference": { "type": "string", "example": "001_marzo_23" }, "status": { "type": "string", "example": "ACTIVE" }, "subscription_plan_id": { "type": "string", "example": "1904911d-5df9-429e-8488-ad41abea1a4d" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" }, "value": { "type": "integer", "example": 12100, "default": 0 } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "example": "MONTH" }, "value": { "type": "integer", "example": 1, "default": 0 } } }, "billing_cycles": { "type": "object", "properties": { "total": { "type": "integer", "example": 10, "default": 0 }, "current": { "type": "integer", "example": 2, "default": 0 }, "next_at": { "type": "string", "example": "2023-02-16T20:00:00.786342Z" } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "3t04911d-5df9-429e-8488-ad41abea1a2c" } } }, "payment_method": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "CARD" }, "token": { "type": "string", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "vaulted_token": { "type": "string", "example": "6104911d-5df9-429e-8488-ad41abea1a4b" }, "card": { "type": "object", "properties": { "verify": { "type": "boolean", "example": false, "default": true }, "card_data": { "type": "object", "properties": { "number": { "type": "string", "example": "4507990000000010" }, "expiration_month": { "type": "integer", "example": 10, "default": 0 }, "expiration_year": { "type": "integer", "example": 2025, "default": 0 }, "security_code": { "type": "integer", "example": 123, "default": 0 }, "holder_name": { "type": "string", "example": "JOHN DOE" } } } } } } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2024-01-16T00:00:00.786342Z" }, "finish_at": { "type": "string", "example": "2024-05-26T20:00:00.786342Z" } } }, "metadata": { "type": "object", "properties": { "key": { "type": "string", "example": "sub_ext_id" }, "value": { "type": "string", "example": "AA001" } } }, "payments": { "type": "array", "items": { "type": "string", "example": "5104911d-5df9-229e-8468-bd41abea1a4s" } }, "created_at": { "type": "string", "example": "2023-12-16T20:46:54.786342Z" }, "updated_at": { "type": "string", "example": "2023-12-16T21:00:54.786342Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_DATE", "messages": [ "The subscription can not be resumed due to a conflict with the availability dates. Please update availability dates and try again if you want to keep using the subscription." ] } } } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] } }, "/subscriptions/{id}/retry": { "post": { "summary": "Retry Subscription", "description": "", "operationId": "retry-subscription", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the subscription, see [create subscription](/reference/create-subscription) (UUID).", "schema": { "type": "string" }, "required": true }, { "in": "header", "name": "x-account-code", "schema": { "type": "string" }, "description": "The `account_id` found in your [Yuno Dashboard](https://dashboard.y.uno/developers) (UUID)." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "0054840f-bcd5-4d8e-b86c-c18ede81c556", "name": "Test Subscription", "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c", "country": "CL", "description": "Subscription Test", "merchant_reference": "subscription-ref-merchant-AA01", "status": "ACTIVE", "amount": { "currency": "CLP", "value": 15000 }, "frequency": { "type": "MONTH", "value": 1 }, "billing_cycles": { "total": 12, "current": 2, "next_at": "2025-05-29T11:13:31.786421Z" }, "customer_payer": { "id": "1c6d1a88-d8d5-4c09-b19c-852530d89f05" }, "payment_method": { "type": "CARD", "vaulted_token": "743880c1-1bdb-4572-99a8-c4e5ce184895" }, "availability": { "start_at": "2025-04-29T11:13:31.786421Z", "finish_at": null }, "retries": { "retry_on_decline": false, "amount": 6 }, "metadata": null, "additional_data": null, "trial_period": { "billing_cycles": 1, "amount": { "value": 0, "currency": "" } }, "initial_payment_validation": false, "created_at": "2025-04-29T11:13:31.786421Z", "updated_at": "2025-04-29T11:13:31.942325Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "0054840f-bcd5-4d8e-b86c-c18ede81c556" }, "name": { "type": "string", "example": "Test Subscription" }, "account_id": { "type": "string", "example": "f7c5fe77-721b-49c2-84d3-957748df3c2c" }, "country": { "type": "string", "example": "CL" }, "description": { "type": "string", "example": "Subscription Test" }, "merchant_reference": { "type": "string", "example": "subscription-ref-merchant-AA01" }, "status": { "type": "string", "example": "ACTIVE" }, "amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "CLP" }, "value": { "type": "integer", "example": 15000, "default": 0 } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "example": "MONTH" }, "value": { "type": "integer", "example": 1, "default": 0 } } }, "billing_cycles": { "type": "object", "properties": { "total": { "type": "integer", "example": 12, "default": 0 }, "current": { "type": "integer", "example": 2, "default": 0 }, "next_at": { "type": "string", "example": "2025-05-29T11:13:31.786421Z" } } }, "customer_payer": { "type": "object", "properties": { "id": { "type": "string", "example": "1c6d1a88-d8d5-4c09-b19c-852530d89f05" } } }, "payment_method": { "type": "object", "properties": { "type": { "type": "string", "example": "CARD" }, "vaulted_token": { "type": "string", "example": "743880c1-1bdb-4572-99a8-c4e5ce184895" } } }, "availability": { "type": "object", "properties": { "start_at": { "type": "string", "example": "2025-04-29T11:13:31.786421Z" }, "finish_at": {} } }, "retries": { "type": "object", "properties": { "retry_on_decline": { "type": "boolean", "example": false, "default": true }, "amount": { "type": "integer", "example": 6, "default": 0 } } }, "metadata": {}, "additional_data": {}, "trial_period": { "type": "object", "properties": { "billing_cycles": { "type": "integer", "example": 1, "default": 0 }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "string", "example": "" } } } } }, "initial_payment_validation": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2025-04-29T11:13:31.786421Z" }, "updated_at": { "type": "string", "example": "2025-04-29T11:13:31.942325Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "code": "INVALID_STATE", "messages": [ "The last payment intent of the subscription does not support the action requested." ] } } }, "schema": { "oneOf": [ { "type": "object", "properties": {} }, { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_STATE" }, "messages": { "type": "array", "items": { "type": "string", "example": "The last payment intent of the subscription does not support the action requested." } } } } ] } } } } }, "deprecated": false, "tags": [ "Subscriptions" ] } }, "/three-d-secure/setups": { "post": { "summary": "Create 3DS2 Setup", "description": "Register the 3D Secure 2 setup data your integration has collected — the cardholder's browser environment and any pre-computed device fingerprints — and receive a `three_d_secure_setup_id` to reference on the subsequent `POST /v1/payments`.", "operationId": "create-three-d-secure-setup", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "type", "browser_info" ], "properties": { "account_id": { "type": "string", "format": "uuid", "description": "Account UUID that owns this 3DS2 setup." }, "type": { "type": "string", "description": "Source of the device data. `MERCHANT_PROVIDED` means you collected the browser/device data on your side and are passing it in directly.", "enum": [ "MERCHANT_PROVIDED" ] }, "browser_info": { "type": "object", "description": "Browser environment captured from the cardholder's session. Forwarded verbatim to the 3DS2 server for risk scoring and frictionless decisioning.", "required": [ "user_agent", "accept_header", "color_depth", "screen_height", "screen_width", "language" ], "properties": { "user_agent": { "type": "string", "description": "`navigator.userAgent` of the cardholder's browser." }, "accept_header": { "type": "string", "description": "Value of the `Accept` HTTP header sent by the browser." }, "color_depth": { "type": "string", "description": "`screen.colorDepth`, e.g. `\"24\"`." }, "screen_height": { "type": "string", "description": "`screen.height` in pixels." }, "screen_width": { "type": "string", "description": "`screen.width` in pixels." }, "language": { "type": "string", "description": "BCP-47 language tag from `navigator.language`, e.g. `\"es-CO\"`." }, "javascript_enabled": { "type": "boolean", "description": "Whether JavaScript is enabled. Defaults to `true` when omitted." }, "java_enabled": { "type": "boolean", "description": "Whether the Java plugin is enabled. Almost always `false` on modern browsers." }, "browser_time_difference": { "type": "string", "description": "UTC offset of the browser in minutes, signed (e.g. `\"-300\"` for UTC-5). Equivalent to `new Date().getTimezoneOffset()`." }, "platform": { "type": "string", "description": "Channel that captured the data.", "enum": [ "WEB", "IOS", "ANDROID" ] }, "accept_content": { "type": "string", "description": "Optional `Accept-Encoding` value if you capture it." }, "accept_browser": { "type": "string", "description": "Optional `Accept-Language` value if you capture it." } } }, "device_fingerprints": { "type": "array", "description": "One or more provider-scoped device fingerprints already collected on your side. Yuno will not run device collection again for any `provider_id` you include here.", "items": { "type": "object", "required": [ "provider_id", "id" ], "properties": { "provider_id": { "type": "string", "format": "uuid", "description": "UUID of the fraud or device-intelligence connection in your Yuno account that produced this fingerprint. Find it in **Dashboard → Connections** or via `GET /v1/connections`." }, "id": { "type": "string", "description": "The fingerprint value as returned by that provider's collector." } } } } } }, "examples": { "With device fingerprints": { "value": { "account_id": "11111111-1111-1111-1111-111111111111", "type": "MERCHANT_PROVIDED", "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9", "color_depth": "24", "screen_height": "1080", "screen_width": "1920", "language": "es-CO", "javascript_enabled": true, "java_enabled": false, "browser_time_difference": "-300", "platform": "WEB" }, "device_fingerprints": [ { "provider_id": "f3a8b5d2-9c4e-4a7b-b1f8-2d6c9e0a4f12", "id": "fp_abc123xyz" } ] } }, "Without device fingerprints": { "value": { "account_id": "11111111-1111-1111-1111-111111111111", "type": "MERCHANT_PROVIDED", "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9", "color_depth": "24", "screen_height": "1080", "screen_width": "1920", "language": "es-CO", "javascript_enabled": true, "java_enabled": false, "browser_time_difference": "-300", "platform": "WEB" } } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "With device fingerprints": { "value": { "three_d_secure_setup_id": "a17b4f2c-08d1-4e9b-b6c5-9a3e0c7f1b22", "account_id": "11111111-1111-1111-1111-111111111111", "type": "MERCHANT_PROVIDED", "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9", "color_depth": "24", "screen_height": "1080", "screen_width": "1920", "language": "es-CO", "javascript_enabled": true, "java_enabled": false, "browser_time_difference": "-300", "platform": "WEB" }, "device_fingerprints": [ { "provider_id": "f3a8b5d2-9c4e-4a7b-b1f8-2d6c9e0a4f12", "id": "fp_abc123xyz" } ] } } }, "schema": { "type": "object", "properties": { "three_d_secure_setup_id": { "type": "string", "description": "Generated identifier of the 3DS2 setup. Pass this under `payment_method.detail.card.three_d_secure.three_d_secure_setup_id` on the subsequent `POST /v1/payments`.", "example": "a17b4f2c-08d1-4e9b-b6c5-9a3e0c7f1b22" }, "account_id": { "type": "string", "description": "Echo of the request `account_id`.", "example": "11111111-1111-1111-1111-111111111111" }, "type": { "type": "string", "description": "Echo of the request `type`.", "example": "MERCHANT_PROVIDED" }, "browser_info": { "type": "object", "description": "Echo of the request `browser_info`.", "properties": { "user_agent": { "type": "string", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36" }, "accept_header": { "type": "string", "example": "text/html,application/xhtml+xml,application/xml;q=0.9" }, "color_depth": { "type": "string", "example": "24" }, "screen_height": { "type": "string", "example": "1080" }, "screen_width": { "type": "string", "example": "1920" }, "language": { "type": "string", "example": "es-CO" }, "javascript_enabled": { "type": "boolean", "example": true }, "java_enabled": { "type": "boolean", "example": false }, "browser_time_difference": { "type": "string", "example": "-300" }, "platform": { "type": "string", "example": "WEB" } } }, "device_fingerprints": { "type": "array", "description": "Echo of the request `device_fingerprints`.", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "example": "f3a8b5d2-9c4e-4a7b-b1f8-2d6c9e0a4f12" }, "id": { "type": "string", "example": "fp_abc123xyz" } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid parameters": { "value": { "code": "INVALID_PARAMETERS", "messages": [ "account_id must be a valid UUIDv4" ], "httpCode": 400 } }, "Missing parameters": { "value": { "code": "MISSING_PARAMETERS", "messages": [ "account_id is required" ], "httpCode": 400 } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_PARAMETERS" }, "messages": { "type": "array", "items": { "type": "string", "example": "account_id must be a valid UUIDv4" } }, "httpCode": { "type": "integer", "example": 400 } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Missing API credentials" ], "httpCode": 401 } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "NOT_AUTHENTICATED" }, "messages": { "type": "array", "items": { "type": "string", "example": "Missing API credentials" } }, "httpCode": { "type": "integer", "example": 401 } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": { "code": "FORBIDDEN", "messages": [ "Account inactive or lacks 3DS2 entitlement" ], "httpCode": 403 } } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "FORBIDDEN" }, "messages": { "type": "array", "items": { "type": "string", "example": "Account inactive or lacks 3DS2 entitlement" } }, "httpCode": { "type": "integer", "example": 403 } } } } } } }, "deprecated": false, "tags": [ "Three D Secure Setups" ], "security": [ { "PublicApiKey": [], "PrivateSecretKey": [], "IdempotencyKey": [] } ] } }, "/transfers/{transfer_id}": { "get": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": "550e8400-e29b-41d4-a716-446655440000", "origin_onboarding": { "id": "660e8400-e29b-41d4-a716-446655440001", "status": "TRANSFERRED", "type": "ONE_STEP_ONBOARDING", "workflow": "DIRECT", "response_message": null, "provider": { "id": "STRIPE", "recipient_id": "acct_1234567890", "connection_id": "880e8400-e29b-41d4-a716-446655440003", "legal_entity": "COMPANY" }, "documentation": [], "legal_representatives": [], "requirements": [], "metadata": [], "withdrawal_methods": null, "capabilities": null, "recipient": { "id": "770e8400-e29b-41d4-a716-446655440002", "merchant_recipient_id": "seller-123", "country": "BR", "national_entity": "INDIVIDUAL", "entity_type": "PERSON", "email": "seller@example.com", "first_name": "João", "last_name": "Silva", "created_at": "2026-01-10T12:00:00Z", "updated_at": "2026-01-10T12:00:00Z" }, "created_at": "2026-01-15T10:00:00Z", "updated_at": "2026-01-15T16:59:22Z" }, "destination_onboarding": { "id": "990e8400-e29b-41d4-a716-446655440004", "status": "SUCCEEDED", "type": "ONE_STEP_ONBOARDING", "workflow": "DIRECT", "response_message": null, "provider": { "id": "STRIPE", "recipient_id": "acct_0987654321", "connection_id": "880e8400-e29b-41d4-a716-446655440003", "legal_entity": "COMPANY" }, "documentation": [], "legal_representatives": [], "requirements": [], "metadata": [], "withdrawal_methods": null, "capabilities": null, "recipient": { "id": "aa0e8400-e29b-41d4-a716-446655440005", "merchant_recipient_id": "seller-456", "country": "BR", "national_entity": "INDIVIDUAL", "entity_type": "PERSON", "email": "newseller@example.com", "first_name": "Maria", "last_name": "Santos", "created_at": "2026-01-12T14:00:00Z", "updated_at": "2026-01-12T14:00:00Z" }, "created_at": "2026-01-15T16:59:22Z", "updated_at": "2026-01-15T16:59:23Z" }, "created_at": "2026-01-15T16:59:22.996009Z", "updated_at": "2026-01-15T16:59:23.734739Z" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "origin_onboarding": { "type": "object", "properties": { "id": { "type": "string", "example": "660e8400-e29b-41d4-a716-446655440001" }, "status": { "type": "string", "example": "TRANSFERRED" }, "type": { "type": "string", "example": "ONE_STEP_ONBOARDING" }, "workflow": { "type": "string", "example": "DIRECT" }, "response_message": {}, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "STRIPE" }, "recipient_id": { "type": "string", "example": "acct_1234567890" }, "connection_id": { "type": "string", "example": "880e8400-e29b-41d4-a716-446655440003" }, "legal_entity": { "type": "string", "example": "COMPANY" } } }, "documentation": { "type": "array", "items": { "type": "object", "properties": {} } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": {} } }, "requirements": { "type": "array", "items": { "type": "object", "properties": {} } }, "metadata": { "type": "array", "items": { "type": "object", "properties": {} } }, "withdrawal_methods": {}, "capabilities": {}, "recipient": { "type": "object", "properties": { "id": { "type": "string", "example": "770e8400-e29b-41d4-a716-446655440002" }, "merchant_recipient_id": { "type": "string", "example": "seller-123" }, "country": { "type": "string", "example": "BR" }, "national_entity": { "type": "string", "example": "INDIVIDUAL" }, "entity_type": { "type": "string", "example": "PERSON" }, "email": { "type": "string", "example": "seller@example.com" }, "first_name": { "type": "string", "example": "João" }, "last_name": { "type": "string", "example": "Silva" }, "created_at": { "type": "string", "example": "2026-01-10T12:00:00Z" }, "updated_at": { "type": "string", "example": "2026-01-10T12:00:00Z" } } }, "created_at": { "type": "string", "example": "2026-01-15T10:00:00Z" }, "updated_at": { "type": "string", "example": "2026-01-15T16:59:22Z" } } }, "destination_onboarding": { "type": "object", "properties": { "id": { "type": "string", "example": "990e8400-e29b-41d4-a716-446655440004" }, "status": { "type": "string", "example": "SUCCEEDED" }, "type": { "type": "string", "example": "ONE_STEP_ONBOARDING" }, "workflow": { "type": "string", "example": "DIRECT" }, "response_message": {}, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "STRIPE" }, "recipient_id": { "type": "string", "example": "acct_0987654321" }, "connection_id": { "type": "string", "example": "880e8400-e29b-41d4-a716-446655440003" }, "legal_entity": { "type": "string", "example": "COMPANY" } } }, "documentation": { "type": "array", "items": { "type": "object", "properties": {} } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": {} } }, "requirements": { "type": "array", "items": { "type": "object", "properties": {} } }, "metadata": { "type": "array", "items": { "type": "object", "properties": {} } }, "withdrawal_methods": {}, "capabilities": {}, "recipient": { "type": "object", "properties": { "id": { "type": "string", "example": "aa0e8400-e29b-41d4-a716-446655440005" }, "merchant_recipient_id": { "type": "string", "example": "seller-456" }, "country": { "type": "string", "example": "BR" }, "national_entity": { "type": "string", "example": "INDIVIDUAL" }, "entity_type": { "type": "string", "example": "PERSON" }, "email": { "type": "string", "example": "newseller@example.com" }, "first_name": { "type": "string", "example": "Maria" }, "last_name": { "type": "string", "example": "Santos" }, "created_at": { "type": "string", "example": "2026-01-12T14:00:00Z" }, "updated_at": { "type": "string", "example": "2026-01-12T14:00:00Z" } } }, "created_at": { "type": "string", "example": "2026-01-15T16:59:22Z" }, "updated_at": { "type": "string", "example": "2026-01-15T16:59:23Z" } } }, "created_at": { "type": "string", "example": "2026-01-15T16:59:22.996009Z" }, "updated_at": { "type": "string", "example": "2026-01-15T16:59:23.734739Z" } } } } } }, "401": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "UNAUTHORIZED" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid authentication credentials." } } } }, "examples": { "Unauthorized: Invalid authentication": { "summary": "Unauthorized: Invalid authentication", "value": { "code": "UNAUTHORIZED", "messages": [ "Invalid authentication credentials." ] } } } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "FORBIDDEN" }, "messages": { "type": "array", "items": { "type": "string", "example": "You do not have permission to access this resource." } } } }, "examples": { "Forbidden: Transfer belongs to different organization": { "summary": "Forbidden: Transfer belongs to different organization", "value": { "code": "FORBIDDEN", "messages": [ "You do not have permission to access this resource." ] } } } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "TRANSFER_NOT_FOUND" }, "messages": { "type": "array", "items": { "type": "string", "example": "Transfer not found." } } } }, "examples": { "Not Found: Transfer does not exist": { "summary": "Not Found: Transfer does not exist", "value": { "code": "TRANSFER_NOT_FOUND", "messages": [ "Transfer not found." ] } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "transfer_id", "schema": { "type": "string" }, "required": true, "description": "The transfer `id` returned from the [transfer onboarding](/reference/transfer-onboarding) endpoint (UUID)." }, { "in": "header", "name": "x-account-code", "schema": { "type": "string" }, "description": "The `account_id` found in your [Yuno Dashboard](https://dashboard.y.uno/developers) (UUID)." } ], "operationId": "get_transfers-transfer-id", "tags": [ "Recipients For Marketplace" ] } }, "/webhooks": { "get": { "summary": "List Webhooks", "description": "Returns the webhooks configured on an account, with their secrets masked. Filter by `state` to list only the active or the inactive ones.", "operationId": "list-webhooks", "parameters": [ { "name": "account_id", "in": "query", "required": true, "description": "The unique identifier of the account the webhooks belong to.", "schema": { "type": "string", "format": "uuid", "example": "493e9374-510a-4201-9e09-de669d75f256", "x-default": "493e9374-510a-4201-9e09-de669d75f256" } }, { "name": "state", "in": "query", "required": false, "description": "Return only the webhooks in this state. Omit it to return all of them.", "schema": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "example": "ACTIVE" } } ], "responses": { "200": { "description": "The webhooks configured on the account, or an empty array if it has none.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "example": [ { "id": "12345", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Production payments listener", "state": "ACTIVE", "url": "https://api.acme.com/yuno/webhooks", "api_key": "***", "secret": "***", "hmac_client_secret": "***", "oauth2_authentication_url": null, "oauth2_client_secret": null, "oauth2_client_id": null, "oauth2_grant_type": null, "oauth2_scope": null, "oauth2_authorization_name": null, "oauth2_include_client_id": false, "enrollment_triggers": [], "payment_triggers": [ "AUTHORIZE", "CAPTURE", "REFUND" ], "report_triggers": [], "subscription_triggers": null, "onboarding_triggers": null, "renewal_days": null, "created_at": "2026-07-09T13:05:36.482913Z", "updated_at": "2026-07-09T13:05:36.482913Z" }, { "id": "12346", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Subscription renewals", "state": "INACTIVE", "url": "https://api.acme.com/yuno/subscriptions", "api_key": "***", "secret": "***", "hmac_client_secret": null, "oauth2_authentication_url": null, "oauth2_client_secret": null, "oauth2_client_id": null, "oauth2_grant_type": null, "oauth2_scope": null, "oauth2_authorization_name": null, "oauth2_include_client_id": false, "enrollment_triggers": [], "payment_triggers": [], "report_triggers": [], "subscription_triggers": [ "CREATE", "CLOSE_TO_RENEWAL" ], "onboarding_triggers": null, "renewal_days": 5, "created_at": "2026-07-10T09:41:12.204518Z", "updated_at": "2026-07-11T16:20:44.918330Z" } ] } } }, "400": { "$ref": "#/components/responses/InvalidListRequest" }, "401": { "$ref": "#/components/responses/Unauthorized_3" }, "502": { "$ref": "#/components/responses/UpstreamError" } }, "tags": [ "Webhooks" ] }, "post": { "summary": "Create a Webhook", "description": "Creates a webhook in active state, subscribed to the events you select. It requires at least one trigger, and starts receiving notifications immediately.", "operationId": "create-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreateInput" }, "example": { "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Production payments listener", "url": "https://api.acme.com/yuno/webhooks", "api_key": "my-webhook-key", "secret": "my-webhook-secret", "hmac_client_secret": "my-hmac-secret", "enrollment_triggers": [ "ENROLL", "UNENROLL" ], "payment_triggers": [ "AUTHORIZE", "CAPTURE", "REFUND" ], "subscription_triggers": [ "CREATE", "CLOSE_TO_RENEWAL" ], "renewal_days": 5 } } } }, "responses": { "201": { "description": "The webhook you created. The secrets you configured come back masked, and the ones you left out come back as null.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" }, "example": { "id": "12345", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Production payments listener", "state": "ACTIVE", "url": "https://api.acme.com/yuno/webhooks", "api_key": "***", "secret": "***", "hmac_client_secret": "***", "oauth2_authentication_url": null, "oauth2_client_secret": null, "oauth2_client_id": null, "oauth2_grant_type": null, "oauth2_scope": null, "oauth2_authorization_name": null, "oauth2_include_client_id": false, "enrollment_triggers": [ "ENROLL", "UNENROLL" ], "payment_triggers": [ "AUTHORIZE", "CAPTURE", "REFUND" ], "report_triggers": [], "subscription_triggers": [ "CREATE", "CLOSE_TO_RENEWAL" ], "onboarding_triggers": null, "renewal_days": 5, "created_at": "2026-07-09T13:05:36.482913Z", "updated_at": "2026-07-09T13:05:36.482913Z" } } } }, "400": { "$ref": "#/components/responses/InvalidCreateRequest" }, "401": { "$ref": "#/components/responses/Unauthorized_3" }, "409": { "$ref": "#/components/responses/WebhookConflict" }, "502": { "$ref": "#/components/responses/UpstreamError" } }, "tags": [ "Webhooks" ] } }, "/webhooks/{webhook_id}": { "get": { "summary": "Retrieve a Webhook", "description": "Returns a webhook by its unique identifier, with its secrets masked.", "operationId": "retrieve-webhook", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "description": "The unique identifier of the webhook, as returned by [Create a Webhook](/reference/webhooks/create-webhook).", "schema": { "type": "string", "example": "12345" } }, { "name": "account_id", "in": "query", "required": true, "description": "The unique identifier of the account the webhook belongs to.", "schema": { "type": "string", "format": "uuid", "example": "493e9374-510a-4201-9e09-de669d75f256", "x-default": "493e9374-510a-4201-9e09-de669d75f256" } } ], "responses": { "200": { "description": "The webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" }, "example": { "id": "12345", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Production payments listener", "state": "ACTIVE", "url": "https://api.acme.com/yuno/webhooks", "api_key": "***", "secret": "***", "hmac_client_secret": "***", "oauth2_authentication_url": "https://api.acme.com/oauth/token", "oauth2_client_secret": "***", "oauth2_client_id": "acme_client_id", "oauth2_grant_type": "client_credentials", "oauth2_scope": "webhooks:write", "oauth2_authorization_name": "Authorization", "oauth2_include_client_id": true, "enrollment_triggers": [ "ENROLL", "UNENROLL" ], "payment_triggers": [ "AUTHORIZE", "CAPTURE", "REFUND" ], "report_triggers": [], "subscription_triggers": [ "CREATE", "CLOSE_TO_RENEWAL" ], "onboarding_triggers": null, "renewal_days": 5, "created_at": "2026-07-09T13:05:36.482913Z", "updated_at": "2026-07-11T16:20:44.918330Z" } } } }, "400": { "$ref": "#/components/responses/InvalidAccountRequest" }, "401": { "$ref": "#/components/responses/Unauthorized_3" }, "404": { "$ref": "#/components/responses/WebhookNotFound" }, "502": { "$ref": "#/components/responses/UpstreamError" } }, "tags": [ "Webhooks" ] }, "patch": { "summary": "Update a Webhook", "description": "Updates a webhook. Send only the fields you want to change, including the state and any rotated secret.", "operationId": "update-webhook", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "description": "The unique identifier of the webhook, as returned by [Create a Webhook](/reference/webhooks/create-webhook).", "schema": { "type": "string", "example": "12345" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpdateInput" }, "example": { "account_id": "493e9374-510a-4201-9e09-de669d75f256", "state": "INACTIVE", "secret": "my-rotated-secret" } } } }, "responses": { "200": { "description": "The updated webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" }, "example": { "id": "12345", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Production payments listener", "state": "INACTIVE", "url": "https://api.acme.com/yuno/webhooks", "api_key": "***", "secret": "***", "hmac_client_secret": "***", "oauth2_authentication_url": null, "oauth2_client_secret": null, "oauth2_client_id": null, "oauth2_grant_type": null, "oauth2_scope": null, "oauth2_authorization_name": null, "oauth2_include_client_id": false, "enrollment_triggers": [ "ENROLL", "UNENROLL" ], "payment_triggers": [ "AUTHORIZE", "CAPTURE", "REFUND" ], "report_triggers": [], "subscription_triggers": [ "CREATE", "CLOSE_TO_RENEWAL" ], "onboarding_triggers": null, "renewal_days": 5, "created_at": "2026-07-09T13:05:36.482913Z", "updated_at": "2026-07-11T16:20:44.918330Z" } } } }, "400": { "$ref": "#/components/responses/InvalidUpdateRequest" }, "401": { "$ref": "#/components/responses/Unauthorized_3" }, "404": { "$ref": "#/components/responses/WebhookNotFound" }, "409": { "$ref": "#/components/responses/WebhookConflict" }, "502": { "$ref": "#/components/responses/UpstreamError" } }, "tags": [ "Webhooks" ] }, "delete": { "summary": "Delete a Webhook", "description": "Deletes a webhook. Yuno stops sending notifications to its URL, and returns the webhook it deleted.", "operationId": "delete-webhook", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "description": "The unique identifier of the webhook, as returned by [List Webhooks](/reference/webhooks/list-webhooks).", "schema": { "type": "string", "example": "12345" } }, { "name": "account_id", "in": "query", "required": true, "description": "The unique identifier of the account the webhook belongs to.", "schema": { "type": "string", "format": "uuid", "example": "493e9374-510a-4201-9e09-de669d75f256", "x-default": "493e9374-510a-4201-9e09-de669d75f256" } } ], "responses": { "200": { "description": "The webhook you deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" }, "example": { "id": "12345", "account_id": "493e9374-510a-4201-9e09-de669d75f256", "name": "Production payments listener", "state": "ACTIVE", "url": "https://api.acme.com/yuno/webhooks", "api_key": "***", "secret": "***", "hmac_client_secret": "***", "oauth2_authentication_url": null, "oauth2_client_secret": null, "oauth2_client_id": null, "oauth2_grant_type": null, "oauth2_scope": null, "oauth2_authorization_name": null, "oauth2_include_client_id": false, "enrollment_triggers": [ "ENROLL", "UNENROLL" ], "payment_triggers": [ "AUTHORIZE", "CAPTURE", "REFUND" ], "report_triggers": [], "subscription_triggers": [ "CREATE", "CLOSE_TO_RENEWAL" ], "onboarding_triggers": null, "renewal_days": 5, "created_at": "2026-07-09T13:05:36.482913Z", "updated_at": "2026-07-09T13:05:36.482913Z" } } } }, "400": { "$ref": "#/components/responses/InvalidAccountRequest" }, "401": { "$ref": "#/components/responses/Unauthorized_3" }, "404": { "$ref": "#/components/responses/WebhookNotFound" }, "502": { "$ref": "#/components/responses/UpstreamError" } }, "tags": [ "Webhooks" ] } } }, "components": { "securitySchemes": { "AccountCode": { "type": "apiKey", "in": "header", "name": "X-Account-Code", "description": "Required only for organizations with multiple accounts. Identifies which account to use for the request." }, "IdempotencyKey": { "type": "apiKey", "in": "header", "name": "X-Idempotency-Key", "x-default": "" }, "PrivateSecretKey": { "type": "apiKey", "in": "header", "name": "private-secret-key", "description": "Private secret key (server-side only)" }, "PublicApiKey": { "type": "apiKey", "in": "header", "name": "public-api-key", "description": "Public API key from Dashboard > Settings > API Keys" }, "XPrivateSecretKey": { "type": "apiKey", "in": "header", "name": "X-Private-Secret-Key", "x-default": "X-Private-Secret-Key" }, "XPublicApiKey": { "type": "apiKey", "in": "header", "name": "X-Public-Api-Key", "x-default": "X-Public-Api-Key" } }, "schemas": { "Address": { "type": "object", "properties": { "line_1": { "type": "string" }, "line_2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "zip_code": { "type": "string" } } }, "Amount": { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "example": 150 }, "currency": { "type": "string", "example": "USD" } } }, "ApplePayDetail": { "type": "object", "properties": { "wallet": { "type": "object", "properties": { "provider": { "type": "object", "required": [ "id", "merchant_id", "payment_processing_key", "payment_processing_certificate", "merchant_identity_key", "merchant_identity_certificate", "merchant_identity_password" ], "properties": { "id": { "type": "string" }, "merchant_id": { "type": "string" }, "payment_processing_key": { "type": "string" }, "payment_processing_certificate": { "type": "string" }, "merchant_identity_key": { "type": "string" }, "merchant_identity_certificate": { "type": "string" }, "merchant_identity_password": { "type": "string" } } } } } } }, "BadRequestError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "INVALID_PARAMETERS", "BAD_REQUEST", "CUSTOMER_NOT_FOUND", "PAYMENT_METHOD_NOT_REASSIGNABLE" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } }, "CardDetail": { "type": "object", "properties": { "card": { "type": "object", "properties": { "provider": { "type": "object", "required": [ "id", "merchant_id" ], "properties": { "id": { "type": "string" }, "merchant_id": { "type": "string" } } } } } } }, "Cart": { "type": "object", "properties": { "total_value": { "type": "number", "format": "float", "description": "Total value of the cart.", "example": 149.99 }, "currency": { "type": "string", "description": "Currency code (e.g., \"COP\").", "example": "COP" }, "items": { "type": "array", "description": "List of items in the cart.", "items": { "$ref": "#/components/schemas/CartItem" } } } }, "CartItem": { "type": "object", "properties": { "name": { "type": "string", "description": "Item name.", "example": "Wireless Headphones" }, "sku": { "type": "string", "description": "Stock Keeping Unit identifier.", "example": "WH-1000XM5" }, "quantity": { "type": "integer", "description": "Number of units.", "example": 1 }, "price": { "type": "number", "format": "float", "description": "Price per unit.", "example": 149.99 } } }, "CheckoutMutationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Checkout identifier (UUID). Use it as the checkout_code in the fetch, publish, and lifecycle endpoints." }, "name": { "type": "string", "description": "Checkout name." }, "description": { "type": "string", "description": "Checkout description." }, "is_default": { "type": "boolean", "description": "Whether this checkout is the account's default. A newly created checkout is never the default." }, "is_active": { "type": "boolean", "description": "Whether the checkout is active (serving traffic)." }, "created_at": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO-8601)." } } }, "CheckoutMutationResponse_2": { "type": "object", "properties": { "id": { "type": "string", "description": "Checkout identifier (UUID)." }, "name": { "type": "string", "description": "Checkout name." }, "description": { "type": "string", "description": "Checkout description." }, "is_default": { "type": "boolean", "description": "Whether this checkout is the account's default." }, "is_active": { "type": "boolean", "description": "Whether the checkout is active (serving traffic)." }, "created_at": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO-8601)." } } }, "CheckoutSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "Checkout identifier (UUID). Use it as the checkout_code in the fetch and publish endpoints." }, "name": { "type": "string", "description": "Checkout name." }, "description": { "type": "string", "description": "Checkout description." }, "status": { "type": "string", "enum": [ "PUBLISHED", "NOT_PUBLISHED", "ARCHIVED" ], "description": "Checkout status." }, "is_default": { "type": "boolean", "description": "Whether this checkout is the account's default." }, "created_at": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO-8601)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO-8601)." } } }, "Customer": { "type": "object", "required": [ "full_name", "phone_number", "country_code" ], "properties": { "full_name": { "type": "string", "description": "Customer's full name.", "example": "Jane Doe" }, "phone_number": { "type": "string", "description": "Customer's phone number in E.164 format.", "example": "+573001234567" }, "email": { "type": "string", "format": "email", "description": "Customer's email address.", "example": "jane.doe@example.com" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code (e.g., \"CO\").", "example": "CO" }, "language": { "type": "string", "description": "Preferred language for communication (e.g., \"es\", \"en\").", "example": "es" } } }, "Destination": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the destination. Use it to remove the destination.", "example": "d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4" }, "account_id": { "type": [ "string", "null" ], "description": "The account this destination is scoped to, or `null` when it applies to the whole organization.", "example": null }, "hostname": { "type": "string", "description": "The registered hostname.", "example": "api.example-processor.com" }, "status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ], "description": "Whether the destination is active. Only ENABLED destinations are used by the forward path.", "example": "ENABLED" }, "purpose": { "type": "string", "description": "The label you provided when registering the destination.", "example": "Direct acquiring — Processor X" }, "created_at": { "type": "string", "format": "date-time", "description": "When the destination was registered.", "example": "2026-07-09T13:05:36Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the destination was last changed.", "example": "2026-07-09T13:05:36Z" } } }, "DestinationError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "NOT_AUTHENTICATED", "AuthenticationFail", "INVALID_REQUEST", "INVALID_HOSTNAME", "INVALID_ACCOUNT_ID", "DESTINATION_EXISTS", "NOT_FOUND", "INTERNAL_ERROR" ] }, "messages": { "type": "array", "items": { "type": "string" } } } }, "DestinationInput": { "type": "object", "required": [ "hostname" ], "properties": { "hostname": { "type": "string", "description": "The bare public hostname to allow, without scheme, port, or path (for example `api.example-processor.com`). Matched exactly, case-insensitive.", "example": "api.example-processor.com" }, "purpose": { "type": "string", "description": "An optional human-readable label describing why this host is allowed. Shown when you list destinations.", "example": "Direct acquiring — Processor X" }, "account_id": { "type": [ "string", "null" ], "format": "uuid", "description": "Optional. Restrict this destination to a single account (a UUID). Omit (or send `null`) to allow the host for the whole organization.", "example": null } } }, "Document": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string" } } }, "DryRunRequest": { "type": "object", "required": [ "merchant_reference", "events" ], "properties": { "merchant_reference": { "type": "string", "minLength": 3, "maxLength": 255, "description": "Merchant-assigned identifier (MAX 255; MIN 3). Unique per account.", "example": "ORD-12345" }, "payment_id": { "type": "string", "format": "uuid", "description": "Yuno payment UUID. If supplied, resolved immediately.", "example": "fb9e5fa4-684c-4747-9755-9d332617f16f" }, "account_id": { "type": "string", "format": "uuid", "description": "Yuno account UUID — same shape as account_id in POST /v1/payments.", "example": "a389f417-ecd1-4355-89f5-7489564f264d" }, "provider_id": { "type": "string", "description": "Provider identifier. Allowed values aligned to the Yuno catalog.", "example": "STRIPE", "enum": [ "STRIPE", "ADYEN", "CYBERSOURCE", "BRAINTREE", "NMI", "CHECKOUT", "WORLDPAY", "PAYPAL", "EBANX", "GLOBALPAYMENTS", "NUVEI", "CIELO", "MPGS", "PRISMA", "FISERV", "WORLDLINE", "ANTOM", "ORBITAL", "GOCARDLESS", "AUTHORIZE_NET", "SONY", "CITI", "EPX", "HPAY", "PAYSTACK", "PLAID", "SAFERPAY", "SIKA_HEALTH", "VALIDIFI", "WEPAY", "CARD_CONNECT", "GMO_PG", "MONERIS", "BLUESNAP", "QUICK_GATEWAY", "TWENTYFOUR_HOUR_FITNESS", "MERCHANT_ESOLUTIONS", "NETS", "FAT_ZEBRA", "WINDCAVE", "CHASE_MOBILITY", "HELIX", "ANB", "AMAZON_PAY", "OPAYO", "IP_PAYMENTS", "KLARNA", "BILLDESK", "WELLS_FARGO", "SAGEPAY", "PLANET" ] }, "payment_method_type": { "type": "string", "description": "Payment method exercised by this dry-run. Same vocabulary as payment_method.type in POST /v1/payments.", "example": "CREDIT_CARD", "enum": [ "", "CARD", "CREDIT_CARD", "CREDIT_CARD_REFERENCE_TRANSACTION", "DEBIT_CARD", "EPX_TOKEN", "TEST_CREDIT_CARD", "UPC_TOKEN_TRANSACTION", "APPLE_PAY", "GOOGLE_PAY", "PIX", "PSE", "OXXO", "BOLETO", "ALI_PAY", "AMAZON_PAY", "GCASH", "IDEAL", "KAKAO_PAY", "KLARNA", "MOMO_PAY", "NAVER_PAY", "OVO", "PAYPAL", "PAYPAL_CREDIT", "PAYPAY", "PAZE", "TOSS_PAY", "UPI", "VENMO", "ACH", "BANK_TRANSFER", "CRYPTO", "CASH" ] }, "events": { "type": "array", "minItems": 1, "maxItems": 10, "description": "1–10 HTTP exchange entries for this dry-run (MAX 10; MIN 1).", "items": { "$ref": "#/components/schemas/Event" }, "example": [ { "type": "REQUEST", "http_method": "POST", "operation_type": "PURCHASE", "base_url": "https://api.stripe.com", "endpoint": "/v1/charges", "headers": "eyBDb250ZW50LVR5cGU6IGFwcGxpY2F0aW9uL2pzb24gfQ==", "body": "eyBhbW91bnQ6IDIwMDAsIGN1cnJlbmN5OiAidXNkIiB9" } ] } } }, "DryRunResponse": { "type": "object", "required": [ "id", "status", "merchant_reference" ], "properties": { "id": { "type": "string", "description": "Public identifier of the dry-run registration (nano_id, 21 chars).", "example": "drun_1209fnkw428ufwd" }, "status": { "type": "string", "enum": [ "REGISTERED" ], "description": "Lifecycle state.", "example": "REGISTERED" }, "merchant_reference": { "type": "string", "example": "ORD-12345" }, "payment_id": { "type": [ "string", "null" ], "format": "uuid", "example": "fb9e5fa4-684c-4747-9755-9d332617f16f" }, "account_id": { "type": [ "string", "null" ], "format": "uuid", "example": "a389f417-ecd1-4355-89f5-7489564f264d" }, "provider_id": { "type": "string", "example": "STRIPE" }, "payment_method_type": { "type": "string", "example": "CARD", "enum": [ "", "CARD", "CREDIT_CARD", "CREDIT_CARD_REFERENCE_TRANSACTION", "DEBIT_CARD", "EPX_TOKEN", "TEST_CREDIT_CARD", "UPC_TOKEN_TRANSACTION", "APPLE_PAY", "GOOGLE_PAY", "PIX", "PSE", "OXXO", "BOLETO", "ALI_PAY", "AMAZON_PAY", "GCASH", "IDEAL", "KAKAO_PAY", "KLARNA", "MOMO_PAY", "NAVER_PAY", "OVO", "PAYPAL", "PAYPAL_CREDIT", "PAYPAY", "PAZE", "TOSS_PAY", "UPI", "VENMO", "ACH", "BANK_TRANSFER", "CRYPTO", "CASH" ] }, "operation_type": { "type": "string", "example": "PURCHASE" } } }, "Engagement": { "type": "object", "properties": { "preferred_channel": { "type": "string", "description": "Preferred communication channel.", "enum": [ "call", "whatsapp", "auto" ], "default": "auto", "example": "auto" }, "reason": { "type": "string", "description": "Reason for abandonment, if known.", "example": "user_abandoned_checkout" }, "metadata": { "type": "object", "description": "Additional contextual information (e.g., UTM parameters, last user actions).", "example": { "utm_campaign": "spring_sale", "last_clicked_button": "Proceed to Payment" } } } }, "Error": { "type": "object", "required": [ "code", "messages", "httpCode" ], "properties": { "code": { "type": "string", "description": "Stable error code.", "enum": [ "NOT_AUTHENTICATED", "AuthenticationFail", "INVALID_PARAMETERS", "TRAFFIC_LOG_VALIDATION_FAILED", "TRAFFIC_LOG_MERCHANT_REFERENCE_REQUIRED", "TRAFFIC_LOG_BODY_ENCODING_MISMATCH", "TRAFFIC_LOG_IDEMPOTENCY_REPLAY", "TRAFFIC_LOG_PAYLOAD_TOO_LARGE", "TRAFFIC_LOG_UNSUPPORTED_CONTENT_TYPE", "TRAFFIC_LOG_SEMANTIC_INVALID", "PAYMENT_NOT_FOUND", "RATE_LIMITED" ] }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Human-readable error details." }, "httpCode": { "type": "integer", "format": "int32" } } }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "messages": { "type": "array", "items": { "type": "string", "example": "Invalid request" } } } }, "Event": { "type": "object", "required": [ "type", "http_method", "operation_type", "headers" ], "properties": { "type": { "type": "string", "enum": [ "REQUEST", "RESPONSE", "WEBHOOK" ], "description": "Which leg of the exchange this entry captures.", "example": "REQUEST" }, "http_method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "example": "POST" }, "operation_type": { "type": "string", "enum": [ "PURCHASE", "AUTHORIZE", "CAPTURE", "CANCEL", "REFUND", "CHARGEBACK", "THREE_D_SECURE" ], "description": "Identifies the payment operation type being simulated.", "example": "PURCHASE" }, "base_url": { "type": "string", "format": "uri", "description": "Required for REQUEST and WEBHOOK. Origin of the provider endpoint — scheme + host + port (e.g. https://api.stripe.com).", "example": "https://api.stripe.com" }, "endpoint": { "type": "string", "description": "Required for REQUEST and WEBHOOK. Path and query portion (e.g. /v1/charges?expand=customer).", "example": "/v1/charges" }, "http_status_code": { "type": "integer", "format": "int32", "minimum": 100, "maximum": 599, "description": "Required for RESPONSE and WEBHOOK. Omit for REQUEST." }, "headers": { "type": "string", "format": "byte", "maxLength": 87400, "description": "Base64-encoded header payload. Decoded content may be a JSON-serialized\n`{header-name: header-value}` map or the raw HTTP header block. Hard\ncap: 64 KB of decoded bytes per event.\n", "example": "eyBDb250ZW50LVR5cGU6IGFwcGxpY2F0aW9uL2pzb24gfQ==" }, "body": { "type": "string", "format": "byte", "maxLength": 1398000, "description": "Base64-encoded body payload. Omit for empty bodies. Hard cap: 1 MB of\ndecoded bytes per event. For non-UTF-8 bodies (protobuf, gzip),\nbase64-encode the raw bytes directly.\n", "example": "eyBhbW91bnQ6IDIwMDAsIGN1cnJlbmN5OiAidXNkIiB9" } } }, "Metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "PaymentMethod": { "type": "object", "properties": { "idempotency_key": { "type": "string", "example": "a0000000-0000-4000-8000-000000000010" }, "name": { "type": "string", "example": "VISA ****1111" }, "description": { "type": "string", "example": "VISA ****1111" }, "type": { "type": "string", "example": "CARD" }, "category": { "type": "string", "example": "CARD" }, "country": { "type": "string", "example": "US" }, "parent_type": {}, "status": { "type": "string", "example": "ENROLLED" }, "sub_status": { "type": "string", "example": "ENROLLED" }, "vaulted_token": { "type": "string", "example": "b0000000-0000-4000-8000-000000000002" }, "callback_url": {}, "action": {}, "redirect_url": {}, "created_at": { "type": "string", "example": "2024-06-04T12:47:46.992602Z" }, "updated_at": { "type": "string", "example": "2024-06-04T12:47:46.992603Z" }, "card_data": { "type": "object", "properties": { "iin": { "type": "string", "example": "41111111" }, "lfd": { "type": "string", "example": "1111" }, "holder_name": { "type": "string", "description": "Cardholder's full name as returned by the payment provider.", "example": "JOHN DOE" }, "expiration_month": { "type": "integer", "example": 3, "default": 0 }, "expiration_year": { "type": "integer", "example": 26, "default": 0 }, "number_length": { "type": "integer", "example": 16, "default": 0 }, "security_code_length": { "type": "integer", "example": 3, "default": 0 }, "brand": { "type": "string", "example": "VISA" }, "issuer": { "type": "string", "example": "JPMORGAN CHASE BANK N A" }, "issuer_code": {}, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the card's issuing country.", "example": "US" }, "category": { "type": "string", "example": "CREDIT" }, "type": { "type": "string", "example": "CREDIT" }, "fingerprint": { "type": "string", "example": "55a7fe38-cdc3-45dc-8c5f-820751799c76" } } }, "last_successfully_used": {}, "last_successfully_used_at": {}, "preferred": {}, "customer_id": { "type": "string", "description": "The unique identifier of the customer the payment method now belongs to. Returned by the reassignment response so you can confirm the new owner.", "example": "b3f2c1a0-1234-4a5b-9c8d-000000000001" }, "verify": {} } }, "PaymentMethodConfig": { "type": "object", "description": "Each (provider_id, payment_method_type) pair must be unique within the array.", "required": [ "provider_id", "payment_method_type" ], "properties": { "provider_id": { "type": "string" }, "payment_method_type": { "type": "string" }, "merchant_id": { "type": "string" }, "wallet_details": { "$ref": "#/components/schemas/WalletDetails" } } }, "PaymentMethodConflictError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "CONFLICT" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } }, "PaymentMethodNotFoundError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "PAYMENT_METHOD_NOT_FOUND" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } }, "Phone": { "type": "object", "properties": { "code": { "type": "string", "description": "Country dialing code (e.g. +1, +57)." }, "number": { "type": "string" } } }, "ProviderData": { "type": "object", "properties": { "id": { "type": "string", "example": "adyen" }, "recipient_id": { "type": "string", "example": "SE322KT223222B5CM82WL9TB" }, "transfer_id": { "type": "string", "example": "TRF_8535296827453920" }, "response_code": { "type": "string", "example": "000" }, "response_message": { "type": "string", "example": "Transfer completed" } } }, "ProxyError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "NOT_AUTHENTICATED", "AuthenticationFail", "INVALID_REQUEST", "EXPRESSION_RESOLUTION_FAILED", "INVALID_ACCOUNT_ID", "DESTINATION_NOT_ALLOWED", "PRODUCT_NOT_ENABLED", "REQUEST_TOO_LARGE", "TOO_MANY_REQUESTS", "DESTINATION_UNREACHABLE", "DESTINATION_TIMEOUT", "RESPONSE_BLOCKED", "PROXY_ERROR" ] }, "messages": { "type": "array", "items": { "type": "string" } } } }, "ReassignPaymentMethodInput": { "type": "object", "required": [ "customer_id" ], "properties": { "customer_id": { "type": "string", "description": "The unique identifier of the customer the payment method is reassigned to (UUID). The payment method can be reassigned only while its current customer has no data; otherwise the request returns `409 CONFLICT`." } } }, "Recipient": { "type": "object", "required": [ "account_id", "merchant_recipient_id", "national_entity", "first_name", "last_name", "country" ], "properties": { "account_id": { "type": "string", "description": "Unique id of the account in Yuno (MAX 64; MIN 36).", "example": "9104911d-5df9-429e-8488-ad41abea1a4b" }, "merchant_recipient_id": { "type": "string", "description": "Unique identifier of the recipient defined by the merchant (MAX 255; MIN 1).", "example": "AAAA01" }, "national_entity": { "type": "string", "enum": [ "INDIVIDUAL", "ENTITY" ], "description": "Beneficiary's national entity type. Could be INDIVIDUAL or ENTITY.", "example": "INDIVIDUAL" }, "entity_type": { "type": "string", "enum": [ "GOVERNMENTAL", "PUBLIC", "NON_PROFIT", "PRIVATE" ], "description": "The Beneficiary's type of organization. GOVERNMENTAL, PUBLIC, NON_PROFIT, PRIVATE", "example": "PRIVATE" }, "first_name": { "type": "string", "description": "Beneficiary's name. (MAX 80; MIN 1).", "example": "John" }, "last_name": { "type": "string", "description": "Beneficiary's last name. (MAX 80; MIN 1).", "example": "Doe" }, "date_of_birth": { "type": "string", "description": "The Beneficiary's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).", "example": "1990-02-28", "minLength": 10, "maxLength": 10 }, "legal_name": { "type": "string", "description": "Beneficiary's name. (MAX 80; MIN 1) Only necessary when national entity is ENTITY.", "example": "Arcos dorados S.A." }, "email": { "type": "string", "description": "The Beneficiary's email (MAX 255; MIN 3).", "example": "john.doe@email.com" }, "country": { "type": "string", "description": "The Beneficiary's country (ISO 3166-1 MAX 2; MIN 2).", "example": "CO" }, "website": { "type": "string", "description": "The seller's website URL (MAX 255; MIN 3).", "example": "https://y.uno", "minLength": 3, "maxLength": 255 }, "industry": { "type": "string", "description": "The seller's industry (MAX 235; MIN 1). For more information access the Industry category reference page.", "example": "VIRTUAL_GOODS", "minLength": 1, "maxLength": 235 }, "merchant_category_code": { "type": "string", "description": "MCC - The merchant category code (MAX 235; MIN 1)." }, "document": { "type": "object", "description": "Beneficiary's document information", "required": [ "document_number", "document_type" ], "properties": { "document_number": { "type": "string", "description": "Beneficiary's national document id (MAX 40; MIN 3).", "example": "1093333333" }, "document_type": { "type": "string", "description": "Beneficiary's document type (MAX 6; MIN 2).", "example": "CC" } } }, "phone": { "type": "object", "description": "Specifies the customer's phone number object.", "required": [ "country_code", "number" ], "properties": { "country_code": { "type": "string", "description": "The country calling code of the customer's phone (MAX 3; MIN 1). Check the Country reference to see the phone codes. This field is required if the 'phone' object is included in the request.", "example": "1" }, "number": { "type": "string", "description": "The customer's phone number, without the country code (MAX 32; MIN 1). This field is required if the 'phone' object is included in the request.", "example": "5551234567" } } }, "address": { "type": "object", "description": "Address", "properties": { "address_line_1": { "type": "string", "description": "The primary billing address line (MAX 255; MIN 3).", "example": "Calle 34 # 56 - 78" }, "address_line_2": { "type": "string", "description": "The secondary billing address line (MAX 255; MIN 3).", "example": "Apartamento 502, Torre I" }, "city": { "type": "string", "description": "The city considered for the address (MAX 255; MIN 3).", "example": "Bogota" }, "country": { "type": "string", "description": "The country considered for the address (ISO 3166-1 MAX 2; MIN 2). Required if address is present.", "example": "CO" }, "state": { "type": "string", "description": "The state / province considered for the address (MAX 255; MIN 3).", "example": "Cundinamarca" }, "zip_code": { "type": "string", "description": "The zipcode considered for the address (MAX 11; MIN 4).", "example": "111111" }, "neighborhood": { "type": "string", "description": "The neighborhood address line (MAX 255; MIN 3).", "example": "Downtown" } } }, "split_configuration": { "type": "object", "description": "Rules for automatic split calculation at the recipient level.", "required": [ "calculation_type", "currency" ], "properties": { "calculation_type": { "type": "string", "description": "The method used to calculate the split amount.", "enum": [ "PERCENTAGE", "FIXED", "MIXED" ], "example": "PERCENTAGE" }, "percentage": { "type": "number", "description": "Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED.", "minimum": 0.01, "maximum": 100, "example": 10.5 }, "fixed_amount": { "type": "number", "description": "Fixed amount to be split. Required if calculation_type is FIXED or MIXED.", "minimum": 0.0001, "example": 5 }, "currency": { "type": "string", "description": "ISO 4217 currency code. Required for all calculation types.", "example": "USD" }, "rounding_mode": { "type": "string", "description": "The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED.", "enum": [ "STANDARD", "ROUND_UP", "ROUND_DOWN" ], "example": "STANDARD" } } }, "legal_representatives": { "type": "array", "description": "Owners/beneficials of the recipient. Required when `national_entity = ENTITY`.", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "minLength": 3, "maxLength": 255, "description": "Legal representative's identification id (MAX 255; MIN 3)." }, "first_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "First name (MAX 255; MIN 1)." }, "last_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Last name (MAX 255; MIN 1)." }, "email": { "type": "string", "format": "email", "minLength": 1, "maxLength": 255, "description": "Email (MAX 255; MIN 1)." }, "date_of_birth": { "type": "string", "format": "date", "minLength": 10, "maxLength": 10, "description": "YYYY-MM-DD (MAX 10; MIN 10)." }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Country ISO 3166-1 (2)." }, "nationality": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Nationality ISO 3166-1 (2)." }, "title": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Job title (MAX 255; MIN 1)." }, "publicly_exposed_person": { "type": "boolean", "description": "PEP flag." }, "ultimate_beneficial_owner": { "type": "boolean", "description": "UBO flag." } } } }, "withdrawal_methods": { "type": "object", "description": "Withdrawal methods for the merchant", "properties": { "bank": { "type": "object", "description": "Bank's account information", "properties": { "code": { "type": "string", "description": "Bank's code (MAX 3; MIN 3).", "example": "246" }, "branch": { "type": "string", "description": "Bank's branch (MAX 3; MIN 3).", "example": "XXXX" }, "branch_digit": { "type": "string", "description": "Bank's branch digit (MAX 3; MIN 3)." }, "account": { "type": "string", "description": "Beneficiary's bank account number (MAX 250; MIN 3).", "example": "1093333333" }, "account_digit": { "type": "string", "description": "Beneficiary's bank account digit (MAX 250; MIN 3)." }, "account_type": { "type": "string", "enum": [ "CHECKINGS", "SAVINGS" ], "description": "Beneficiary's bank account type. Allowed values: CHECKINGS, SAVINGS.", "example": "SAVINGS" }, "routing": { "type": "string", "description": "Beneficiary's bank account routing number.", "example": "XXXXYYYYC" }, "country": { "type": "string", "description": "The bank account's country (ISO 3166-1 MAX 2; MIN 2).", "example": "CO" }, "currency": { "type": "string", "description": "The bank account's currency (ISO 4217 MAX 3; MIN 3).", "example": "COP" }, "payout_schedule": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "HOLD" ], "description": "Payout schedule preference." } } } } }, "documentation": { "type": "array", "description": "Array of documentation objects", "items": { "type": "object", "required": [ "file_name", "content_type", "content_category", "content" ], "properties": { "file_name": { "type": "string", "description": "The name of the documentation sent (MAX 255; MIN 3).", "example": "PDF" }, "content_type": { "type": "string", "enum": [ "application/pdf", "image/jpeg", "image/png" ], "description": "The type of the documentation sent by the merchant.", "example": "application/pdf" }, "content_category": { "type": "string", "enum": [ "ACCOUNT_REQUIREMENT", "BANK_STATEMENT", "BUSINESS_ICON", "BUSINESS_LOGO", "CANCEL_POLICY", "CUSTOMER_INTERACTION", "DRIVERS_LICENCE", "IDENTIFICATION_DOCUMENT", "IDENTIFICATION_DOCUMENT_BACK", "IDENTIFICATION_DOCUMENT_FRONT", "LEGAL_AGREEMENT", "OTHERS", "PASSPORT", "PAYMENT_DETAIL", "PROOF_OF_ADDRESS", "PROOF_OF_AUTHENTICITY", "PROOF_OF_DELIVERY", "PROOF_OF_DIRECTOR", "PROOF_OF_INDUSTRY", "PROOF_OF_NATIONAL_ID_NUMBER", "PROOF_OF_OWNERSHIP", "PROOF_OF_REGISTRATION", "PROOF_OF_RELATIONSHIP", "PROOF_OF_SERVICE", "PROOF_OF_SOURCE_OF_FUNDS", "PROOF_OF_SOURCE_OF_WEALTH", "PROOF_OF_TAX", "PROVIDER_IDENTITY_DOCUMENT", "RECEIPT", "REFUND_POLICY", "SELFIE", "SERVICE_AGREEMENT", "SIGNATURE", "TERMS_AND_CONDITIONS", "VAT_DOCUMENT" ], "description": "The category of the documentation sent by the merchant." }, "content": { "type": "string", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 2MB.", "example": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg==" } } } }, "onboardings": { "type": "array", "description": "Array of onboarding objects for different payment providers", "items": { "type": "object", "required": [ "type", "workflow", "provider" ], "properties": { "account_id": { "type": "string", "description": "Optional account id for this onboarding. If omitted, the top-level recipient account_id applies." }, "type": { "type": "string", "enum": [ "PREVIOUSLY_ONBOARDED", "ONBOARD_ONTO_THE_PROVIDER" ], "description": "Type of onboarding. If its done by Yuno.", "example": "PREVIOUSLY_ONBOARDED" }, "workflow": { "type": "string", "enum": [ "HOSTED_BY_PROVIDER", "DIRECT" ], "description": "Workflow of the onboarding.", "example": "HOSTED_BY_PROVIDER" }, "description": { "type": "string", "description": "Optional description of the onboarding (MAX 255; MIN 3)." }, "callback_url": { "type": "string", "description": "URL in case to redirect your customer after the onboarding process with the provider, if needed.", "example": "https://www.google.com" }, "provider": { "type": "object", "required": [ "id", "connection_id" ], "properties": { "id": { "type": "string", "enum": [ "PAGARME", "ALELO", "EDENRED", "PLUXEE", "VR", "STRIPE", "ADYEN" ], "description": "Provider id.", "example": "PAGARME" }, "connection_id": { "type": "string", "description": "ID of the connection in Yuno" }, "recipient_id": { "type": "string", "description": "The unique identifier of the provider's recipient.", "example": "AAAAA01" }, "recipient_type": { "type": "string", "description": "The type of recipient for the provider.", "enum": [ "MEAL", "FOOD", "MULTI_BENEFITS", "FLEET" ], "example": "MEAL" } } }, "documentation": { "type": "array", "description": "Array of documentation objects for this onboarding", "items": { "type": "object", "required": [ "file_name", "content_type", "content_category", "content" ], "properties": { "file_name": { "type": "string", "description": "The name of the documentation sent (MAX 255; MIN 3).", "example": "PDF" }, "content_type": { "type": "string", "enum": [ "application/pdf", "image/jpeg", "image/png" ], "description": "The type of the documentation sent by the merchant.", "example": "application/pdf" }, "content_category": { "type": "string", "enum": [ "ACCOUNT_REQUIREMENT", "BANK_STATEMENT", "BUSINESS_ICON", "BUSINESS_LOGO", "CANCEL_POLICY", "CUSTOMER_INTERACTION", "DRIVERS_LICENCE", "IDENTIFICATION_DOCUMENT", "IDENTIFICATION_DOCUMENT_BACK", "IDENTIFICATION_DOCUMENT_FRONT", "LEGAL_AGREEMENT", "OTHERS", "PASSPORT", "PAYMENT_DETAIL", "PROOF_OF_ADDRESS", "PROOF_OF_AUTHENTICITY", "PROOF_OF_DELIVERY", "PROOF_OF_DIRECTOR", "PROOF_OF_INDUSTRY", "PROOF_OF_NATIONAL_ID_NUMBER", "PROOF_OF_OWNERSHIP", "PROOF_OF_REGISTRATION", "PROOF_OF_RELATIONSHIP", "PROOF_OF_SERVICE", "PROOF_OF_SOURCE_OF_FUNDS", "PROOF_OF_SOURCE_OF_WEALTH", "PROOF_OF_TAX", "PROVIDER_IDENTITY_DOCUMENT", "RECEIPT", "REFUND_POLICY", "SELFIE", "SERVICE_AGREEMENT", "SIGNATURE", "TERMS_AND_CONDITIONS", "VAT_DOCUMENT" ], "description": "The category of the documentation sent by the merchant." }, "content": { "type": "string", "description": "The content of the documentation sent by the merchant encoded in base64. Max size: 1MB.", "example": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg==" } } } }, "withdrawal_methods": { "type": "array", "description": "Withdrawal methods for this onboarding", "items": { "type": "object", "properties": { "bank": { "type": "object", "description": "Bank's account information", "properties": { "code": { "type": "string", "description": "Bank's code (MAX 3; MIN 3).", "example": "246" }, "branch": { "type": "string", "description": "Bank's branch (MAX 3; MIN 3).", "example": "XXXX" }, "branch_digit": { "type": "string", "description": "Bank's branch digit (MAX 3; MIN 3)." }, "account": { "type": "string", "description": "Beneficiary's bank account number (MAX 250; MIN 3).", "example": "1093333333" }, "account_digit": { "type": "string", "description": "Beneficiary's bank account digit (MAX 250; MIN 3)." }, "account_type": { "type": "string", "enum": [ "CHECKINGS", "SAVINGS", "VISTA", "PIX_EMAIL", "PIX_PHONE", "PIX_DOCUMENT_ID", "PIX_BANK_ACCOUNT" ], "description": "Beneficiary's bank account type (MAX 3; MIN 1). Could be: CHECKINGS, SAVINGS, VISTA, PIX_EMAIL, PIX_PHONE, PIX_DOCUMENT_ID, PIX_BANK_ACCOUNT.", "example": "SAVINGS" }, "routing": { "type": "string", "description": "Beneficiary's bank account routing number.", "example": "XXXXYYYYC" }, "country": { "type": "string", "description": "The bank account's country (ISO 3166-1 MAX 2; MIN 2).", "example": "CO" }, "currency": { "type": "string", "description": "The bank account's currency (ISO 4217 MAX 3; MIN 3).", "example": "COP" } } } } } } } } } } }, "RecipientResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the recipient.", "example": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802" }, "account_id": { "type": "string", "description": "The account identifier associated with this recipient.", "example": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482" }, "merchant_recipient_id": { "type": "string", "description": "Unique identifier of the recipient defined by the merchant.", "example": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6" }, "national_entity": { "type": "string", "description": "Beneficiary's national entity type.", "example": "INDIVIDUAL" }, "entity_type": { "type": "string", "description": "Beneficiary's type of organization.", "example": "PRIVATE" }, "first_name": { "type": "string", "description": "Beneficiary's name.", "example": "Juan" }, "last_name": { "type": "string", "description": "Beneficiary's last name.", "example": "Perez" }, "legal_name": { "type": [ "string", "null" ], "description": "Beneficiary's legal name.", "example": null }, "email": { "type": "string", "description": "The Beneficiary's email.", "example": "juan.perez@example.com" }, "date_of_birth": { "type": "string", "description": "Beneficiary's date of birth.", "example": "1990-01-15" }, "country": { "type": "string", "description": "The Beneficiary's country.", "example": "CO" }, "website": { "type": "string", "description": "The seller's website URL.", "example": "https://juanperez.com" }, "industry": { "type": "string", "description": "The seller's industry.", "example": "Technology" }, "merchant_category_code": { "type": "string", "description": "The merchant category code (MCC) (MAX 235; MIN 1).", "example": "5734" }, "document": { "type": "object", "properties": { "document_number": { "type": "string", "example": "1234567890" }, "document_type": { "type": "string", "example": "CC" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "3001234567" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Carrera 7 # 32-16" }, "address_line_2": { "type": [ "string", "null" ], "example": "Oficina 201" }, "city": { "type": "string", "example": "Bogota" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "zip_code": { "type": "string", "example": "110311" }, "neighborhood": { "type": "string", "example": "Centro" } } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "example": "REP_001" }, "first_name": { "type": "string", "example": "Maria" }, "last_name": { "type": "string", "example": "Gonzalez" }, "email": { "type": "string", "example": "maria.gonzalez@example.com" }, "date_of_birth": { "type": "string", "example": "1985-05-20" }, "country": { "type": "string", "example": "CO" }, "nationality": { "type": "string", "example": "CO" }, "title": { "type": "string", "example": "CEO" }, "publicly_exposed_person": { "type": "boolean", "example": false }, "ultimate_beneficial_owner": { "type": "boolean", "example": true }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "0987654321" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "3109876543" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 26 # 13-19" }, "address_line_2": { "type": [ "string", "null" ], "example": null }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogota" }, "zip_code": { "type": "string", "example": "110311" } } } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "001" }, "branch": { "type": "string", "example": "004" }, "branch_digit": { "type": [ "string", "null" ], "example": "123" }, "account": { "type": "string", "example": "1234567890" }, "account_digit": { "type": [ "string", "null" ], "example": "123" }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "021000021" }, "country": { "type": "string", "example": "CO" }, "currency": { "type": "string", "example": "COP" } } } } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "cc-front.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content_category": { "type": "string", "example": "IDENTIFICATION" }, "content": { "type": "string", "example": "JVBERi0xLjQKJ..." } } } }, "onboardings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "84c42684-dbe5-4e0f-bd17-4d094e19762d" }, "type": { "type": "string", "example": "ONBOARD_ONTO_THE_PROVIDER" }, "workflow": { "type": "string", "example": "DIRECT" }, "status": { "type": "string", "example": "PENDING" }, "callback_url": { "type": "string", "example": "https://merchant.example.com/webhook/onboarding" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "ALELO" }, "connection_id": { "type": "string", "example": "cc389b51-53a1-4a29-af40-c8cee26c3399" }, "recipient_id": { "type": [ "string", "null" ], "example": null }, "redirect_url": { "type": [ "string", "null" ], "example": null }, "onboarding_url": { "type": [ "string", "null" ], "example": null }, "legal_entity": { "type": [ "string", "null" ], "example": null }, "balance_account_id": { "type": [ "string", "null" ], "example": null }, "legal_entity_id": { "type": [ "string", "null" ], "example": null } } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "utility-bill.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content_category": { "type": "string", "example": "ADDRESS_PROOF" }, "content": { "type": "string", "example": "JVBERi0xLjQKJ..." } } } }, "legal_representatives": { "type": "array", "items": { "type": "object" }, "example": [] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "example": "document.cc" }, "message": { "type": "string", "example": "Provide CC document image" }, "status": { "type": "string", "example": "PENDING" } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "002" }, "branch": { "type": "string", "example": "002" }, "branch_digit": { "type": [ "string", "null" ], "example": null }, "account": { "type": "string", "example": "9876543210" }, "account_digit": { "type": [ "string", "null" ], "example": null }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "021000022" }, "country": { "type": "string", "example": "CO" }, "currency": { "type": "string", "example": "COP" } } } } }, "terms_of_service": { "type": "object", "properties": { "acceptance": { "type": "boolean", "example": true }, "date": { "type": "string", "example": "2025-07-21T20:43:54Z" }, "ip": { "type": "string", "example": "129.21.111.11" } } }, "created_at": { "type": "string", "format": "date-time", "example": "2025-08-27T15:41:19.516982Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-08-27T15:41:19.516989Z" } } } }, "split_configuration": { "type": "object", "description": "Rules for automatic split calculation at the recipient level.", "properties": { "calculation_type": { "type": "string", "description": "The method used to calculate the split amount.", "enum": [ "PERCENTAGE", "FIXED", "MIXED" ], "example": "PERCENTAGE" }, "percentage": { "type": "number", "description": "Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED.", "minimum": 0.01, "maximum": 100, "example": 10.5 }, "fixed_amount": { "type": "number", "description": "Fixed amount to be split. Required if calculation_type is FIXED or MIXED.", "minimum": 0.0001, "example": 5 }, "currency": { "type": "string", "description": "ISO 4217 currency code. Required for all calculation types.", "example": "USD" }, "rounding_mode": { "type": "string", "description": "The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED.", "enum": [ "STANDARD", "ROUND_UP", "ROUND_DOWN" ], "example": "STANDARD" } } }, "created_at": { "type": "string", "format": "date-time", "description": "Recipient creation date (ISO 8601 MAX 27; MIN 27).", "example": "2025-08-27T15:41:19.497413Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last Recipient updated date (ISO 8601 MAX 27; MIN 27).", "example": "2025-08-27T15:41:19.497425Z" } } }, "RecipientResponse_2": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the recipient.", "example": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802" }, "account_id": { "type": "string", "description": "The account identifier associated with this recipient.", "example": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482" }, "merchant_recipient_id": { "type": "string", "description": "Unique identifier of the recipient defined by the merchant.", "example": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6" }, "national_entity": { "type": "string", "description": "Beneficiary's national entity type.", "example": "INDIVIDUAL" }, "entity_type": { "type": "string", "description": "Beneficiary's type of organization.", "example": "PRIVATE" }, "first_name": { "type": "string", "description": "Beneficiary's name.", "example": "Juan" }, "last_name": { "type": "string", "description": "Beneficiary's last name.", "example": "Perez" }, "legal_name": { "type": [ "string", "null" ], "description": "Beneficiary's legal name.", "example": null }, "email": { "type": "string", "description": "The Beneficiary's email.", "example": "juan.perez@example.com" }, "date_of_birth": { "type": "string", "description": "Beneficiary's date of birth.", "example": "1990-01-15" }, "country": { "type": "string", "description": "The Beneficiary's country.", "example": "CO" }, "website": { "type": "string", "description": "The seller's website URL.", "example": "https://juanperez.com" }, "industry": { "type": "string", "description": "The seller's industry.", "example": "Technology" }, "merchant_category_code": { "type": "string", "description": "The merchant category code (MCC) (MAX 235; MIN 1).", "example": "5734" }, "document": { "type": "object", "properties": { "document_number": { "type": "string", "example": "1234567890" }, "document_type": { "type": "string", "example": "CC" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "3001234567" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Carrera 7 # 32-16" }, "address_line_2": { "type": [ "string", "null" ], "example": "Oficina 201" }, "city": { "type": "string", "example": "Bogota" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "zip_code": { "type": "string", "example": "110311" }, "neighborhood": { "type": "string", "example": "Centro" } } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "example": "REP_001" }, "first_name": { "type": "string", "example": "Maria" }, "last_name": { "type": "string", "example": "Gonzalez" }, "email": { "type": "string", "example": "maria.gonzalez@example.com" }, "date_of_birth": { "type": "string", "example": "1985-05-20" }, "country": { "type": "string", "example": "CO" }, "nationality": { "type": "string", "example": "CO" }, "title": { "type": "string", "example": "CEO" }, "publicly_exposed_person": { "type": "boolean", "example": false }, "ultimate_beneficial_owner": { "type": "boolean", "example": true }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "0987654321" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "3109876543" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 26 # 13-19" }, "address_line_2": { "type": [ "string", "null" ], "example": null }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogota" }, "zip_code": { "type": "string", "example": "110311" } } } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "001" }, "branch": { "type": "string", "example": "004" }, "branch_digit": { "type": [ "string", "null" ], "example": "123" }, "account": { "type": "string", "example": "1234567890" }, "account_digit": { "type": [ "string", "null" ], "example": "123" }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "021000021" }, "country": { "type": "string", "example": "CO" }, "currency": { "type": "string", "example": "COP" } } } } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "cc-front.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content_category": { "type": "string", "example": "IDENTIFICATION" }, "content": { "type": "string", "example": "JVBERi0xLjQKJ..." } } } }, "onboardings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "84c42684-dbe5-4e0f-bd17-4d094e19762d" }, "type": { "type": "string", "example": "ONBOARD_ONTO_THE_PROVIDER" }, "workflow": { "type": "string", "example": "DIRECT" }, "status": { "type": "string", "example": "PENDING" }, "callback_url": { "type": "string", "example": "https://merchant.example.com/webhook/onboarding" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "ALELO" }, "connection_id": { "type": "string", "example": "cc389b51-53a1-4a29-af40-c8cee26c3399" }, "recipient_id": { "type": [ "string", "null" ], "example": null }, "redirect_url": { "type": [ "string", "null" ], "example": null }, "onboarding_url": { "type": [ "string", "null" ], "example": null }, "legal_entity": { "type": [ "string", "null" ], "example": null }, "balance_account_id": { "type": [ "string", "null" ], "example": null }, "legal_entity_id": { "type": [ "string", "null" ], "example": null } } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "utility-bill.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content_category": { "type": "string", "example": "ADDRESS_PROOF" }, "content": { "type": "string", "example": "JVBERi0xLjQKJ..." } } } }, "legal_representatives": { "type": "array", "items": { "type": "object" }, "example": [] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "example": "document.cc" }, "message": { "type": "string", "example": "Provide CC document image" }, "status": { "type": "string", "example": "PENDING" } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "002" }, "branch": { "type": "string", "example": "002" }, "branch_digit": { "type": [ "string", "null" ], "example": null }, "account": { "type": "string", "example": "9876543210" }, "account_digit": { "type": [ "string", "null" ], "example": null }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "021000022" }, "country": { "type": "string", "example": "CO" }, "currency": { "type": "string", "example": "COP" } } } } }, "terms_of_service": { "type": "object", "properties": { "acceptance": { "type": "boolean", "example": true }, "date": { "type": "string", "example": "2025-07-21T20:43:54Z" }, "ip": { "type": "string", "example": "129.21.111.11" } } }, "created_at": { "type": "string", "format": "date-time", "example": "2025-08-27T15:41:19.516982Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-08-27T15:41:19.516989Z" } } } }, "split_configuration": { "type": "object", "description": "Rules for automatic split calculation at the recipient level.", "required": [ "calculation_type", "currency" ], "properties": { "calculation_type": { "type": "string", "description": "The method used to calculate the split amount.", "enum": [ "PERCENTAGE", "FIXED", "MIXED" ], "example": "PERCENTAGE" }, "percentage": { "type": "number", "description": "Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED.", "minimum": 0.01, "maximum": 100, "example": 10.5 }, "fixed_amount": { "type": "number", "description": "Fixed amount to be split. Required if calculation_type is FIXED or MIXED.", "minimum": 0.0001, "example": 5 }, "currency": { "type": "string", "description": "ISO 4217 currency code. Required for all calculation types.", "example": "USD" }, "rounding_mode": { "type": "string", "description": "The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED.", "enum": [ "STANDARD", "ROUND_UP", "ROUND_DOWN" ], "example": "STANDARD" } } }, "created_at": { "type": "string", "format": "date-time", "description": "Recipient creation date (ISO 8601 MAX 27; MIN 27).", "example": "2025-08-27T15:41:19.497413Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last Recipient updated date (ISO 8601 MAX 27; MIN 27).", "example": "2025-08-27T15:41:19.497425Z" } } }, "RecipientResponse_3": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the recipient.", "example": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802" }, "account_id": { "type": "string", "description": "The account identifier associated with this recipient.", "example": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482" }, "merchant_recipient_id": { "type": "string", "description": "Unique identifier of the recipient defined by the merchant.", "example": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6" }, "national_entity": { "type": "string", "description": "Beneficiary's national entity type.", "example": "INDIVIDUAL" }, "entity_type": { "type": "string", "description": "Beneficiary's type of organization.", "example": "PRIVATE" }, "first_name": { "type": "string", "description": "Beneficiary's name.", "example": "Juan" }, "last_name": { "type": "string", "description": "Beneficiary's last name.", "example": "Perez" }, "legal_name": { "type": [ "string", "null" ], "description": "Beneficiary's legal name.", "example": null }, "email": { "type": "string", "description": "The Beneficiary's email.", "example": "juan.perez@example.com" }, "date_of_birth": { "type": "string", "description": "Beneficiary's date of birth.", "example": "1990-01-15" }, "country": { "type": "string", "description": "The Beneficiary's country.", "example": "CO" }, "website": { "type": "string", "description": "The seller's website URL.", "example": "https://juanperez.com" }, "industry": { "type": "string", "description": "The seller's industry.", "example": "Technology" }, "merchant_category_code": { "type": "string", "description": "The merchant category code (MCC) (MAX 235; MIN 1).", "example": "5734" }, "document": { "type": "object", "properties": { "document_number": { "type": "string", "example": "1234567890" }, "document_type": { "type": "string", "example": "CC" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "3001234567" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Carrera 7 # 32-16" }, "address_line_2": { "type": [ "string", "null" ], "example": "Oficina 201" }, "city": { "type": "string", "example": "Bogota" }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "zip_code": { "type": "string", "example": "110311" }, "neighborhood": { "type": "string", "example": "Centro" } } }, "legal_representatives": { "type": "array", "items": { "type": "object", "properties": { "merchant_reference": { "type": "string", "example": "REP_001" }, "first_name": { "type": "string", "example": "Maria" }, "last_name": { "type": "string", "example": "Gonzalez" }, "email": { "type": "string", "example": "maria.gonzalez@example.com" }, "date_of_birth": { "type": "string", "example": "1985-05-20" }, "country": { "type": "string", "example": "CO" }, "nationality": { "type": "string", "example": "CO" }, "title": { "type": "string", "example": "CEO" }, "publicly_exposed_person": { "type": "boolean", "example": false }, "ultimate_beneficial_owner": { "type": "boolean", "example": true }, "document": { "type": "object", "properties": { "document_type": { "type": "string", "example": "CC" }, "document_number": { "type": "string", "example": "0987654321" } } }, "phone": { "type": "object", "properties": { "country_code": { "type": "string", "example": "57" }, "number": { "type": "string", "example": "3109876543" } } }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string", "example": "Calle 26 # 13-19" }, "address_line_2": { "type": [ "string", "null" ], "example": null }, "country": { "type": "string", "example": "CO" }, "state": { "type": "string", "example": "Cundinamarca" }, "city": { "type": "string", "example": "Bogota" }, "zip_code": { "type": "string", "example": "110311" } } } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "001" }, "branch": { "type": "string", "example": "004" }, "branch_digit": { "type": [ "string", "null" ], "example": "123" }, "account": { "type": "string", "example": "1234567890" }, "account_digit": { "type": [ "string", "null" ], "example": "123" }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "021000021" }, "country": { "type": "string", "example": "CO" }, "currency": { "type": "string", "example": "COP" } } } } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "cc-front.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content_category": { "type": "string", "example": "IDENTIFICATION" }, "content": { "type": "string", "example": "JVBERi0xLjQKJ..." } } } }, "onboardings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "84c42684-dbe5-4e0f-bd17-4d094e19762d" }, "type": { "type": "string", "example": "ONBOARD_ONTO_THE_PROVIDER" }, "workflow": { "type": "string", "example": "DIRECT" }, "status": { "type": "string", "example": "PENDING" }, "callback_url": { "type": "string", "example": "https://merchant.example.com/webhook/onboarding" }, "provider": { "type": "object", "properties": { "id": { "type": "string", "example": "ALELO" }, "connection_id": { "type": "string", "example": "cc389b51-53a1-4a29-af40-c8cee26c3399" }, "recipient_id": { "type": [ "string", "null" ], "example": null }, "redirect_url": { "type": [ "string", "null" ], "example": null }, "onboarding_url": { "type": [ "string", "null" ], "example": null }, "legal_entity": { "type": [ "string", "null" ], "example": null }, "balance_account_id": { "type": [ "string", "null" ], "example": null }, "legal_entity_id": { "type": [ "string", "null" ], "example": null } } }, "documentation": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "example": "utility-bill.pdf" }, "content_type": { "type": "string", "example": "application/pdf" }, "content_category": { "type": "string", "example": "ADDRESS_PROOF" }, "content": { "type": "string", "example": "JVBERi0xLjQKJ..." } } } }, "legal_representatives": { "type": "array", "items": { "type": "object" }, "example": [] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "example": "document.cc" }, "message": { "type": "string", "example": "Provide CC document image" }, "status": { "type": "string", "example": "PENDING" } } } }, "withdrawal_methods": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string", "example": "002" }, "branch": { "type": "string", "example": "002" }, "branch_digit": { "type": [ "string", "null" ], "example": null }, "account": { "type": "string", "example": "9876543210" }, "account_digit": { "type": [ "string", "null" ], "example": null }, "account_type": { "type": "string", "example": "SAVINGS" }, "routing": { "type": "string", "example": "021000022" }, "country": { "type": "string", "example": "CO" }, "currency": { "type": "string", "example": "COP" } } } } }, "terms_of_service": { "type": "object", "properties": { "acceptance": { "type": "boolean", "example": true }, "date": { "type": "string", "example": "2025-07-21T20:43:54Z" }, "ip": { "type": "string", "example": "129.21.111.11" } } }, "created_at": { "type": "string", "format": "date-time", "example": "2025-08-27T15:41:19.516982Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-08-27T15:41:19.516989Z" } } } }, "created_at": { "type": "string", "format": "date-time", "description": "Recipient creation date (ISO 8601 MAX 27; MIN 27).", "example": "2025-08-27T15:41:19.497413Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last Recipient updated date (ISO 8601 MAX 27; MIN 27).", "example": "2025-08-27T15:41:19.497425Z" } } }, "RecoveryOutreachRequest": { "type": "object", "required": [ "customer", "session" ], "properties": { "customer": { "$ref": "#/components/schemas/Customer" }, "session": { "$ref": "#/components/schemas/Session" }, "cart": { "$ref": "#/components/schemas/Cart" }, "engagement": { "$ref": "#/components/schemas/Engagement" } } }, "Seller": { "type": "object", "properties": { "seller_id": { "type": "string", "format": "uuid" }, "merchant_seller_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "$ref": "#/components/schemas/Phone" }, "document": { "$ref": "#/components/schemas/Document" }, "address": { "$ref": "#/components/schemas/Address" }, "country": { "type": "string", "minLength": 2, "maxLength": 2 }, "website": { "type": "string" }, "industry": { "type": "string" }, "merchant_category_code": { "type": "string", "minLength": 4, "maxLength": 4 }, "payment_methods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodConfig" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "SellerCreate": { "type": "object", "required": [ "account_id", "merchant_seller_id" ], "properties": { "account_id": { "type": "string", "format": "uuid" }, "merchant_seller_id": { "type": "string", "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email" }, "phone": { "$ref": "#/components/schemas/Phone" }, "document": { "$ref": "#/components/schemas/Document" }, "address": { "$ref": "#/components/schemas/Address" }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "ISO 3166-1 alpha-2 country code." }, "website": { "type": "string" }, "industry": { "type": "string" }, "merchant_category_code": { "type": "string", "minLength": 4, "maxLength": 4 }, "payment_methods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodConfig" } } } }, "SellerUpdate": { "type": "object", "required": [ "account_id" ], "properties": { "account_id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email" }, "phone": { "$ref": "#/components/schemas/Phone" }, "document": { "$ref": "#/components/schemas/Document" }, "address": { "$ref": "#/components/schemas/Address" }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "ISO 3166-1 alpha-2 country code." }, "industry": { "type": "string" }, "merchant_category_code": { "type": "string", "minLength": 4, "maxLength": 4 }, "payment_methods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodConfig" } } } }, "Session": { "type": "object", "required": [ "abandonment_timestamp", "flow_stage", "platform" ], "properties": { "abandonment_timestamp": { "type": "string", "format": "date-time", "description": "Timestamp when the user abandoned the flow.", "example": "2025-05-13T22:45:00Z" }, "flow_stage": { "type": "string", "description": "Stage where the user dropped off.", "enum": [ "product_selection", "cart_review", "checkout", "payment" ], "example": "checkout" }, "platform": { "type": "string", "description": "User's platform.", "enum": [ "web", "ios", "android" ], "example": "web" }, "session_id": { "type": "string", "description": "Unique identifier for the user's session.", "example": "sess_abc123xyz" } } }, "Transfer": { "type": "object", "properties": { "id": { "type": "string", "example": "TRF_7kB2mQ9xPnL4vR" }, "recipient_id": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "amount": { "$ref": "#/components/schemas/Amount" }, "status": { "type": "string", "example": "SUCCEEDED" }, "reason": { "type": "string", "example": "ORDER_CANCELLED" }, "description": { "type": "string", "example": "Weekly marketplace earnings" }, "merchant_reference": { "type": "string", "example": "TRANSFER-2026-02-15-001" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "provider_data": { "$ref": "#/components/schemas/ProviderData" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-02-16T10:30:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-02-16T10:30:15Z" }, "completed_at": { "type": "string", "format": "date-time", "example": "2026-02-16T10:30:15Z" }, "provider": { "type": [ "string", "null" ], "example": null }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "9eee65d1-6c3a-4076-9ef9-fa4bff73d597" }, "type": { "type": "string", "example": "SPLIT_TRANSFER" }, "status": { "type": "string", "example": "ERROR" }, "provider_transfer_id": { "type": "string", "example": "tr_1T9PTLIiMnPsFcbbFKyh1Nds" }, "provider_response_message": { "type": "string", "example": "..." }, "provider_raw_response": { "type": "string", "example": "{.... }" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-03-10T13:39:19.342902Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-03-10T13:39:19.342914Z" } } } } } }, "WalletDetails": { "type": "object", "properties": { "payment_processing_key": { "type": "string" }, "payment_processing_certificate": { "type": "string" }, "merchant_identity_key": { "type": "string" }, "merchant_identity_certificate": { "type": "string" }, "merchant_identity_password": { "type": "string" } } }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the webhook.", "example": "12345" }, "account_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the account the webhook belongs to.", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "description": "Your name for the webhook.", "example": "Production payments listener" }, "state": { "type": "string", "description": "`ACTIVE` webhooks receive notifications, `INACTIVE` ones do not. A webhook starts out `ACTIVE`.", "enum": [ "ACTIVE", "INACTIVE" ], "example": "ACTIVE" }, "url": { "type": "string", "description": "The endpoint Yuno sends the notifications to.", "example": "https://api.acme.com/yuno/webhooks" }, "api_key": { "type": [ "string", "null" ], "description": "Masked as `***`, or `null` when you have not configured it.", "example": "***" }, "secret": { "type": [ "string", "null" ], "description": "Masked as `***`, or `null` when you have not configured it.", "example": "***" }, "hmac_client_secret": { "type": [ "string", "null" ], "description": "Masked as `***`, or `null` when you have not configured it.", "example": "***" }, "oauth2_authentication_url": { "type": [ "string", "null" ], "description": "Your token endpoint.", "example": "https://api.acme.com/oauth/token" }, "oauth2_client_secret": { "type": [ "string", "null" ], "description": "Masked as `***`, or `null` when you have not configured it.", "example": "***" }, "oauth2_client_id": { "type": [ "string", "null" ], "description": "The client identifier Yuno authenticates with.", "example": "acme_client_id" }, "oauth2_grant_type": { "type": [ "string", "null" ], "description": "The grant type Yuno requests the token with.", "example": "client_credentials" }, "oauth2_scope": { "type": [ "string", "null" ], "description": "The scope Yuno requests the token with.", "example": "webhooks:write" }, "oauth2_authorization_name": { "type": [ "string", "null" ], "description": "The header Yuno sends the token in.", "example": "Authorization" }, "oauth2_include_client_id": { "type": "boolean", "description": "Whether Yuno also sends the client identifier as a header on the token request.", "example": true }, "enrollment_triggers": { "type": [ "array", "null" ], "description": "The enrollment events the webhook subscribes to.", "items": { "type": "string" }, "example": [ "ENROLL", "UNENROLL" ] }, "payment_triggers": { "type": [ "array", "null" ], "description": "The payment events the webhook subscribes to.", "items": { "type": "string" }, "example": [ "AUTHORIZE", "CAPTURE", "REFUND" ] }, "report_triggers": { "type": [ "array", "null" ], "description": "The report events the webhook subscribes to.", "items": { "type": "string" }, "example": [ "UPDATE" ] }, "subscription_triggers": { "type": [ "array", "null" ], "description": "The subscription events the webhook subscribes to.", "items": { "type": "string" }, "example": [ "CREATE", "CLOSE_TO_RENEWAL" ] }, "onboarding_triggers": { "type": [ "array", "null" ], "description": "The onboarding events the webhook subscribes to.", "items": { "type": "string" }, "example": [ "CREATED", "SUCCEEDED" ] }, "renewal_days": { "type": [ "integer", "null" ], "description": "How many days before a renewal Yuno sends the `CLOSE_TO_RENEWAL` notification.", "example": 5 }, "created_at": { "type": "string", "description": "The date and time the webhook was created, in ISO 8601.", "example": "2026-07-09T13:05:36.482913Z", "format": "date-time" }, "updated_at": { "type": "string", "description": "The date and time the webhook was last updated, in ISO 8601. It matches `created_at` until you update the webhook for the first time.", "example": "2026-07-11T16:20:44.918330Z", "format": "date-time" } } }, "WebhookAuthError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "NOT_AUTHENTICATED", "INVALID_CREDENTIALS" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } }, "WebhookConflictError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "WEBHOOK_ALREADY_EXISTS" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } }, "WebhookCreateInput": { "type": "object", "required": [ "account_id", "name", "url" ], "properties": { "account_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the account the webhook belongs to.", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "description": "Your name for the webhook. It must be unique within the account.", "example": "Production payments listener" }, "url": { "type": "string", "description": "The endpoint Yuno sends the notifications to. It must be an `http` or `https` URL that resolves to a public, routable address.", "example": "https://api.acme.com/yuno/webhooks" }, "api_key": { "type": "string", "description": "Sent to your endpoint as the `x-api-key` header on every delivery.", "example": "my-webhook-key" }, "secret": { "type": "string", "description": "Sent to your endpoint as the `x-secret` header on every delivery.", "example": "my-webhook-secret" }, "hmac_client_secret": { "type": "string", "description": "The key Yuno signs the payload with. The signature travels in the `x-hmac-signature` header.", "example": "my-hmac-secret" }, "oauth2_authentication_url": { "type": "string", "description": "Your token endpoint. It must use HTTPS. Send `oauth2_authentication_url`, `oauth2_client_id`, `oauth2_client_secret` and `oauth2_grant_type` together.", "example": "https://api.acme.com/oauth/token" }, "oauth2_client_id": { "type": "string", "description": "The client identifier Yuno authenticates with. Send `oauth2_authentication_url`, `oauth2_client_id`, `oauth2_client_secret` and `oauth2_grant_type` together.", "example": "acme_client_id" }, "oauth2_client_secret": { "type": "string", "description": "The client secret Yuno authenticates with. Send `oauth2_authentication_url`, `oauth2_client_id`, `oauth2_client_secret` and `oauth2_grant_type` together.", "example": "acme_client_secret" }, "oauth2_grant_type": { "type": "string", "description": "The grant type Yuno requests the token with. Send `oauth2_authentication_url`, `oauth2_client_id`, `oauth2_client_secret` and `oauth2_grant_type` together.", "example": "client_credentials" }, "oauth2_authorization_name": { "type": "string", "description": "The header Yuno sends the token in. Defaults to `Authorization`.", "example": "Authorization" }, "oauth2_include_client_id": { "type": "boolean", "description": "Send the client identifier as a header on the token request as well.", "example": false }, "enrollment_triggers": { "type": "array", "description": "The enrollment events the webhook subscribes to.", "items": { "type": "string", "enum": [ "ENROLL", "UNENROLL" ] }, "example": [ "ENROLL", "UNENROLL" ] }, "payment_triggers": { "type": "array", "description": "The payment events the webhook subscribes to.", "items": { "type": "string", "enum": [ "AUTHORIZE", "CANCEL", "CAPTURE", "CHARGEBACK", "PRECHARGEBACK", "PURCHASE", "REFUND", "VERIFY" ] }, "example": [ "AUTHORIZE", "CAPTURE", "REFUND" ] }, "report_triggers": { "type": "array", "description": "The report events the webhook subscribes to.", "items": { "type": "string", "enum": [ "CREATE", "UPDATE" ] }, "example": [ "UPDATE" ] }, "subscription_triggers": { "type": "array", "description": "The subscription events the webhook subscribes to.", "items": { "type": "string", "enum": [ "ACTIVE", "CANCEL", "CLOSE_TO_RENEWAL", "COMPLETE", "CREATE", "PAUSE", "RESUME" ] }, "example": [ "CREATE", "CLOSE_TO_RENEWAL" ] }, "onboarding_triggers": { "type": "array", "description": "The onboarding events the webhook subscribes to.", "items": { "type": "string", "enum": [ "BLOCKED", "CANCELLED", "CREATED", "DECLINED", "ERROR", "EXPIRED", "INACTIVE", "PENDING", "SUCCEEDED", "TRANSFERRED", "UNBLOCKED" ] }, "example": [ "CREATED", "SUCCEEDED" ] }, "renewal_days": { "type": "integer", "description": "How many days before a renewal Yuno sends the `CLOSE_TO_RENEWAL` notification. It must be 1 or more, and it is valid only when `subscription_triggers` contains `CLOSE_TO_RENEWAL`.", "example": 5 } } }, "WebhookNotFoundError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "WEBHOOK_NOT_FOUND" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } }, "WebhookRequestError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "WEBHOOK_INVALID_REQUEST", "INVALID_ACCOUNT_ID" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } }, "WebhookUpdateInput": { "type": "object", "required": [ "account_id" ], "properties": { "account_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the account the webhook belongs to.", "example": "493e9374-510a-4201-9e09-de669d75f256" }, "name": { "type": "string", "description": "Your name for the webhook. It must be unique within the account.", "example": "Production payments listener" }, "state": { "type": "string", "description": "Set it to `INACTIVE` to stop the deliveries while keeping the configuration, and back to `ACTIVE` to resume them.", "enum": [ "ACTIVE", "INACTIVE" ], "example": "INACTIVE" }, "url": { "type": "string", "description": "The endpoint Yuno sends the notifications to. It must be an `http` or `https` URL that resolves to a public, routable address.", "example": "https://api.acme.com/yuno/webhooks" }, "api_key": { "type": "string", "description": "Replaces the `x-api-key` Yuno sends on every delivery.", "example": "my-webhook-key-v2" }, "secret": { "type": "string", "description": "Replaces the `x-secret` Yuno sends on every delivery.", "example": "my-rotated-secret" }, "hmac_client_secret": { "type": "string", "description": "Replaces the key Yuno signs the payload with.", "example": "my-rotated-hmac-secret" }, "oauth2_authentication_url": { "type": "string", "description": "Your token endpoint. It must use HTTPS. Send `oauth2_authentication_url`, `oauth2_client_id`, `oauth2_client_secret` and `oauth2_grant_type` together.", "example": "https://api.acme.com/oauth/token" }, "oauth2_client_id": { "type": "string", "description": "The client identifier Yuno authenticates with. Send `oauth2_authentication_url`, `oauth2_client_id`, `oauth2_client_secret` and `oauth2_grant_type` together.", "example": "acme_client_id" }, "oauth2_client_secret": { "type": "string", "description": "The client secret Yuno authenticates with. Send `oauth2_authentication_url`, `oauth2_client_id`, `oauth2_client_secret` and `oauth2_grant_type` together.", "example": "acme_client_secret" }, "oauth2_grant_type": { "type": "string", "description": "The grant type Yuno requests the token with. Send `oauth2_authentication_url`, `oauth2_client_id`, `oauth2_client_secret` and `oauth2_grant_type` together.", "example": "client_credentials" }, "oauth2_scope": { "type": "string", "description": "The scope Yuno requests the token with.", "example": "webhooks:write" }, "oauth2_authorization_name": { "type": "string", "description": "The header Yuno sends the token in. Defaults to `Authorization`.", "example": "Authorization" }, "oauth2_include_client_id": { "type": "boolean", "description": "Send the client identifier as a header on the token request as well.", "example": true }, "enrollment_triggers": { "type": "array", "description": "Replaces the enrollment events the webhook subscribes to.", "items": { "type": "string", "enum": [ "ENROLL", "UNENROLL" ] }, "example": [ "ENROLL" ] }, "payment_triggers": { "type": "array", "description": "Replaces the payment events the webhook subscribes to.", "items": { "type": "string", "enum": [ "AUTHORIZE", "CANCEL", "CAPTURE", "CHARGEBACK", "PRECHARGEBACK", "PURCHASE", "REFUND", "VERIFY" ] }, "example": [ "AUTHORIZE", "CAPTURE", "REFUND" ] }, "report_triggers": { "type": "array", "description": "Replaces the report events the webhook subscribes to.", "items": { "type": "string", "enum": [ "CREATE", "UPDATE" ] }, "example": [ "UPDATE" ] }, "subscription_triggers": { "type": "array", "description": "Replaces the subscription events the webhook subscribes to.", "items": { "type": "string", "enum": [ "ACTIVE", "CANCEL", "CLOSE_TO_RENEWAL", "COMPLETE", "CREATE", "PAUSE", "RESUME" ] }, "example": [ "CREATE", "CANCEL" ] }, "onboarding_triggers": { "type": "array", "description": "Replaces the onboarding events the webhook subscribes to.", "items": { "type": "string", "enum": [ "BLOCKED", "CANCELLED", "CREATED", "DECLINED", "ERROR", "EXPIRED", "INACTIVE", "PENDING", "SUCCEEDED", "TRANSFERRED", "UNBLOCKED" ] }, "example": [ "CREATED", "SUCCEEDED" ] }, "renewal_days": { "type": "integer", "description": "How many days before a renewal Yuno sends the `CLOSE_TO_RENEWAL` notification. It must be 1 or more. Send it on its own, not together with `clear_renewal_days`.", "example": 5 }, "clear_renewal_days": { "type": "boolean", "description": "Set it to `true` to remove `renewal_days`. Send it on its own, not together with `renewal_days`.", "example": true } } }, "WebhookUpstreamError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "WEBHOOK_UPSTREAM_ERROR" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } }, "WebhookWriteRequestError": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code.", "enum": [ "WEBHOOK_INVALID_REQUEST", "INVALID_ACCOUNT_ID", "WEBHOOK_INVALID_TRIGGER", "WEBHOOK_INVALID_OAUTH2", "WEBHOOK_INVALID_RENEWAL_DAYS", "WEBHOOK_URL_UNSAFE" ] }, "messages": { "type": "array", "description": "Human-readable description of the error.", "items": { "type": "string" } } } } }, "responses": { "BadRequest": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "Conflict": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "DestinationNotFound": { "description": "No destination with that `id` is registered for your scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationError" }, "examples": { "Not found": { "value": { "code": "NOT_FOUND", "messages": [ "destination not found" ] } } } } } }, "InvalidAccountRequest": { "description": "The `account_id` is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequestError" }, "examples": { "Missing account_id": { "value": { "code": "WEBHOOK_INVALID_REQUEST", "messages": [ "account_id is required." ] } }, "Invalid account_id": { "value": { "code": "INVALID_ACCOUNT_ID", "messages": [ "Account id is invalid" ] } } } } } }, "InvalidCreateRequest": { "description": "The request is invalid. The `code` tells you which rule it broke.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookWriteRequestError" }, "examples": { "Missing required field": { "value": { "code": "WEBHOOK_INVALID_REQUEST", "messages": [ "account_id, name and url are required." ] } }, "No triggers": { "value": { "code": "WEBHOOK_INVALID_REQUEST", "messages": [ "at least one trigger is required." ] } }, "Invalid trigger": { "value": { "code": "WEBHOOK_INVALID_TRIGGER", "messages": [ "One or more webhook triggers are invalid." ] } }, "Incomplete OAuth2": { "value": { "code": "WEBHOOK_INVALID_OAUTH2", "messages": [ "OAuth2 configuration is incomplete or inconsistent." ] } }, "Invalid renewal_days": { "value": { "code": "WEBHOOK_INVALID_RENEWAL_DAYS", "messages": [ "renewal_days is only valid when subscription_triggers contains CLOSE_TO_RENEWAL" ] } }, "Invalid account_id": { "value": { "code": "INVALID_ACCOUNT_ID", "messages": [ "Account id is invalid" ] } }, "Unsafe url": { "value": { "code": "WEBHOOK_URL_UNSAFE", "messages": [ "The webhook url is not allowed; it must resolve to a public, routable address." ] } } } } } }, "InvalidId": { "description": "The `id` path parameter is not a valid UUID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationError" }, "examples": { "Invalid id": { "value": { "code": "INVALID_REQUEST", "messages": [ "invalid id" ] } } } } } }, "InvalidListRequest": { "description": "The `account_id` is missing or invalid, or `state` is not `ACTIVE` or `INACTIVE`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequestError" }, "examples": { "Missing account_id": { "value": { "code": "WEBHOOK_INVALID_REQUEST", "messages": [ "account_id is required." ] } }, "Invalid state": { "value": { "code": "WEBHOOK_INVALID_REQUEST", "messages": [ "state must be ACTIVE or INACTIVE." ] } }, "Invalid account_id": { "value": { "code": "INVALID_ACCOUNT_ID", "messages": [ "Account id is invalid" ] } } } } } }, "InvalidUpdateRequest": { "description": "The request is invalid. The `code` tells you which rule it broke.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookWriteRequestError" }, "examples": { "Missing account_id": { "value": { "code": "WEBHOOK_INVALID_REQUEST", "messages": [ "account_id is required." ] } }, "Invalid state": { "value": { "code": "WEBHOOK_INVALID_REQUEST", "messages": [ "state must be ACTIVE or INACTIVE." ] } }, "Conflicting renewal fields": { "value": { "code": "WEBHOOK_INVALID_REQUEST", "messages": [ "renewal_days and clear_renewal_days cannot be set together." ] } }, "Invalid trigger": { "value": { "code": "WEBHOOK_INVALID_TRIGGER", "messages": [ "One or more webhook triggers are invalid." ] } }, "Incomplete OAuth2": { "value": { "code": "WEBHOOK_INVALID_OAUTH2", "messages": [ "OAuth2 configuration is incomplete or inconsistent." ] } }, "Invalid renewal_days": { "value": { "code": "WEBHOOK_INVALID_RENEWAL_DAYS", "messages": [ "renewal_days is only valid when subscription_triggers contains CLOSE_TO_RENEWAL" ] } }, "Invalid account_id": { "value": { "code": "INVALID_ACCOUNT_ID", "messages": [ "Account id is invalid" ] } }, "Unsafe url": { "value": { "code": "WEBHOOK_URL_UNSAFE", "messages": [ "The webhook url is not allowed; it must resolve to a public, routable address." ] } } } } } }, "NotFound": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "Unauthorized": { "description": "Authentication failed. Missing or invalid API credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationError" }, "examples": { "Not authenticated": { "value": { "code": "NOT_AUTHENTICATED", "messages": [ "not authenticated" ] } } } } } }, "Unauthorized_2": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "Unauthorized_3": { "description": "Your API credentials are missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookAuthError" }, "examples": { "Not authenticated": { "value": { "code": "NOT_AUTHENTICATED", "messages": [ "Not authenticated" ] } }, "Invalid credentials": { "value": { "code": "INVALID_CREDENTIALS", "messages": [ "Invalid Credentials" ] } } } } } }, "UpstreamError": { "description": "The webhook service is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpstreamError" }, "examples": { "Service unavailable": { "value": { "code": "WEBHOOK_UPSTREAM_ERROR", "messages": [ "The webhook service is temporarily unavailable." ] } } } } } }, "WebhookConflict": { "description": "The account already has a webhook with that name, or one with the same URL that listens to one of the same events.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConflictError" }, "examples": { "Already exists": { "value": { "code": "WEBHOOK_ALREADY_EXISTS", "messages": [ "A webhook with the same name, or url and trigger(s), already exists for this account." ] } } } } } }, "WebhookNotFound": { "description": "There is no webhook with that identifier on the account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookNotFoundError" }, "examples": { "Not found": { "value": { "code": "WEBHOOK_NOT_FOUND", "messages": [ "The webhook does not exist for this account." ] } } } } } } } }, "webhooks": { "webhook-notifications-banking": { "post": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK (Incoming transfer notification)": { "summary": "OK (Incoming transfer notification)", "value": { "received": true } } } } } } }, "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the transfer (prefixed `xfer_`).", "example": "xfer_cc0e8400-e29b-41d4-a716-446655440000" }, "destination_account_id": { "type": "string", "description": "The `id` of the destination Banking Connectivity account that received the incoming transfer.", "example": "acct_aa0e8400-e29b-41d4-a716-446655440000" }, "account_id": { "type": "string", "description": "The merchant's Yuno account identifier.", "example": "550e8400-e29b-41d4-a716-446655440000" }, "provider": { "type": "object", "description": "Provider-side identifiers.", "properties": { "account_id": { "type": "string", "description": "The provider's internal account identifier.", "example": "col_bank_account_789" }, "transfer_id": { "type": "string", "description": "The provider's internal transfer identifier.", "example": "col_incoming_xyz456" } } }, "status": { "type": "string", "description": "The transfer status.", "enum": [ "PENDING", "COMPLETED" ], "example": "COMPLETED" }, "direction": { "type": "string", "description": "The transfer direction. Incoming transfer webhooks always have `INCOMING`.", "enum": [ "INCOMING" ], "example": "INCOMING" }, "sender": { "type": "object", "description": "Information about the external sender.", "properties": { "account_number_last_4": { "type": "string", "description": "Last 4 digits of the sender's account number.", "example": "5678" }, "routing_number": { "type": "string", "description": "The sender's routing number.", "example": "987654321" }, "account_name": { "type": "string", "description": "The sender's account holder name.", "example": "External Company LLC" }, "bank_name": { "type": "string", "description": "The sender's bank name.", "example": "Bank of America" } } }, "amount": { "type": "object", "description": "The transfer amount.", "properties": { "value": { "type": "number", "description": "The transfer amount.", "example": 2500 }, "currency": { "type": "string", "description": "The currency ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).", "example": "USD" } } }, "payment_rail": { "type": "string", "description": "The payment rail used for the transfer.", "enum": [ "ACH_STANDARD", "ACH_SAME_DAY", "WIRE", "RTP", "FPS", "CHAPS", "BACS", "NPP", "PAYTO", "BPAY" ], "example": "ACH_STANDARD" }, "description": { "type": "string", "description": "The transfer description.", "example": "Payment for services" }, "created_at": { "type": "string", "description": "The timestamp when the transfer was created (ISO 8601).", "example": "2026-02-01T14:30:00Z" }, "updated_at": { "type": "string", "description": "The timestamp when the transfer was last updated (ISO 8601).", "example": "2026-02-01T14:30:00Z" } } }, "examples": { "Incoming transfer notification": { "summary": "Incoming transfer notification", "value": { "id": "xfer_cc0e8400-e29b-41d4-a716-446655440000", "destination_account_id": "acct_aa0e8400-e29b-41d4-a716-446655440000", "account_id": "550e8400-e29b-41d4-a716-446655440000", "provider": { "account_id": "col_bank_account_789", "transfer_id": "col_incoming_xyz456" }, "status": "COMPLETED", "direction": "INCOMING", "sender": { "account_number_last_4": "5678", "routing_number": "987654321", "account_name": "External Company LLC", "bank_name": "Bank of America" }, "amount": { "value": 2500, "currency": "USD" }, "payment_rail": "ACH_STANDARD", "description": "Payment for services", "created_at": "2026-02-01T14:30:00Z", "updated_at": "2026-02-01T14:30:00Z" } } } } } }, "summary": "Webhook Notifications", "tags": [ "Webhooks" ] } } } }