Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Create Payment

post/payments

Headers

X-Idempotency-Keystring required

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.

Request body

account_idstring required

The unique identifier of the account. You find this information on the Yuno dashboard (UUID, 36 chars).

merchant_order_idstring required

The unique identifier of the customer's order (MAX 255; MIN 3).

descriptionstring required

The description of the payment (MAX 255; MIN 3).

country'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'CR' | 'EC' | 'SV' | 'GT' | 'HN' | 'MX' | 'NI' | 'PA' | 'PY' | 'PE' | 'US' | 'UY' required

Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1).

merchant_referencestring

Identification of the payment transaction defined by the merchant (MAX 255; MIN 3). Optional to complement the merchant_order_id.

workflow'SDK_CHECKOUT' | 'CHECKOUT' | 'REDIRECT' | 'DIRECT' | 'SDK_SEAMLESS'

The payment workflow. Indicates whether the integration will use Yuno´s SDK or will be a back to back connection. Guides <ul> <li>SDK_CHECKOUT: [Recommended] - Use Yuno's SDK. </li> <li>DIRECT: Back to back integration with provider info for custom payment experience. </li> <li>REDIRECT: Back to back integration with provider redirection. </li> </ul>

callback_urlstring

The URL where to redirect the customer after the payment. Only required for DIRECT integrations that have a redirection (MAX 526; MIN 3).

Example request

{
  "additional_data": {
    "airline": {
      "legs": [
        {
          "passenger_id": "passenger_001"
        }
      ],
      "passengers": [
        {
          "id": "passenger_001"
        }
      ],
      "tickets": [
        {
          "passenger_id": "passenger_001"
        }
      ]
    },
    "transportations": [
      {
        "id": "AAA0001",
        "description": "Bus ticket",
        "type": "ROUNDTRIP",
        "legs": [
          {
            "passenger_id": "passenger_001",
            "order": 2,
            "route_order": 1,
            "departure_country": "CO",
            "departure_city": "Bogota",
            "departure_timezone": "-03:00",
            "departure_datetime": "2022-05-09T20:46:54.786342Z",
            "departure_reference": "AAA001-2",
            "arrival_country": "CO",
            "arrival_city": "Medellin",
            "arrival_timezone": "-03:00",
            "arrival_datetime": "2022-05-09T24:46:54.786342Z",
            "arrival_reference": "AAA001-4",
            "transport": {
              "id": "ASONDAKS-1234"
            }
          }
        ],
        "transport": {
          "id": "ASONDAKS-1234",
          "type": "BUS",
          "description": "BUS 2022"
        },
        "passengers": [
          {
            "id": "passenger_001",
            "first_name": "John",
            "last_name": "Doe",
            "middle_name": "A",
            "email": "john.doe@example.com",
            "type": "A",
            "date_of_birth": "1990-01-01",
            "nationality": "CO",
            "document": {
              "document_number": "123456789",
              "document_type": "CC"
            },
            "loyalty_number": "L123456",
            "loyalty_tier": "GOLD",
            "phone": {
              "country_code": "57",
              "number": "3001234567"
            }
          }
        ],
        "tickets": [
          {
            "passenger_id": "passenger_001",
            "ticket_number": "12345678901234",
            "e_ticket": true,
            "total_fare_amount": 50000,
            "total_tax_amount": 5000,
            "total_fee_amount": 1000
          }
        ]
      }
    ]
  },
  "payment_method": {
    "detail": {
      "card": {
        "delayed_capture_settings": {
          "delay": "P20D"
        },
        "delayed_cancel_settings": {
          "delay": "P20D"
        }
      },
      "wallet": {
        "stored_credentials": {
          "additional_data": {
            "billing_cycles": {
              "current": 1
            },
            "frequency": {
              "type": "MONTH"
            }
          }
        }
      }
    }
  },
  "split_marketplace": [
    {
      "recipient_type": "MEAL"
    }
  ]
}

Response

201

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "id": "6c44ed29-cc51-4479-a5eb-108afdaadd50",
  "account_id": "493e9374-510a-4201-9e09-de669d75f256",
  "description": "Test 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": {
    "currency": "USD",
    "value": 15000
  },
  "checkout": {
    "session": "7fb7093e-dc67-4c7a-80c5-d25cf5e6ff27"
  },
  "payment_method": {
    "vaulted_token": "dcc06b32-43ad-4627-aa75-c631eb50c2ac",
    "type": "CARD",
    "vault_on_success": true,
    "token": "8cabcd5c-1b40-4407-b14a-14ab21741865",
    "payment_method_detail": {
      "card": {
        "capture": true,
        "installments": 1,
        "authorization_code": "835631",
        "card_data": {
          "holder_name": "Fannie Weissnat",
          "iin": "41961111",
          "lfd": "0010",
          "number_length": 16,
          "security_code_length": 1,
          "brand": "VISA",
          "issuer_name": "METABANK",
          "country_code": "US",
          "category": "PREPAID RELOADABLE",
          "type": "DEBIT",
          "fingerprint": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12",
          "expiration_month": 3,
          "expiration_year": 24
        }
      }
    }
  },
  "customer_payer": {
    "id": "94121f98-98f7-4d57-aa5f-228401d35b12",
    "merchant_customer_id": "1744402154",
    "first_name": "John",
    "last_name": "Doe",
    "date_of_birth": "1990-02-28",
    "email": "john.doe2@gmail.com",
    "nationality": "US",
    "ip_address": "192.168.123.167",
    "device_fingerprint": "hi88287gbd8d7d782ge....",
    "browser_info": {
      "user_agent": "string",
      "accept_header": "string",
      "color_depth": "string",
      "screen_height": "string",
      "screen_width": "string",
      "javascript_enabled": true,
      "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",
          "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"
        }
      ],
      "ticket": {
        "ticket_number": "123456",
        "total_fare_amount": 80,
        "total_tax_amount": 22,
        "total_fee_amount": 14
      }
    },
    "order": {
      "fee_amount": 40.5,
      "shipping_amount": 10.35,
      "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"
        }
      ]
    }
  },
  "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",
      "detail": {
        "card": {
          "capture": true,
          "installments": 1,
          "authorization_code": "835631",
          "card_data": {
            "holder_name": "Fannie Weissnat",
            "iin": "41961111",
            "lfd": "0010",
            "number_length": 16,
            "security_code_length": 1,
            "brand": "VISA",
            "issuer_name": "METABANK",
            "country_code": "US",
            "category": "PREPAID RELOADABLE",
            "type": "DEBIT",
            "fingerprint": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12",
            "expiration_month": 3,
            "expiration_year": 24
          }
        }
      }
    },
    "response_code": "SUCCEEDED",
    "response_message": "Transaction successful",
    "description": "Test Payment",
    "merchant_reference": "1744403449",
    "provider_data": {
      "id": "YUNO_TEST_PAYMENT_GW",
      "transaction_id": "04d94195-a6ce-455a-b027-5f237f91a576",
      "status": "SUCCEEDED",
      "raw_response": {
        "amount": {
          "currency": "USD",
          "value": 2100
        },
        "merchantAccount": "YunoPaymentsECOM",
        "reference": "34343434",
        "status": "received"
      }
    },
    "connection_data": {
      "id": "90defca1-c913-4894-965c-ed536b65951a"
    },
    "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",
        "detail": {
          "card": {
            "capture": true,
            "installments": 1,
            "authorization_code": "835631",
            "card_data": {
              "holder_name": "Fannie Weissnat",
              "iin": "41961111",
              "lfd": "0010",
              "number_length": 16,
              "security_code_length": 1,
              "brand": "VISA",
              "issuer_name": "METABANK",
              "country_code": "US",
              "category": "PREPAID RELOADABLE",
              "type": "DEBIT",
              "fingerprint": "5605f3e4-69e7-4a9f-9646-2ac8c2e33e12",
              "expiration_month": 3,
              "expiration_year": 24
            }
          }
        }
      },
      "response_code": "SUCCEEDED",
      "response_message": "Transaction successful",
      "description": "Test Payment",
      "merchant_reference": "1744403449",
      "provider_data": {
        "id": "YUNO_TEST_PAYMENT_GW",
        "transaction_id": "04d94195-a6ce-455a-b027-5f237f91a576",
        "status": "SUCCEEDED",
        "raw_response": {
          "amount": {
            "currency": "USD",
            "value": 2100
          },
          "merchantAccount": "YunoPaymentsECOM",
          "reference": "34343434",
          "status": "received"
        }
      },
      "connection_data": {
        "id": "90defca1-c913-4894-965c-ed536b65951a"
      },
      "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"
    }
  ],
  "routing_rules": {
    "condition": {
      "id": 146526
    }
  }
}