Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Register provider request / response / webhook payloads

Stores the HTTP traffic that the merchant exchanged directly with a payment provider (request, response, and webhook) for correlation to a Yuno payment.

post/dry-run/provider-events

Headers

PUBLIC-API-KEYstring

Public API key. One of PUBLIC-API-KEY / PRIVATE-SECRET-KEY required.

PRIVATE-SECRET-KEYstring

Private secret key for server-to-server calls. One of PUBLIC-API-KEY / PRIVATE-SECRET-KEY required.

X-Idempotency-Keystring

Free-form string (MAX 64). 24-hour replay window.

Request body

merchant_referencestring required

Merchant-assigned identifier (MAX 255; MIN 3). Unique per account.

payment_idstring uuid

Yuno payment UUID. If supplied, resolved immediately.

account_idstring uuid

Yuno account UUID — same shape as account_id in POST /v1/payments.

provider_id'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'

Provider identifier. Allowed values aligned to the Yuno catalog.

payment_method_type'' | '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'

Payment method exercised by this dry-run. Same vocabulary as payment_method.type in POST /v1/payments.

Example request

{
  "merchant_reference": "ORD-12345",
  "payment_id": "fb9e5fa4-684c-4747-9755-9d332617f16f",
  "account_id": "a389f417-ecd1-4355-89f5-7489564f264d",
  "provider_id": "STRIPE",
  "payment_method_type": "CREDIT_CARD",
  "events": [
    {
      "type": "REQUEST",
      "http_method": "POST",
      "operation_type": "PURCHASE",
      "base_url": "https://api.stripe.com",
      "endpoint": "/v1/charges",
      "headers": "eyBDb250ZW50LVR5cGU6IGFwcGxpY2F0aW9uL2pzb24gfQ==",
      "body": "eyBhbW91bnQ6IDIwMDAsIGN1cnJlbmN5OiAidXNkIiB9"
    }
  ]
}

Response

Dry-run registered

idstring required

Public identifier of the dry-run registration (nano_id, 21 chars).

status'REGISTERED' required

Lifecycle state.

merchant_referencestring required
payment_idstring uuid nullable
account_idstring uuid nullable
provider_idstring
payment_method_type'' | '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_typestring

Example response

{
  "id": "drun_1209fnkw428ufwd",
  "status": "REGISTERED",
  "merchant_reference": "ORD-12345",
  "payment_id": "fb9e5fa4-684c-4747-9755-9d332617f16f",
  "account_id": "a389f417-ecd1-4355-89f5-7489564f264d",
  "provider_id": "STRIPE",
  "payment_method_type": "CARD",
  "operation_type": "PURCHASE"
}